Skip to content

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

# EventBridgeSchedulerClient 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.

# Exceptions.exceptions usage example

client = boto3.client("scheduler")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_scheduler.client import Exceptions

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

Methods#

can_paginate#

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

# can_paginate method definition

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

generate_presigned_url#

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

# generate_presigned_url method definition

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

create_schedule#

Creates the specified schedule.

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

# create_schedule method definition

def create_schedule(
    self,
    *,
    FlexibleTimeWindow: FlexibleTimeWindowTypeDef,  # (1)
    Name: str,
    ScheduleExpression: str,
    Target: TargetTypeDef,  # (2)
    ActionAfterCompletion: ActionAfterCompletionType = ...,  # (3)
    ClientToken: str = ...,
    Description: str = ...,
    EndDate: TimestampTypeDef = ...,
    GroupName: str = ...,
    KmsKeyArn: str = ...,
    ScheduleExpressionTimezone: str = ...,
    StartDate: TimestampTypeDef = ...,
    State: ScheduleStateType = ...,  # (4)
) -> CreateScheduleOutputTypeDef:  # (5)
    ...
  1. See FlexibleTimeWindowTypeDef
  2. See TargetTypeDef
  3. See ActionAfterCompletionType
  4. See ScheduleStateType
  5. See CreateScheduleOutputTypeDef 
# create_schedule method usage example with argument unpacking

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

# create_schedule_group method definition

def create_schedule_group(
    self,
    *,
    Name: str,
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateScheduleGroupOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateScheduleGroupOutputTypeDef 
# create_schedule_group method usage example with argument unpacking

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

# delete_schedule method definition

def delete_schedule(
    self,
    *,
    Name: str,
    ClientToken: str = ...,
    GroupName: str = ...,
) -> dict[str, Any]:
    ...
# delete_schedule method usage example with argument unpacking

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

# delete_schedule_group method definition

def delete_schedule_group(
    self,
    *,
    Name: str,
    ClientToken: str = ...,
) -> dict[str, Any]:
    ...
# delete_schedule_group method usage example with argument unpacking

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

parent.delete_schedule_group(**kwargs)
  1. See DeleteScheduleGroupInputRequestTypeDef

get_schedule#

Retrieves the specified schedule.

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

# get_schedule method definition

def get_schedule(
    self,
    *,
    Name: str,
    GroupName: str = ...,
) -> GetScheduleOutputTypeDef:  # (1)
    ...
  1. See GetScheduleOutputTypeDef 
# get_schedule method usage example with argument unpacking

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

# get_schedule_group method definition

def get_schedule_group(
    self,
    *,
    Name: str,
) -> GetScheduleGroupOutputTypeDef:  # (1)
    ...
  1. See GetScheduleGroupOutputTypeDef 
# get_schedule_group method usage example with argument unpacking

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

# list_schedule_groups method definition

def list_schedule_groups(
    self,
    *,
    MaxResults: int = ...,
    NamePrefix: str = ...,
    NextToken: str = ...,
) -> ListScheduleGroupsOutputTypeDef:  # (1)
    ...
  1. See ListScheduleGroupsOutputTypeDef 
# list_schedule_groups method usage example with argument unpacking

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

# list_schedules 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 
# list_schedules method usage example with argument unpacking

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef 
# list_tags_for_resource method usage example with argument unpacking

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> dict[str, Any]:
    ...
  1. See TagTypeDef 
# tag_resource method usage example with argument unpacking

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

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

# update_schedule method definition

def update_schedule(
    self,
    *,
    FlexibleTimeWindow: FlexibleTimeWindowTypeDef,  # (1)
    Name: str,
    ScheduleExpression: str,
    Target: TargetTypeDef,  # (2)
    ActionAfterCompletion: ActionAfterCompletionType = ...,  # (3)
    ClientToken: str = ...,
    Description: str = ...,
    EndDate: TimestampTypeDef = ...,
    GroupName: str = ...,
    KmsKeyArn: str = ...,
    ScheduleExpressionTimezone: str = ...,
    StartDate: TimestampTypeDef = ...,
    State: ScheduleStateType = ...,  # (4)
) -> UpdateScheduleOutputTypeDef:  # (5)
    ...
  1. See FlexibleTimeWindowTypeDef
  2. See TargetTypeDef
  3. See ActionAfterCompletionType
  4. See ScheduleStateType
  5. See UpdateScheduleOutputTypeDef 
# update_schedule method usage example with argument unpacking

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.