EventBridgeSchedulerClient

Index > EventBridgeScheduler > EventBridgeSchedulerClient

Auto-generated documentation for EventBridgeScheduler type annotations stubs module mypy-boto3-scheduler.

EventBridgeSchedulerClient

Type annotations and code completion for boto3.client("scheduler"). boto3 documentation

Usage example

from boto3.session import Session
from mypy_boto3_scheduler.client import EventBridgeSchedulerClient

def get_scheduler_client() -> EventBridgeSchedulerClient:
    return Session().client("scheduler")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("scheduler").exceptions structure.

Usage example

client = boto3.client("scheduler")

try:
    do_something(client)
except (
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)

Type checking example

from mypy_boto3_scheduler.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("scheduler").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("scheduler").close method. boto3 documentation

Method definition

def close(
    self,
) -> None:
    ...

create_schedule

Creates the specified schedule.

Type annotations and code completion for boto3.client("scheduler").create_schedule method. boto3 documentation

Method definition

def create_schedule(
    self,
    *,
    FlexibleTimeWindow: FlexibleTimeWindowTypeDef,  # (1)
    Name: str,
    ScheduleExpression: str,
    Target: TargetTypeDef,  # (2)
    ClientToken: str = ...,
    Description: str = ...,
    EndDate: Union[datetime, str] = ...,
    GroupName: str = ...,
    KmsKeyArn: str = ...,
    ScheduleExpressionTimezone: str = ...,
    StartDate: Union[datetime, str] = ...,
    State: ScheduleStateType = ...,  # (3)
) -> CreateScheduleOutputTypeDef:  # (4)
    ...

1. See FlexibleTimeWindowTypeDef
2. See TargetTypeDef
3. See ScheduleStateType
4. See CreateScheduleOutputTypeDef

Usage example with kwargs

kwargs: CreateScheduleInputRequestTypeDef = {  # (1)
    "FlexibleTimeWindow": ...,
    "Name": ...,
    "ScheduleExpression": ...,
    "Target": ...,
}

parent.create_schedule(**kwargs)

1. See CreateScheduleInputRequestTypeDef

create_schedule_group

Creates the specified schedule group.

Type annotations and code completion for boto3.client("scheduler").create_schedule_group method. boto3 documentation

Method definition

