Skip to content

Type definitions#

Index > EventBridgeScheduler > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

TargetUnionTypeDef#

# TargetUnionTypeDef definition

TargetUnionTypeDef = Union[
    TargetTypeDef,  # (1)
    TargetOutputTypeDef,  # (2)
]
  1. See TargetTypeDef
  2. See TargetOutputTypeDef

AwsVpcConfigurationOutputTypeDef#

# AwsVpcConfigurationOutputTypeDef definition

class AwsVpcConfigurationOutputTypeDef(TypedDict):
    Subnets: List[str],
    AssignPublicIp: NotRequired[AssignPublicIpType],  # (1)
    SecurityGroups: NotRequired[List[str]],
  1. See AssignPublicIpType

AwsVpcConfigurationTypeDef#

# AwsVpcConfigurationTypeDef definition

class AwsVpcConfigurationTypeDef(TypedDict):
    Subnets: Sequence[str],
    AssignPublicIp: NotRequired[AssignPublicIpType],  # (1)
    SecurityGroups: NotRequired[Sequence[str]],
  1. See AssignPublicIpType

CapacityProviderStrategyItemTypeDef#

# CapacityProviderStrategyItemTypeDef definition

class CapacityProviderStrategyItemTypeDef(TypedDict):
    capacityProvider: str,
    base: NotRequired[int],
    weight: NotRequired[int],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

FlexibleTimeWindowTypeDef#

# FlexibleTimeWindowTypeDef definition

class FlexibleTimeWindowTypeDef(TypedDict):
    Mode: FlexibleTimeWindowModeType,  # (1)
    MaximumWindowInMinutes: NotRequired[int],
  1. See FlexibleTimeWindowModeType

DeadLetterConfigTypeDef#

# DeadLetterConfigTypeDef definition

class DeadLetterConfigTypeDef(TypedDict):
    Arn: NotRequired[str],

DeleteScheduleGroupInputRequestTypeDef#

# DeleteScheduleGroupInputRequestTypeDef definition

class DeleteScheduleGroupInputRequestTypeDef(TypedDict):
    Name: str,
    ClientToken: NotRequired[str],

DeleteScheduleInputRequestTypeDef#

# DeleteScheduleInputRequestTypeDef definition

class DeleteScheduleInputRequestTypeDef(TypedDict):
    Name: str,
    ClientToken: NotRequired[str],
    GroupName: NotRequired[str],

PlacementConstraintTypeDef#

# PlacementConstraintTypeDef definition

class PlacementConstraintTypeDef(TypedDict):
    expression: NotRequired[str],
    type: NotRequired[PlacementConstraintTypeType],  # (1)
  1. See PlacementConstraintTypeType

PlacementStrategyTypeDef#

# PlacementStrategyTypeDef definition

class PlacementStrategyTypeDef(TypedDict):
    field: NotRequired[str],
    type: NotRequired[PlacementStrategyTypeType],  # (1)
  1. See PlacementStrategyTypeType

EventBridgeParametersTypeDef#

# EventBridgeParametersTypeDef definition

class EventBridgeParametersTypeDef(TypedDict):
    DetailType: str,
    Source: str,

GetScheduleGroupInputRequestTypeDef#

# GetScheduleGroupInputRequestTypeDef definition

class GetScheduleGroupInputRequestTypeDef(TypedDict):
    Name: str,

GetScheduleInputRequestTypeDef#

# GetScheduleInputRequestTypeDef definition

class GetScheduleInputRequestTypeDef(TypedDict):
    Name: str,
    GroupName: NotRequired[str],

KinesisParametersTypeDef#

# KinesisParametersTypeDef definition

class KinesisParametersTypeDef(TypedDict):
    PartitionKey: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListScheduleGroupsInputRequestTypeDef#

# ListScheduleGroupsInputRequestTypeDef definition

class ListScheduleGroupsInputRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NamePrefix: NotRequired[str],
    NextToken: NotRequired[str],

ScheduleGroupSummaryTypeDef#

# ScheduleGroupSummaryTypeDef definition

class ScheduleGroupSummaryTypeDef(TypedDict):
    Arn: NotRequired[str],
    CreationDate: NotRequired[datetime],
    LastModificationDate: NotRequired[datetime],
    Name: NotRequired[str],
    State: NotRequired[ScheduleGroupStateType],  # (1)
  1. See ScheduleGroupStateType

ListSchedulesInputRequestTypeDef#

