Skip to content

Type definitions#

Index > Synthetics > Type definitions

Auto-generated documentation for Synthetics type annotations stubs module mypy-boto3-synthetics.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

S3EncryptionConfigTypeDef#

# S3EncryptionConfigTypeDef definition

class S3EncryptionConfigTypeDef(TypedDict):
    EncryptionMode: NotRequired[EncryptionModeType],  # (1)
    KmsKeyArn: NotRequired[str],
  1. See EncryptionModeType

AssociateResourceRequestRequestTypeDef#

# AssociateResourceRequestRequestTypeDef definition

class AssociateResourceRequestRequestTypeDef(TypedDict):
    GroupIdentifier: str,
    ResourceArn: str,

BaseScreenshotTypeDef#

# BaseScreenshotTypeDef definition

class BaseScreenshotTypeDef(TypedDict):
    ScreenshotName: str,
    IgnoreCoordinates: NotRequired[List[str]],

CanaryCodeOutputTypeDef#

# CanaryCodeOutputTypeDef definition

class CanaryCodeOutputTypeDef(TypedDict):
    SourceLocationArn: NotRequired[str],
    Handler: NotRequired[str],

CanaryRunConfigInputTypeDef#

# CanaryRunConfigInputTypeDef definition

class CanaryRunConfigInputTypeDef(TypedDict):
    TimeoutInSeconds: NotRequired[int],
    MemoryInMB: NotRequired[int],
    ActiveTracing: NotRequired[bool],
    EnvironmentVariables: NotRequired[Mapping[str, str]],

CanaryRunConfigOutputTypeDef#

# CanaryRunConfigOutputTypeDef definition

class CanaryRunConfigOutputTypeDef(TypedDict):
    TimeoutInSeconds: NotRequired[int],
    MemoryInMB: NotRequired[int],
    ActiveTracing: NotRequired[bool],

CanaryRunStatusTypeDef#

# CanaryRunStatusTypeDef definition

class CanaryRunStatusTypeDef(TypedDict):
    State: NotRequired[CanaryRunStateType],  # (1)
    StateReason: NotRequired[str],
    StateReasonCode: NotRequired[CanaryRunStateReasonCodeType],  # (2)
  1. See CanaryRunStateType
  2. See CanaryRunStateReasonCodeType

CanaryRunTimelineTypeDef#

# CanaryRunTimelineTypeDef definition

class CanaryRunTimelineTypeDef(TypedDict):
    Started: NotRequired[datetime],
    Completed: NotRequired[datetime],

CanaryScheduleInputTypeDef#

# CanaryScheduleInputTypeDef definition

class CanaryScheduleInputTypeDef(TypedDict):
    Expression: str,
    DurationInSeconds: NotRequired[int],

CanaryScheduleOutputTypeDef#

# CanaryScheduleOutputTypeDef definition

class CanaryScheduleOutputTypeDef(TypedDict):
    Expression: NotRequired[str],
    DurationInSeconds: NotRequired[int],

CanaryStatusTypeDef#

# CanaryStatusTypeDef definition

class CanaryStatusTypeDef(TypedDict):
    State: NotRequired[CanaryStateType],  # (1)
    StateReason: NotRequired[str],
    StateReasonCode: NotRequired[CanaryStateReasonCodeType],  # (2)
  1. See CanaryStateType
  2. See CanaryStateReasonCodeType

CanaryTimelineTypeDef#

# CanaryTimelineTypeDef definition

class CanaryTimelineTypeDef(TypedDict):
    Created: NotRequired[datetime],
    LastModified: NotRequired[datetime],
    LastStarted: NotRequired[datetime],
    LastStopped: NotRequired[datetime],

VpcConfigOutputTypeDef#

# VpcConfigOutputTypeDef definition

class VpcConfigOutputTypeDef(TypedDict):
    VpcId: NotRequired[str],
    SubnetIds: NotRequired[List[str]],
    SecurityGroupIds: NotRequired[List[str]],

VpcConfigInputTypeDef#

# VpcConfigInputTypeDef definition

