Skip to content

Typed dictionaries

Index > EventBridgeScheduler > Typed dictionaries

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

AwsVpcConfigurationTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import AwsVpcConfigurationTypeDef

def get_value() -> AwsVpcConfigurationTypeDef:
    return {
        "Subnets": ...,
    }
Definition
class AwsVpcConfigurationTypeDef(TypedDict):
    Subnets: Sequence[str],
    AssignPublicIp: NotRequired[AssignPublicIpType],  # (1)
    SecurityGroups: NotRequired[Sequence[str]],
  1. See AssignPublicIpType

CapacityProviderStrategyItemTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import CapacityProviderStrategyItemTypeDef

def get_value() -> CapacityProviderStrategyItemTypeDef:
    return {
        "capacityProvider": ...,
    }
Definition
class CapacityProviderStrategyItemTypeDef(TypedDict):
    capacityProvider: str,
    base: NotRequired[int],
    weight: NotRequired[int],

TagTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
Definition
class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

FlexibleTimeWindowTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import FlexibleTimeWindowTypeDef

def get_value() -> FlexibleTimeWindowTypeDef:
    return {
        "Mode": ...,
    }
Definition
class FlexibleTimeWindowTypeDef(TypedDict):
    Mode: FlexibleTimeWindowModeType,  # (1)
    MaximumWindowInMinutes: NotRequired[int],
  1. See FlexibleTimeWindowModeType

DeadLetterConfigTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import DeadLetterConfigTypeDef

def get_value() -> DeadLetterConfigTypeDef:
    return {
        "Arn": ...,
    }
Definition
class DeadLetterConfigTypeDef(TypedDict):
    Arn: NotRequired[str],

DeleteScheduleGroupInputRequestTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import DeleteScheduleGroupInputRequestTypeDef

def get_value() -> DeleteScheduleGroupInputRequestTypeDef:
    return {
        "Name": ...,
    }
Definition
class DeleteScheduleGroupInputRequestTypeDef(TypedDict):
    Name: str,
    ClientToken: NotRequired[str],

DeleteScheduleInputRequestTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import DeleteScheduleInputRequestTypeDef

def get_value() -> DeleteScheduleInputRequestTypeDef:
    return {
        "Name": ...,
    }
Definition
class DeleteScheduleInputRequestTypeDef(TypedDict):
    Name: str,
    ClientToken: NotRequired[str],
    GroupName: NotRequired[str],

PlacementConstraintTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import PlacementConstraintTypeDef

def get_value() -> PlacementConstraintTypeDef:
    return {
        "expression": ...,
    }
Definition
class PlacementConstraintTypeDef(TypedDict):
    expression: NotRequired[str],
    type: NotRequired[PlacementConstraintTypeType],  # (1)
  1. See PlacementConstraintTypeType

PlacementStrategyTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import PlacementStrategyTypeDef

def get_value() -> PlacementStrategyTypeDef:
    return {
        "field": ...,
    }
Definition
class PlacementStrategyTypeDef(TypedDict):
    field: NotRequired[str],
    type: NotRequired[PlacementStrategyTypeType],  # (1)
  1. See PlacementStrategyTypeType

EventBridgeParametersTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import EventBridgeParametersTypeDef

def get_value() -> EventBridgeParametersTypeDef:
    return {
        "DetailType": ...,
        "Source": ...,
    }
Definition
class EventBridgeParametersTypeDef(TypedDict):
    DetailType: str,
    Source: str,

GetScheduleGroupInputRequestTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import GetScheduleGroupInputRequestTypeDef

def get_value() -> GetScheduleGroupInputRequestTypeDef:
    return {
        "Name": ...,
    }
Definition
class GetScheduleGroupInputRequestTypeDef(TypedDict):
    Name: str,

GetScheduleInputRequestTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import GetScheduleInputRequestTypeDef

def get_value() -> GetScheduleInputRequestTypeDef:
    return {
        "Name": ...,
    }
Definition
class GetScheduleInputRequestTypeDef(TypedDict):
    Name: str,
    GroupName: NotRequired[str],

KinesisParametersTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import KinesisParametersTypeDef

def get_value() -> KinesisParametersTypeDef:
    return {
        "PartitionKey": ...,
    }
Definition
class KinesisParametersTypeDef(TypedDict):
    PartitionKey: str,

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListScheduleGroupsInputRequestTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import ListScheduleGroupsInputRequestTypeDef

def get_value() -> ListScheduleGroupsInputRequestTypeDef:
    return {
        "MaxResults": ...,
    }
Definition
class ListScheduleGroupsInputRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NamePrefix: NotRequired[str],
    NextToken: NotRequired[str],

ScheduleGroupSummaryTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import ScheduleGroupSummaryTypeDef

def get_value() -> ScheduleGroupSummaryTypeDef:
    return {
        "Arn": ...,
    }