# ListSchedulesInputRequestTypeDef definition

class ListSchedulesInputRequestTypeDef(TypedDict):
    GroupName: NotRequired[str],
    MaxResults: NotRequired[int],
    NamePrefix: NotRequired[str],
    NextToken: NotRequired[str],
    State: NotRequired[ScheduleStateType],  # (1)
  1. See ScheduleStateType

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,

RetryPolicyTypeDef#

# RetryPolicyTypeDef definition

class RetryPolicyTypeDef(TypedDict):
    MaximumEventAgeInSeconds: NotRequired[int],
    MaximumRetryAttempts: NotRequired[int],

SageMakerPipelineParameterTypeDef#

# SageMakerPipelineParameterTypeDef definition

class SageMakerPipelineParameterTypeDef(TypedDict):
    Name: str,
    Value: str,

TargetSummaryTypeDef#

# TargetSummaryTypeDef definition

class TargetSummaryTypeDef(TypedDict):
    Arn: str,

SqsParametersTypeDef#

# SqsParametersTypeDef definition

class SqsParametersTypeDef(TypedDict):
    MessageGroupId: NotRequired[str],

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

class UntagResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

NetworkConfigurationOutputTypeDef#

# NetworkConfigurationOutputTypeDef definition

class NetworkConfigurationOutputTypeDef(TypedDict):
    awsvpcConfiguration: NotRequired[AwsVpcConfigurationOutputTypeDef],  # (1)
  1. See AwsVpcConfigurationOutputTypeDef

NetworkConfigurationTypeDef#

# NetworkConfigurationTypeDef definition

class NetworkConfigurationTypeDef(TypedDict):
    awsvpcConfiguration: NotRequired[AwsVpcConfigurationTypeDef],  # (1)
  1. See AwsVpcConfigurationTypeDef

CreateScheduleGroupInputRequestTypeDef#

# CreateScheduleGroupInputRequestTypeDef definition

class CreateScheduleGroupInputRequestTypeDef(TypedDict):
    Name: str,
    ClientToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

class TagResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateScheduleGroupOutputTypeDef#

# CreateScheduleGroupOutputTypeDef definition

class CreateScheduleGroupOutputTypeDef(TypedDict):
    ScheduleGroupArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateScheduleOutputTypeDef#

# CreateScheduleOutputTypeDef definition

class CreateScheduleOutputTypeDef(TypedDict):
    ScheduleArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetScheduleGroupOutputTypeDef#

# GetScheduleGroupOutputTypeDef definition

class GetScheduleGroupOutputTypeDef(TypedDict):
    Arn: str,
    CreationDate: datetime,
    LastModificationDate: datetime,
    Name: str,
    State: ScheduleGroupStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScheduleGroupStateType
  2. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

UpdateScheduleOutputTypeDef#

# UpdateScheduleOutputTypeDef definition

class UpdateScheduleOutputTypeDef(TypedDict):
    ScheduleArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListScheduleGroupsInputListScheduleGroupsPaginateTypeDef#

# ListScheduleGroupsInputListScheduleGroupsPaginateTypeDef definition

class ListScheduleGroupsInputListScheduleGroupsPaginateTypeDef(TypedDict):
    NamePrefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSchedulesInputListSchedulesPaginateTypeDef#

# ListSchedulesInputListSchedulesPaginateTypeDef definition