class VpcConfigInputTypeDef(TypedDict):
    SubnetIds: NotRequired[Sequence[str]],
    SecurityGroupIds: NotRequired[Sequence[str]],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CreateGroupRequestRequestTypeDef#

# CreateGroupRequestRequestTypeDef definition

class CreateGroupRequestRequestTypeDef(TypedDict):
    Name: str,
    Tags: NotRequired[Mapping[str, str]],

GroupTypeDef#

# GroupTypeDef definition

class GroupTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],
    Arn: NotRequired[str],
    Tags: NotRequired[Dict[str, str]],
    CreatedTime: NotRequired[datetime],
    LastModifiedTime: NotRequired[datetime],

DeleteCanaryRequestRequestTypeDef#

# DeleteCanaryRequestRequestTypeDef definition

class DeleteCanaryRequestRequestTypeDef(TypedDict):
    Name: str,
    DeleteLambda: NotRequired[bool],

DeleteGroupRequestRequestTypeDef#

# DeleteGroupRequestRequestTypeDef definition

class DeleteGroupRequestRequestTypeDef(TypedDict):
    GroupIdentifier: str,

DescribeCanariesLastRunRequestRequestTypeDef#

# DescribeCanariesLastRunRequestRequestTypeDef definition

class DescribeCanariesLastRunRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Names: NotRequired[Sequence[str]],

DescribeCanariesRequestRequestTypeDef#

# DescribeCanariesRequestRequestTypeDef definition

class DescribeCanariesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Names: NotRequired[Sequence[str]],

DescribeRuntimeVersionsRequestRequestTypeDef#

# DescribeRuntimeVersionsRequestRequestTypeDef definition

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

RuntimeVersionTypeDef#

# RuntimeVersionTypeDef definition

class RuntimeVersionTypeDef(TypedDict):
    VersionName: NotRequired[str],
    Description: NotRequired[str],
    ReleaseDate: NotRequired[datetime],
    DeprecationDate: NotRequired[datetime],

DisassociateResourceRequestRequestTypeDef#

# DisassociateResourceRequestRequestTypeDef definition

class DisassociateResourceRequestRequestTypeDef(TypedDict):
    GroupIdentifier: str,
    ResourceArn: str,

GetCanaryRequestRequestTypeDef#

# GetCanaryRequestRequestTypeDef definition

class GetCanaryRequestRequestTypeDef(TypedDict):
    Name: str,

GetCanaryRunsRequestRequestTypeDef#

# GetCanaryRunsRequestRequestTypeDef definition

class GetCanaryRunsRequestRequestTypeDef(TypedDict):
    Name: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

GetGroupRequestRequestTypeDef#

# GetGroupRequestRequestTypeDef definition

class GetGroupRequestRequestTypeDef(TypedDict):
    GroupIdentifier: str,

GroupSummaryTypeDef#

# GroupSummaryTypeDef definition

class GroupSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],
    Arn: NotRequired[str],

ListAssociatedGroupsRequestRequestTypeDef#

# ListAssociatedGroupsRequestRequestTypeDef definition

class ListAssociatedGroupsRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListGroupResourcesRequestRequestTypeDef#

# ListGroupResourcesRequestRequestTypeDef definition

class ListGroupResourcesRequestRequestTypeDef(TypedDict):
    GroupIdentifier: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListGroupsRequestRequestTypeDef#

# ListGroupsRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

StartCanaryRequestRequestTypeDef#

# StartCanaryRequestRequestTypeDef definition

class StartCanaryRequestRequestTypeDef(TypedDict):
    Name: str,

StopCanaryRequestRequestTypeDef#

# StopCanaryRequestRequestTypeDef definition

class StopCanaryRequestRequestTypeDef(TypedDict):
    Name: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

ArtifactConfigInputTypeDef#

# ArtifactConfigInputTypeDef definition

class ArtifactConfigInputTypeDef(TypedDict):
    S3Encryption: NotRequired[S3EncryptionConfigTypeDef],  # (1)
  1. See S3EncryptionConfigTypeDef

ArtifactConfigOutputTypeDef#

# ArtifactConfigOutputTypeDef definition

class ArtifactConfigOutputTypeDef(TypedDict):
    S3Encryption: NotRequired[S3EncryptionConfigTypeDef],  # (1)
  1. See S3EncryptionConfigTypeDef