Definition
class ScheduleGroupSummaryTypeDef(TypedDict):
    Arn: NotRequired[str],
    CreationDate: NotRequired[datetime],
    LastModificationDate: NotRequired[datetime],
    Name: NotRequired[str],
    State: NotRequired[ScheduleGroupStateType],  # (1)
  1. See ScheduleGroupStateType

ListSchedulesInputRequestTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import ListSchedulesInputRequestTypeDef

def get_value() -> ListSchedulesInputRequestTypeDef:
    return {
        "GroupName": ...,
    }
Definition
class ListSchedulesInputRequestTypeDef(TypedDict):
    GroupName: NotRequired[str],
    MaxResults: NotRequired[int],
    NamePrefix: NotRequired[str],
    NextToken: NotRequired[str],
    State: NotRequired[ScheduleStateType],  # (1)
  1. See ScheduleStateType

ListTagsForResourceInputRequestTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import ListTagsForResourceInputRequestTypeDef

def get_value() -> ListTagsForResourceInputRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
Definition
class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,

RetryPolicyTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import RetryPolicyTypeDef

def get_value() -> RetryPolicyTypeDef:
    return {
        "MaximumEventAgeInSeconds": ...,
    }
Definition
class RetryPolicyTypeDef(TypedDict):
    MaximumEventAgeInSeconds: NotRequired[int],
    MaximumRetryAttempts: NotRequired[int],

SageMakerPipelineParameterTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import SageMakerPipelineParameterTypeDef

def get_value() -> SageMakerPipelineParameterTypeDef:
    return {
        "Name": ...,
        "Value": ...,
    }
Definition
class SageMakerPipelineParameterTypeDef(TypedDict):
    Name: str,
    Value: str,

TargetSummaryTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import TargetSummaryTypeDef

def get_value() -> TargetSummaryTypeDef:
    return {
        "Arn": ...,
    }
Definition
class TargetSummaryTypeDef(TypedDict):
    Arn: str,

SqsParametersTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import SqsParametersTypeDef

def get_value() -> SqsParametersTypeDef:
    return {
        "MessageGroupId": ...,
    }
Definition
class SqsParametersTypeDef(TypedDict):
    MessageGroupId: NotRequired[str],

UntagResourceInputRequestTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import UntagResourceInputRequestTypeDef

def get_value() -> UntagResourceInputRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }
Definition
class UntagResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

NetworkConfigurationTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import NetworkConfigurationTypeDef

def get_value() -> NetworkConfigurationTypeDef:
    return {
        "awsvpcConfiguration": ...,
    }
Definition
class NetworkConfigurationTypeDef(TypedDict):
    awsvpcConfiguration: NotRequired[AwsVpcConfigurationTypeDef],  # (1)
  1. See AwsVpcConfigurationTypeDef

CreateScheduleGroupInputRequestTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import CreateScheduleGroupInputRequestTypeDef

def get_value() -> CreateScheduleGroupInputRequestTypeDef:
    return {
        "Name": ...,
    }
Definition
class CreateScheduleGroupInputRequestTypeDef(TypedDict):
    Name: str,
    ClientToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

TagResourceInputRequestTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import TagResourceInputRequestTypeDef

def get_value() -> TagResourceInputRequestTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
    }
Definition
class TagResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateScheduleGroupOutputTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import CreateScheduleGroupOutputTypeDef