class ListSchedulesInputListSchedulesPaginateTypeDef(TypedDict):
    GroupName: NotRequired[str],
    NamePrefix: NotRequired[str],
    State: NotRequired[ScheduleStateType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ScheduleStateType
  2. See PaginatorConfigTypeDef

ListScheduleGroupsOutputTypeDef#

# ListScheduleGroupsOutputTypeDef definition

class ListScheduleGroupsOutputTypeDef(TypedDict):
    ScheduleGroups: List[ScheduleGroupSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ScheduleGroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

SageMakerPipelineParametersOutputTypeDef#

# SageMakerPipelineParametersOutputTypeDef definition

class SageMakerPipelineParametersOutputTypeDef(TypedDict):
    PipelineParameterList: NotRequired[List[SageMakerPipelineParameterTypeDef]],  # (1)
  1. See SageMakerPipelineParameterTypeDef

SageMakerPipelineParametersTypeDef#

# SageMakerPipelineParametersTypeDef definition

class SageMakerPipelineParametersTypeDef(TypedDict):
    PipelineParameterList: NotRequired[Sequence[SageMakerPipelineParameterTypeDef]],  # (1)
  1. See SageMakerPipelineParameterTypeDef

ScheduleSummaryTypeDef#

# ScheduleSummaryTypeDef definition

class ScheduleSummaryTypeDef(TypedDict):
    Arn: NotRequired[str],
    CreationDate: NotRequired[datetime],
    GroupName: NotRequired[str],
    LastModificationDate: NotRequired[datetime],
    Name: NotRequired[str],
    State: NotRequired[ScheduleStateType],  # (1)
    Target: NotRequired[TargetSummaryTypeDef],  # (2)
  1. See ScheduleStateType
  2. See TargetSummaryTypeDef

EcsParametersOutputTypeDef#

# EcsParametersOutputTypeDef definition

class EcsParametersOutputTypeDef(TypedDict):
    TaskDefinitionArn: str,
    CapacityProviderStrategy: NotRequired[List[CapacityProviderStrategyItemTypeDef]],  # (1)
    EnableECSManagedTags: NotRequired[bool],
    EnableExecuteCommand: NotRequired[bool],
    Group: NotRequired[str],
    LaunchType: NotRequired[LaunchTypeType],  # (2)
    NetworkConfiguration: NotRequired[NetworkConfigurationOutputTypeDef],  # (3)
    PlacementConstraints: NotRequired[List[PlacementConstraintTypeDef]],  # (4)
    PlacementStrategy: NotRequired[List[PlacementStrategyTypeDef]],  # (5)
    PlatformVersion: NotRequired[str],
    PropagateTags: NotRequired[PropagateTagsType],  # (6)
    ReferenceId: NotRequired[str],
    Tags: NotRequired[List[Dict[str, str]]],
    TaskCount: NotRequired[int],
  1. See CapacityProviderStrategyItemTypeDef
  2. See LaunchTypeType
  3. See NetworkConfigurationOutputTypeDef
  4. See PlacementConstraintTypeDef
  5. See PlacementStrategyTypeDef
  6. See PropagateTagsType

EcsParametersTypeDef#

# EcsParametersTypeDef definition

class EcsParametersTypeDef(TypedDict):
    TaskDefinitionArn: str,
    CapacityProviderStrategy: NotRequired[Sequence[CapacityProviderStrategyItemTypeDef]],  # (1)
    EnableECSManagedTags: NotRequired[bool],
    EnableExecuteCommand: NotRequired[bool],
    Group: NotRequired[str],
    LaunchType: NotRequired[LaunchTypeType],  # (2)
    NetworkConfiguration: NotRequired[NetworkConfigurationTypeDef],  # (3)
    PlacementConstraints: NotRequired[Sequence[PlacementConstraintTypeDef]],  # (4)
    PlacementStrategy: NotRequired[Sequence[PlacementStrategyTypeDef]],  # (5)
    PlatformVersion: NotRequired[str],
    PropagateTags: NotRequired[PropagateTagsType],  # (6)
    ReferenceId: NotRequired[str],
    Tags: NotRequired[Sequence[Mapping[str, str]]],
    TaskCount: NotRequired[int],
  1. See CapacityProviderStrategyItemTypeDef
  2. See LaunchTypeType
  3. See NetworkConfigurationTypeDef
  4. See PlacementConstraintTypeDef
  5. See PlacementStrategyTypeDef
  6. See PropagateTagsType

ListSchedulesOutputTypeDef#

# ListSchedulesOutputTypeDef definition

class ListSchedulesOutputTypeDef(TypedDict):
    Schedules: List[ScheduleSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ScheduleSummaryTypeDef
  2. See ResponseMetadataTypeDef

TargetOutputTypeDef#

# TargetOutputTypeDef definition

class TargetOutputTypeDef(TypedDict):
    Arn: str,
    RoleArn: str,
    DeadLetterConfig: NotRequired[DeadLetterConfigTypeDef],  # (1)
    EcsParameters: NotRequired[EcsParametersOutputTypeDef],  # (2)
    EventBridgeParameters: NotRequired[EventBridgeParametersTypeDef],  # (3)
    Input: NotRequired[str],
    KinesisParameters: NotRequired[KinesisParametersTypeDef],  # (4)
    RetryPolicy: NotRequired[RetryPolicyTypeDef],  # (5)
    SageMakerPipelineParameters: NotRequired[SageMakerPipelineParametersOutputTypeDef],  # (6)
    SqsParameters: NotRequired[SqsParametersTypeDef],  # (7)
  1. See DeadLetterConfigTypeDef
  2. See EcsParametersOutputTypeDef
  3. See EventBridgeParametersTypeDef
  4. See KinesisParametersTypeDef
  5. See RetryPolicyTypeDef
  6. See SageMakerPipelineParametersOutputTypeDef
  7. See SqsParametersTypeDef

TargetTypeDef#

# TargetTypeDef definition

class TargetTypeDef(TypedDict):
    Arn: str,
    RoleArn: str,
    DeadLetterConfig: NotRequired[DeadLetterConfigTypeDef],  # (1)
    EcsParameters: NotRequired[EcsParametersTypeDef],  # (2)
    EventBridgeParameters: NotRequired[EventBridgeParametersTypeDef],  # (3)
    Input: NotRequired[str],
    KinesisParameters: NotRequired[KinesisParametersTypeDef],  # (4)
    RetryPolicy: NotRequired[RetryPolicyTypeDef],  # (5)
    SageMakerPipelineParameters: NotRequired[SageMakerPipelineParametersTypeDef],  # (6)
    SqsParameters: NotRequired[SqsParametersTypeDef],  # (7)
  1. See DeadLetterConfigTypeDef
  2. See EcsParametersTypeDef
  3. See EventBridgeParametersTypeDef
  4. See KinesisParametersTypeDef
  5. See RetryPolicyTypeDef
  6. See SageMakerPipelineParametersTypeDef
  7. See SqsParametersTypeDef

GetScheduleOutputTypeDef#

# GetScheduleOutputTypeDef definition

class GetScheduleOutputTypeDef(TypedDict):
    ActionAfterCompletion: ActionAfterCompletionType,  # (1)
    Arn: str,
    CreationDate: datetime,
    Description: str,
    EndDate: datetime,
    FlexibleTimeWindow: FlexibleTimeWindowTypeDef,  # (2)
    GroupName: str,
    KmsKeyArn: str,
    LastModificationDate: datetime,
    Name: str,
    ScheduleExpression: str,
    ScheduleExpressionTimezone: str,
    StartDate: datetime,
    State: ScheduleStateType,  # (3)
    Target: TargetOutputTypeDef,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See ActionAfterCompletionType
  2. See FlexibleTimeWindowTypeDef
  3. See ScheduleStateType
  4. See TargetOutputTypeDef
  5. See ResponseMetadataTypeDef

CreateScheduleInputRequestTypeDef#

# CreateScheduleInputRequestTypeDef definition

class CreateScheduleInputRequestTypeDef(TypedDict):
    FlexibleTimeWindow: FlexibleTimeWindowTypeDef,  # (1)
    Name: str,
    ScheduleExpression: str,
    Target: TargetTypeDef,  # (2)
    ActionAfterCompletion: NotRequired[ActionAfterCompletionType],  # (3)
    ClientToken: NotRequired[str],
    Description: NotRequired[str],
    EndDate: NotRequired[Union[datetime, str]],
    GroupName: NotRequired[str],
    KmsKeyArn: NotRequired[str],
    ScheduleExpressionTimezone: NotRequired[str],
    StartDate: NotRequired[Union[datetime, str]],
    State: NotRequired[ScheduleStateType],  # (4)
  1. See FlexibleTimeWindowTypeDef
  2. See TargetTypeDef
  3. See ActionAfterCompletionType
  4. See ScheduleStateType

UpdateScheduleInputRequestTypeDef#

# UpdateScheduleInputRequestTypeDef definition

class UpdateScheduleInputRequestTypeDef(TypedDict):
    FlexibleTimeWindow: FlexibleTimeWindowTypeDef,  # (1)
    Name: str,
    ScheduleExpression: str,
    Target: TargetTypeDef,  # (2)
    ActionAfterCompletion: NotRequired[ActionAfterCompletionType],  # (3)
    ClientToken: NotRequired[str],
    Description: NotRequired[str],
    EndDate: NotRequired[Union[datetime, str]],
    GroupName: NotRequired[str],
    KmsKeyArn: NotRequired[str],
    ScheduleExpressionTimezone: NotRequired[str],
    StartDate: NotRequired[Union[datetime, str]],
    State: NotRequired[ScheduleStateType],  # (4)
  1. See FlexibleTimeWindowTypeDef
  2. See