VisualReferenceInputTypeDef#

# VisualReferenceInputTypeDef definition

class VisualReferenceInputTypeDef(TypedDict):
    BaseCanaryRunId: str,
    BaseScreenshots: NotRequired[Sequence[BaseScreenshotTypeDef]],  # (1)
  1. See BaseScreenshotTypeDef

VisualReferenceOutputTypeDef#

# VisualReferenceOutputTypeDef definition

class VisualReferenceOutputTypeDef(TypedDict):
    BaseScreenshots: NotRequired[List[BaseScreenshotTypeDef]],  # (1)
    BaseCanaryRunId: NotRequired[str],
  1. See BaseScreenshotTypeDef

CanaryCodeInputTypeDef#

# CanaryCodeInputTypeDef definition

class CanaryCodeInputTypeDef(TypedDict):
    Handler: str,
    S3Bucket: NotRequired[str],
    S3Key: NotRequired[str],
    S3Version: NotRequired[str],
    ZipFile: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],

CanaryRunTypeDef#

# CanaryRunTypeDef definition

class CanaryRunTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],
    Status: NotRequired[CanaryRunStatusTypeDef],  # (1)
    Timeline: NotRequired[CanaryRunTimelineTypeDef],  # (2)
    ArtifactS3Location: NotRequired[str],
  1. See CanaryRunStatusTypeDef
  2. See CanaryRunTimelineTypeDef

ListGroupResourcesResponseTypeDef#

# ListGroupResourcesResponseTypeDef definition

class ListGroupResourcesResponseTypeDef(TypedDict):
    Resources: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateGroupResponseTypeDef#

# CreateGroupResponseTypeDef definition

class CreateGroupResponseTypeDef(TypedDict):
    Group: GroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupTypeDef
  2. See ResponseMetadataTypeDef

GetGroupResponseTypeDef#

# GetGroupResponseTypeDef definition

class GetGroupResponseTypeDef(TypedDict):
    Group: GroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupTypeDef
  2. See ResponseMetadataTypeDef

DescribeRuntimeVersionsResponseTypeDef#

# DescribeRuntimeVersionsResponseTypeDef definition