def create_schedule_group(
    self,
    *,
    Name: str,
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateScheduleGroupOutputTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateScheduleGroupOutputTypeDef

Usage example with kwargs

kwargs: CreateScheduleGroupInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_schedule_group(**kwargs)

1. See CreateScheduleGroupInputRequestTypeDef

delete_schedule

Deletes the specified schedule.

Type annotations and code completion for boto3.client("scheduler").delete_schedule method. boto3 documentation

Method definition

def delete_schedule(
    self,
    *,
    Name: str,
    ClientToken: str = ...,
    GroupName: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteScheduleInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_schedule(**kwargs)

1. See DeleteScheduleInputRequestTypeDef

delete_schedule_group

Deletes the specified schedule group.

Type annotations and code completion for boto3.client("scheduler").delete_schedule_group method. boto3 documentation

Method definition

def delete_schedule_group(
    self,
    *,
    Name: str,
    ClientToken: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteScheduleGroupInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_schedule_group(**kwargs)

1. See DeleteScheduleGroupInputRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("scheduler").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_schedule

Retrieves the specified schedule.

Type annotations and code completion for boto3.client("scheduler").get_schedule method. boto3 documentation

Method definition

def get_schedule(
    self,
    *,
    Name: str,
    GroupName: str = ...,
) -> GetScheduleOutputTypeDef:  # (1)
    ...

1. See GetScheduleOutputTypeDef

Usage example with kwargs

kwargs: GetScheduleInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_schedule(**kwargs)

1. See GetScheduleInputRequestTypeDef

get_schedule_group

Retrieves the specified schedule group.

Type annotations and code completion for boto3.client("scheduler").get_schedule_group method. boto3 documentation

Method definition

def get_schedule_group(
    self,
    *,
    Name: str,
) -> GetScheduleGroupOutputTypeDef:  # (1)
    ...

1. See GetScheduleGroupOutputTypeDef

Usage example with kwargs

kwargs: GetScheduleGroupInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_schedule_group(**kwargs)

1. See GetScheduleGroupInputRequestTypeDef

list_schedule_groups

Returns a paginated list of your schedule groups.

Type annotations and code completion for boto3.client("scheduler").list_schedule_groups method. boto3 documentation

Method definition

def list_schedule_groups(
    self,
    *,
    MaxResults: int = ...,
    NamePrefix: str = ...,
    NextToken: str = ...,
) -> ListScheduleGroupsOutputTypeDef:  # (1)
    ...

1. See ListScheduleGroupsOutputTypeDef

Usage example with kwargs

kwargs: ListScheduleGroupsInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_schedule_groups(**kwargs)

1. See ListScheduleGroupsInputRequestTypeDef

list_schedules

Returns a paginated list of your EventBridge Scheduler schedules.

Type annotations and code completion for boto3.client("scheduler").list_schedules method. boto3 documentation

Method definition

def list_schedules(
    self,
    *,
    GroupName: str = ...,
    MaxResults: int = ...,
    NamePrefix: str = ...,
    NextToken: str = ...,
    State: ScheduleStateType = ...,  # (1)
) -> ListSchedulesOutputTypeDef:  # (2)
    ...

1. See ScheduleStateType
2. See ListSchedulesOutputTypeDef

Usage example with kwargs

kwargs: ListSchedulesInputRequestTypeDef = {  # (1)
    "GroupName": ...,
}

parent.list_schedules(**kwargs)

1. See ListSchedulesInputRequestTypeDef

list_tags_for_resource

Lists the tags associated with the Scheduler resource.

Type annotations and code completion for boto3.client("scheduler").list_tags_for_resource method. boto3 documentation

Method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...

1. See ListTagsForResourceOutputTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputRequestTypeDef

tag_resource

Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource.

Type annotations and code completion for boto3.client("scheduler").tag_resource method. boto3 documentation

Method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

Usage example with kwargs

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceInputRequestTypeDef

untag_resource

Removes one or more tags from the specified EventBridge Scheduler schedule group.

Type annotations and code completion for boto3.client("scheduler").untag_resource method. boto3 documentation

Method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceInputRequestTypeDef

update_schedule

Updates the specified schedule.

Type annotations and code completion for boto3.client("scheduler").update_schedule method. boto3 documentation

Method definition

def update_schedule(
    self,
    *,
    FlexibleTimeWindow: FlexibleTimeWindowTypeDef,  # (1)
    Name: str,
    ScheduleExpression: str,
    Target: TargetTypeDef,  # (2)
    ClientToken: str = ...,
    Description: str = ...,
    EndDate: Union[datetime, str] = ...,
    GroupName: str = ...,
    KmsKeyArn: str = ...,
    ScheduleExpressionTimezone: str = ...,
    StartDate: Union[datetime, str] = ...,
    State: ScheduleStateType = ...,  # (3)
) -> UpdateScheduleOutputTypeDef:  # (4)
    ...

1. See FlexibleTimeWindowTypeDef
2. See TargetTypeDef
3. See ScheduleStateType
4. See UpdateScheduleOutputTypeDef

Usage example with kwargs

kwargs: UpdateScheduleInputRequestTypeDef = {  # (1)
    "FlexibleTimeWindow": ...,
    "Name": ...,
    "ScheduleExpression": ...,
    "Target": ...,
}

parent.update_schedule(**kwargs)

1. See UpdateScheduleInputRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("scheduler").get_paginator method with overloads.

• client.get_paginator("list_schedule_groups") -> ListScheduleGroupsPaginator
• client.get_paginator("list_schedules") -> ListSchedulesPaginator