EventBridgeSchedulerClient#
Index > EventBridgeScheduler > EventBridgeSchedulerClient
Auto-generated documentation for EventBridgeScheduler type annotations stubs module types-aiobotocore-scheduler.
EventBridgeSchedulerClient#
Type annotations and code completion for session.create_client("scheduler")
boto3 documentation
EventBridgeSchedulerClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_scheduler.client import EventBridgeSchedulerClient
session = get_session()
async with session.create_client("scheduler") as client:
client: EventBridgeSchedulerClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("scheduler").exceptions
structure.
EventBridgeSchedulerClient.exceptions usage example
async with session.create_client("scheduler") as client:
try:
do_something(client)
except (
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
EventBridgeSchedulerClient usage type checking example
from types_aiobotocore_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 session.create_client("scheduler").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.create_client("scheduler").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_schedule#
Creates the specified schedule.
Type annotations and code completion for session.create_client("scheduler").create_schedule
method.
boto3 documentation
# create_schedule method definition
await def create_schedule(
self,
*,
FlexibleTimeWindow: FlexibleTimeWindowTypeDef, # (1)
Name: str,
ScheduleExpression: str,
Target: TargetTypeDef, # (2)
ActionAfterCompletion: ActionAfterCompletionType = ..., # (3)
ClientToken: str = ...,
Description: str = ...,
EndDate: Union[datetime, str] = ...,
GroupName: str = ...,
KmsKeyArn: str = ...,
ScheduleExpressionTimezone: str = ...,
StartDate: Union[datetime, str] = ...,
State: ScheduleStateType = ..., # (4)
) -> CreateScheduleOutputTypeDef: # (5)
...
- See FlexibleTimeWindowTypeDef
- See TargetTypeDef
- See ActionAfterCompletionType
- See ScheduleStateType
- See CreateScheduleOutputTypeDef
# create_schedule method usage example with argument unpacking
kwargs: CreateScheduleInputRequestTypeDef = { # (1)
"FlexibleTimeWindow": ...,
"Name": ...,
"ScheduleExpression": ...,
"Target": ...,
}
parent.create_schedule(**kwargs)
create_schedule_group#
Creates the specified schedule group.
Type annotations and code completion for session.create_client("scheduler").create_schedule_group
method.
boto3 documentation
# create_schedule_group method definition
await def create_schedule_group(
self,
*,
Name: str,
ClientToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateScheduleGroupOutputTypeDef: # (2)
...
# create_schedule_group method usage example with argument unpacking
kwargs: CreateScheduleGroupInputRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_schedule_group(**kwargs)
delete_schedule#
Deletes the specified schedule.
Type annotations and code completion for session.create_client("scheduler").delete_schedule
method.
boto3 documentation
# delete_schedule method definition
await 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)
delete_schedule_group#
Deletes the specified schedule group.
Type annotations and code completion for session.create_client("scheduler").delete_schedule_group
method.
boto3 documentation
# delete_schedule_group method definition
await 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)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("scheduler").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("scheduler").get_schedule
method.
boto3 documentation
# get_schedule method definition
await def get_schedule(
self,
*,
Name: str,
GroupName: str = ...,
) -> GetScheduleOutputTypeDef: # (1)
...
# get_schedule method usage example with argument unpacking
kwargs: GetScheduleInputRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_schedule(**kwargs)
get_schedule_group#
Retrieves the specified schedule group.
Type annotations and code completion for session.create_client("scheduler").get_schedule_group
method.
boto3 documentation
# get_schedule_group method definition
await def get_schedule_group(
self,
*,
Name: str,
) -> GetScheduleGroupOutputTypeDef: # (1)
...
# get_schedule_group method usage example with argument unpacking
kwargs: GetScheduleGroupInputRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_schedule_group(**kwargs)
list_schedule_groups#
Returns a paginated list of your schedule groups.
Type annotations and code completion for session.create_client("scheduler").list_schedule_groups
method.
boto3 documentation
# list_schedule_groups method definition
await def list_schedule_groups(
self,
*,
MaxResults: int = ...,
NamePrefix: str = ...,
NextToken: str = ...,
) -> ListScheduleGroupsOutputTypeDef: # (1)
...
# list_schedule_groups method usage example with argument unpacking
kwargs: ListScheduleGroupsInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_schedule_groups(**kwargs)
list_schedules#
Returns a paginated list of your EventBridge Scheduler schedules.
Type annotations and code completion for session.create_client("scheduler").list_schedules
method.
boto3 documentation
# list_schedules method definition
await def list_schedules(
self,
*,
GroupName: str = ...,
MaxResults: int = ...,
NamePrefix: str = ...,
NextToken: str = ...,
State: ScheduleStateType = ..., # (1)
) -> ListSchedulesOutputTypeDef: # (2)
...
# list_schedules method usage example with argument unpacking
kwargs: ListSchedulesInputRequestTypeDef = { # (1)
"GroupName": ...,
}
parent.list_schedules(**kwargs)
list_tags_for_resource#
Lists the tags associated with the Scheduler resource.
Type annotations and code completion for session.create_client("scheduler").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
tag_resource#
Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource.
Type annotations and code completion for session.create_client("scheduler").tag_resource
method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes one or more tags from the specified EventBridge Scheduler schedule group.
Type annotations and code completion for session.create_client("scheduler").untag_resource
method.
boto3 documentation
# untag_resource method definition
await 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)
update_schedule#
Updates the specified schedule.
Type annotations and code completion for session.create_client("scheduler").update_schedule
method.
boto3 documentation
# update_schedule method definition
await def update_schedule(
self,
*,
FlexibleTimeWindow: FlexibleTimeWindowTypeDef, # (1)
Name: str,
ScheduleExpression: str,
Target: TargetTypeDef, # (2)
ActionAfterCompletion: ActionAfterCompletionType = ..., # (3)
ClientToken: str = ...,
Description: str = ...,
EndDate: Union[datetime, str] = ...,
GroupName: str = ...,
KmsKeyArn: str = ...,
ScheduleExpressionTimezone: str = ...,
StartDate: Union[datetime, str] = ...,
State: ScheduleStateType = ..., # (4)
) -> UpdateScheduleOutputTypeDef: # (5)
...
- See FlexibleTimeWindowTypeDef
- See TargetTypeDef
- See ActionAfterCompletionType
- See ScheduleStateType
- See UpdateScheduleOutputTypeDef
# update_schedule method usage example with argument unpacking
kwargs: UpdateScheduleInputRequestTypeDef = { # (1)
"FlexibleTimeWindow": ...,
"Name": ...,
"ScheduleExpression": ...,
"Target": ...,
}
parent.update_schedule(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("scheduler").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> EventBridgeSchedulerClient:
...
__aexit__#
Type annotations and code completion for session.create_client("scheduler").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.create_client("scheduler").get_paginator
method with overloads.
client.get_paginator("list_schedule_groups")
-> ListScheduleGroupsPaginatorclient.get_paginator("list_schedules")
-> ListSchedulesPaginator