class DescribeRuntimeVersionsResponseTypeDef(TypedDict):
    RuntimeVersions: List[RuntimeVersionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RuntimeVersionTypeDef
  2. See ResponseMetadataTypeDef

ListAssociatedGroupsResponseTypeDef#

# ListAssociatedGroupsResponseTypeDef definition

class ListAssociatedGroupsResponseTypeDef(TypedDict):
    Groups: List[GroupSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListGroupsResponseTypeDef#

# ListGroupsResponseTypeDef definition

class ListGroupsResponseTypeDef(TypedDict):
    Groups: List[GroupSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

CanaryTypeDef#

# CanaryTypeDef definition

class CanaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],
    Code: NotRequired[CanaryCodeOutputTypeDef],  # (1)
    ExecutionRoleArn: NotRequired[str],
    Schedule: NotRequired[CanaryScheduleOutputTypeDef],  # (2)
    RunConfig: NotRequired[CanaryRunConfigOutputTypeDef],  # (3)
    SuccessRetentionPeriodInDays: NotRequired[int],
    FailureRetentionPeriodInDays: NotRequired[int],
    Status: NotRequired[CanaryStatusTypeDef],  # (4)
    Timeline: NotRequired[CanaryTimelineTypeDef],  # (5)
    ArtifactS3Location: NotRequired[str],
    EngineArn: NotRequired[str],
    RuntimeVersion: NotRequired[str],
    VpcConfig: NotRequired[VpcConfigOutputTypeDef],  # (6)
    VisualReference: NotRequired[VisualReferenceOutputTypeDef],  # (7)
    Tags: NotRequired[Dict[str, str]],
    ArtifactConfig: NotRequired[ArtifactConfigOutputTypeDef],  # (8)
  1. See CanaryCodeOutputTypeDef
  2. See CanaryScheduleOutputTypeDef
  3. See CanaryRunConfigOutputTypeDef
  4. See CanaryStatusTypeDef
  5. See CanaryTimelineTypeDef
  6. See VpcConfigOutputTypeDef
  7. See VisualReferenceOutputTypeDef
  8. See ArtifactConfigOutputTypeDef

CreateCanaryRequestRequestTypeDef#

# CreateCanaryRequestRequestTypeDef definition

class CreateCanaryRequestRequestTypeDef(TypedDict):
    Name: str,
    Code: CanaryCodeInputTypeDef,  # (1)
    ArtifactS3Location: str,
    ExecutionRoleArn: str,
    Schedule: CanaryScheduleInputTypeDef,  # (2)
    RuntimeVersion: str,
    RunConfig: NotRequired[CanaryRunConfigInputTypeDef],  # (3)
    SuccessRetentionPeriodInDays: NotRequired[int],
    FailureRetentionPeriodInDays: NotRequired[int],
    VpcConfig: NotRequired[VpcConfigInputTypeDef],  # (4)
    Tags: NotRequired[Mapping[str, str]],
    ArtifactConfig: NotRequired[ArtifactConfigInputTypeDef],  # (5)
  1. See CanaryCodeInputTypeDef
  2. See CanaryScheduleInputTypeDef
  3. See CanaryRunConfigInputTypeDef
  4. See VpcConfigInputTypeDef
  5. See ArtifactConfigInputTypeDef

UpdateCanaryRequestRequestTypeDef#

# UpdateCanaryRequestRequestTypeDef definition

class UpdateCanaryRequestRequestTypeDef(TypedDict):
    Name: str,
    Code: NotRequired[CanaryCodeInputTypeDef],  # (1)
    ExecutionRoleArn: NotRequired[str],
    RuntimeVersion: NotRequired[str],
    Schedule: NotRequired[CanaryScheduleInputTypeDef],  # (2)
    RunConfig: NotRequired[CanaryRunConfigInputTypeDef],  # (3)
    SuccessRetentionPeriodInDays: NotRequired[int],
    FailureRetentionPeriodInDays: NotRequired[int],
    VpcConfig: NotRequired[VpcConfigInputTypeDef],  # (4)
    VisualReference: NotRequired[VisualReferenceInputTypeDef],  # (5)
    ArtifactS3Location: NotRequired[str],
    ArtifactConfig: NotRequired[ArtifactConfigInputTypeDef],  # (6)
  1. See CanaryCodeInputTypeDef
  2. See CanaryScheduleInputTypeDef
  3. See CanaryRunConfigInputTypeDef
  4. See VpcConfigInputTypeDef
  5. See VisualReferenceInputTypeDef
  6. See ArtifactConfigInputTypeDef

CanaryLastRunTypeDef#

# CanaryLastRunTypeDef definition

class CanaryLastRunTypeDef(TypedDict):
    CanaryName: NotRequired[str],
    LastRun: NotRequired[CanaryRunTypeDef],  # (1)
  1. See CanaryRunTypeDef

GetCanaryRunsResponseTypeDef#

# GetCanaryRunsResponseTypeDef definition

class GetCanaryRunsResponseTypeDef(TypedDict):
    CanaryRuns: List[CanaryRunTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CanaryRunTypeDef
  2. See ResponseMetadataTypeDef

CreateCanaryResponseTypeDef#

# CreateCanaryResponseTypeDef definition

class CreateCanaryResponseTypeDef(TypedDict):
    Canary: CanaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CanaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeCanariesResponseTypeDef#

# DescribeCanariesResponseTypeDef definition

class DescribeCanariesResponseTypeDef(TypedDict):
    Canaries: List[CanaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CanaryTypeDef
  2. See ResponseMetadataTypeDef

GetCanaryResponseTypeDef#

# GetCanaryResponseTypeDef definition

class GetCanaryResponseTypeDef(TypedDict):
    Canary: CanaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CanaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeCanariesLastRunResponseTypeDef#

# DescribeCanariesLastRunResponseTypeDef definition

class DescribeCanariesLastRunResponseTypeDef(TypedDict):
    CanariesLastRun: List[CanaryLastRunTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CanaryLastRunTypeDef
  2. See ResponseMetadataTypeDef