def get_value() -> CreateScheduleGroupOutputTypeDef:
    return {
        "ScheduleGroupArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateScheduleGroupOutputTypeDef(TypedDict):
    ScheduleGroupArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateScheduleOutputTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import CreateScheduleOutputTypeDef

def get_value() -> CreateScheduleOutputTypeDef:
    return {
        "ScheduleArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateScheduleOutputTypeDef(TypedDict):
    ScheduleArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetScheduleGroupOutputTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import GetScheduleGroupOutputTypeDef

def get_value() -> GetScheduleGroupOutputTypeDef:
    return {
        "Arn": ...,
        "CreationDate": ...,
        "LastModificationDate": ...,
        "Name": ...,
        "State": ...,
        "ResponseMetadata": ...,
    }
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

Usage Example
from mypy_boto3_scheduler.type_defs import ListTagsForResourceOutputTypeDef

def get_value() -> ListTagsForResourceOutputTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTagsForResourceOutputTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

UpdateScheduleOutputTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import UpdateScheduleOutputTypeDef

def get_value() -> UpdateScheduleOutputTypeDef:
    return {
        "ScheduleArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateScheduleOutputTypeDef(TypedDict):
    ScheduleArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListScheduleGroupsInputListScheduleGroupsPaginateTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import ListScheduleGroupsInputListScheduleGroupsPaginateTypeDef

def get_value() -> ListScheduleGroupsInputListScheduleGroupsPaginateTypeDef:
    return {
        "NamePrefix": ...,
    }
Definition
class ListScheduleGroupsInputListScheduleGroupsPaginateTypeDef(TypedDict):
    NamePrefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSchedulesInputListSchedulesPaginateTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import ListSchedulesInputListSchedulesPaginateTypeDef

def get_value() -> ListSchedulesInputListSchedulesPaginateTypeDef:
    return {
        "GroupName": ...,
    }
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

Usage Example
from mypy_boto3_scheduler.type_defs import ListScheduleGroupsOutputTypeDef

def get_value() -> ListScheduleGroupsOutputTypeDef:
    return {
        "NextToken": ...,
        "ScheduleGroups": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListScheduleGroupsOutputTypeDef(TypedDict):
    NextToken: str,
    ScheduleGroups: List[ScheduleGroupSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScheduleGroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

SageMakerPipelineParametersTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import SageMakerPipelineParametersTypeDef

def get_value() -> SageMakerPipelineParametersTypeDef:
    return {
        "PipelineParameterList": ...,
    }
Definition
class SageMakerPipelineParametersTypeDef(TypedDict):
    PipelineParameterList: NotRequired[Sequence[SageMakerPipelineParameterTypeDef]],  # (1)
  1. See SageMakerPipelineParameterTypeDef

ScheduleSummaryTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import ScheduleSummaryTypeDef

def get_value() -> ScheduleSummaryTypeDef:
    return {
        "Arn": ...,
    }
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

EcsParametersTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import EcsParametersTypeDef

def get_value() -> EcsParametersTypeDef:
    return {
        "TaskDefinitionArn": ...,
    }
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

Usage Example
from mypy_boto3_scheduler.type_defs import ListSchedulesOutputTypeDef

def get_value() -> ListSchedulesOutputTypeDef:
    return {
        "NextToken": ...,
        "Schedules": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListSchedulesOutputTypeDef(TypedDict):
    NextToken: str,
    Schedules: List[ScheduleSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScheduleSummaryTypeDef
  2. See ResponseMetadataTypeDef

TargetTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import TargetTypeDef

def get_value() -> TargetTypeDef:
    return {
        "Arn": ...,
        "RoleArn": ...,
    }
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

CreateScheduleInputRequestTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import CreateScheduleInputRequestTypeDef

def get_value() -> CreateScheduleInputRequestTypeDef:
    return {
        "FlexibleTimeWindow": ...,
        "Name": ...,
        "ScheduleExpression": ...,
        "Target": ...,
    }
Definition
class CreateScheduleInputRequestTypeDef(TypedDict):
    FlexibleTimeWindow: FlexibleTimeWindowTypeDef,  # (1)
    Name: str,
    ScheduleExpression: str,
    Target: TargetTypeDef,  # (2)
    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],  # (3)
  1. See FlexibleTimeWindowTypeDef
  2. See TargetTypeDef
  3. See ScheduleStateType

GetScheduleOutputTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import GetScheduleOutputTypeDef

def get_value() -> GetScheduleOutputTypeDef:
    return {
        "Arn": ...,
        "CreationDate": ...,
        "Description": ...,
        "EndDate": ...,
        "FlexibleTimeWindow": ...,
        "GroupName": ...,
        "KmsKeyArn": ...,
        "LastModificationDate": ...,
        "Name": ...,
        "ScheduleExpression": ...,
        "ScheduleExpressionTimezone": ...,
        "StartDate": ...,
        "State": ...,
        "Target": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetScheduleOutputTypeDef(TypedDict):
    Arn: str,
    CreationDate: datetime,
    Description: str,
    EndDate: datetime,
    FlexibleTimeWindow: FlexibleTimeWindowTypeDef,  # (1)
    GroupName: str,
    KmsKeyArn: str,
    LastModificationDate: datetime,
    Name: str,
    ScheduleExpression: str,
    ScheduleExpressionTimezone: str,
    StartDate: datetime,
    State: ScheduleStateType,  # (2)
    Target: TargetTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See FlexibleTimeWindowTypeDef
  2. See ScheduleStateType
  3. See TargetTypeDef
  4. See ResponseMetadataTypeDef

UpdateScheduleInputRequestTypeDef

Usage Example
from mypy_boto3_scheduler.type_defs import UpdateScheduleInputRequestTypeDef

def get_value() -> UpdateScheduleInputRequestTypeDef:
    return {
        "FlexibleTimeWindow": ...,
        "Name": ...,
        "ScheduleExpression": ...,
        "Target": ...,
    }
Definition
class UpdateScheduleInputRequestTypeDef(TypedDict):
    FlexibleTimeWindow: FlexibleTimeWindowTypeDef,  # (1)
    Name: str,
    ScheduleExpression: str,
    Target: TargetTypeDef,  # (2)
    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],  # (3)
  1. See FlexibleTimeWindowTypeDef
  2. See TargetTypeDef
  3. See ScheduleStateType