Skip to content

Typed dictionaries#

Index > Synthetics > Typed dictionaries

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

S3EncryptionConfigTypeDef#

# S3EncryptionConfigTypeDef usage example

from mypy_boto3_synthetics.type_defs import S3EncryptionConfigTypeDef

def get_value() -> S3EncryptionConfigTypeDef:
    return {
        "EncryptionMode": ...,
    }
# S3EncryptionConfigTypeDef definition

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

AssociateResourceRequestRequestTypeDef#

# AssociateResourceRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import AssociateResourceRequestRequestTypeDef

def get_value() -> AssociateResourceRequestRequestTypeDef:
    return {
        "GroupIdentifier": ...,
        "ResourceArn": ...,
    }
# AssociateResourceRequestRequestTypeDef definition

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

BaseScreenshotTypeDef#

# BaseScreenshotTypeDef usage example

from mypy_boto3_synthetics.type_defs import BaseScreenshotTypeDef

def get_value() -> BaseScreenshotTypeDef:
    return {
        "ScreenshotName": ...,
    }
# BaseScreenshotTypeDef definition

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

CanaryCodeInputTypeDef#

# CanaryCodeInputTypeDef usage example

from mypy_boto3_synthetics.type_defs import CanaryCodeInputTypeDef

def get_value() -> CanaryCodeInputTypeDef:
    return {
        "Handler": ...,
    }
# CanaryCodeInputTypeDef definition

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

CanaryCodeOutputTypeDef#

# CanaryCodeOutputTypeDef usage example

from mypy_boto3_synthetics.type_defs import CanaryCodeOutputTypeDef

def get_value() -> CanaryCodeOutputTypeDef:
    return {
        "SourceLocationArn": ...,
    }
# CanaryCodeOutputTypeDef definition

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

CanaryRunConfigInputTypeDef#

# CanaryRunConfigInputTypeDef usage example

from mypy_boto3_synthetics.type_defs import CanaryRunConfigInputTypeDef

def get_value() -> CanaryRunConfigInputTypeDef:
    return {
        "TimeoutInSeconds": ...,
    }
# CanaryRunConfigInputTypeDef definition

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

CanaryRunConfigOutputTypeDef#

# CanaryRunConfigOutputTypeDef usage example

from mypy_boto3_synthetics.type_defs import CanaryRunConfigOutputTypeDef

def get_value() -> CanaryRunConfigOutputTypeDef:
    return {
        "TimeoutInSeconds": ...,
    }
# CanaryRunConfigOutputTypeDef definition

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

CanaryRunStatusTypeDef#

# CanaryRunStatusTypeDef usage example

from mypy_boto3_synthetics.type_defs import CanaryRunStatusTypeDef

def get_value() -> CanaryRunStatusTypeDef:
    return {
        "State": ...,
    }
# CanaryRunStatusTypeDef definition

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

CanaryRunTimelineTypeDef#

# CanaryRunTimelineTypeDef usage example

from mypy_boto3_synthetics.type_defs import CanaryRunTimelineTypeDef

def get_value() -> CanaryRunTimelineTypeDef:
    return {
        "Started": ...,
    }
# CanaryRunTimelineTypeDef definition

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

CanaryScheduleInputTypeDef#

# CanaryScheduleInputTypeDef usage example

from mypy_boto3_synthetics.type_defs import CanaryScheduleInputTypeDef

def get_value() -> CanaryScheduleInputTypeDef:
    return {
        "Expression": ...,
    }
# CanaryScheduleInputTypeDef definition

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

CanaryScheduleOutputTypeDef#

# CanaryScheduleOutputTypeDef usage example

from mypy_boto3_synthetics.type_defs import CanaryScheduleOutputTypeDef

def get_value() -> CanaryScheduleOutputTypeDef:
    return {
        "Expression": ...,
    }
# CanaryScheduleOutputTypeDef definition

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

CanaryStatusTypeDef#

# CanaryStatusTypeDef usage example

from mypy_boto3_synthetics.type_defs import CanaryStatusTypeDef

def get_value() -> CanaryStatusTypeDef:
    return {
        "State": ...,
    }
# CanaryStatusTypeDef definition

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

CanaryTimelineTypeDef#

# CanaryTimelineTypeDef usage example

from mypy_boto3_synthetics.type_defs import CanaryTimelineTypeDef

def get_value() -> CanaryTimelineTypeDef:
    return {
        "Created": ...,
    }
# CanaryTimelineTypeDef definition

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

VpcConfigOutputTypeDef#

# VpcConfigOutputTypeDef usage example

from mypy_boto3_synthetics.type_defs import VpcConfigOutputTypeDef

def get_value() -> VpcConfigOutputTypeDef:
    return {
        "VpcId": ...,
    }
# VpcConfigOutputTypeDef definition

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

VpcConfigInputTypeDef#

# VpcConfigInputTypeDef usage example

from mypy_boto3_synthetics.type_defs import VpcConfigInputTypeDef

def get_value() -> VpcConfigInputTypeDef:
    return {
        "SubnetIds": ...,
    }
# VpcConfigInputTypeDef definition

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

CreateGroupRequestRequestTypeDef#

# CreateGroupRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import CreateGroupRequestRequestTypeDef

def get_value() -> CreateGroupRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# CreateGroupRequestRequestTypeDef definition

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

GroupTypeDef#

# GroupTypeDef usage example

from mypy_boto3_synthetics.type_defs import GroupTypeDef

def get_value() -> GroupTypeDef:
    return {
        "Id": ...,
    }
# 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 usage example

from mypy_boto3_synthetics.type_defs import DeleteCanaryRequestRequestTypeDef

def get_value() -> DeleteCanaryRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# DeleteCanaryRequestRequestTypeDef definition

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

DeleteGroupRequestRequestTypeDef#

# DeleteGroupRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import DeleteGroupRequestRequestTypeDef

def get_value() -> DeleteGroupRequestRequestTypeDef:
    return {
        "GroupIdentifier": ...,
    }
# DeleteGroupRequestRequestTypeDef definition

class DeleteGroupRequestRequestTypeDef(TypedDict):
    GroupIdentifier: str,

DescribeCanariesLastRunRequestRequestTypeDef#

# DescribeCanariesLastRunRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import DescribeCanariesLastRunRequestRequestTypeDef

def get_value() -> DescribeCanariesLastRunRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# DescribeCanariesLastRunRequestRequestTypeDef definition

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

DescribeCanariesRequestRequestTypeDef#

# DescribeCanariesRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import DescribeCanariesRequestRequestTypeDef

def get_value() -> DescribeCanariesRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# DescribeCanariesRequestRequestTypeDef definition

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

DescribeRuntimeVersionsRequestRequestTypeDef#

# DescribeRuntimeVersionsRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import DescribeRuntimeVersionsRequestRequestTypeDef

def get_value() -> DescribeRuntimeVersionsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# DescribeRuntimeVersionsRequestRequestTypeDef definition

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

RuntimeVersionTypeDef#

# RuntimeVersionTypeDef usage example

from mypy_boto3_synthetics.type_defs import RuntimeVersionTypeDef

def get_value() -> RuntimeVersionTypeDef:
    return {
        "VersionName": ...,
    }
# RuntimeVersionTypeDef definition

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

DisassociateResourceRequestRequestTypeDef#

# DisassociateResourceRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import DisassociateResourceRequestRequestTypeDef

def get_value() -> DisassociateResourceRequestRequestTypeDef:
    return {
        "GroupIdentifier": ...,
        "ResourceArn": ...,
    }
# DisassociateResourceRequestRequestTypeDef definition

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

GetCanaryRequestRequestTypeDef#

# GetCanaryRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import GetCanaryRequestRequestTypeDef

def get_value() -> GetCanaryRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# GetCanaryRequestRequestTypeDef definition

class GetCanaryRequestRequestTypeDef(TypedDict):
    Name: str,

GetCanaryRunsRequestRequestTypeDef#

# GetCanaryRunsRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import GetCanaryRunsRequestRequestTypeDef

def get_value() -> GetCanaryRunsRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# GetCanaryRunsRequestRequestTypeDef definition

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

GetGroupRequestRequestTypeDef#

# GetGroupRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import GetGroupRequestRequestTypeDef

def get_value() -> GetGroupRequestRequestTypeDef:
    return {
        "GroupIdentifier": ...,
    }
# GetGroupRequestRequestTypeDef definition

class GetGroupRequestRequestTypeDef(TypedDict):
    GroupIdentifier: str,

GroupSummaryTypeDef#

# GroupSummaryTypeDef usage example

from mypy_boto3_synthetics.type_defs import GroupSummaryTypeDef

def get_value() -> GroupSummaryTypeDef:
    return {
        "Id": ...,
    }
# GroupSummaryTypeDef definition

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

ListAssociatedGroupsRequestRequestTypeDef#

# ListAssociatedGroupsRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import ListAssociatedGroupsRequestRequestTypeDef

def get_value() -> ListAssociatedGroupsRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
# ListAssociatedGroupsRequestRequestTypeDef definition

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

ListGroupResourcesRequestRequestTypeDef#

# ListGroupResourcesRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import ListGroupResourcesRequestRequestTypeDef

def get_value() -> ListGroupResourcesRequestRequestTypeDef:
    return {
        "GroupIdentifier": ...,
    }
# ListGroupResourcesRequestRequestTypeDef definition

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

ListGroupResourcesResponseTypeDef#

# ListGroupResourcesResponseTypeDef usage example

from mypy_boto3_synthetics.type_defs import ListGroupResourcesResponseTypeDef

def get_value() -> ListGroupResourcesResponseTypeDef:
    return {
        "Resources": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListGroupResourcesResponseTypeDef definition

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

ListGroupsRequestRequestTypeDef#

# ListGroupsRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import ListGroupsRequestRequestTypeDef

def get_value() -> ListGroupsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListGroupsRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef usage example

from mypy_boto3_synthetics.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
# ListTagsForResourceResponseTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_synthetics.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

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

StartCanaryRequestRequestTypeDef#

# StartCanaryRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import StartCanaryRequestRequestTypeDef

def get_value() -> StartCanaryRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# StartCanaryRequestRequestTypeDef definition

class StartCanaryRequestRequestTypeDef(TypedDict):
    Name: str,

StopCanaryRequestRequestTypeDef#

# StopCanaryRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import StopCanaryRequestRequestTypeDef

def get_value() -> StopCanaryRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# StopCanaryRequestRequestTypeDef definition

class StopCanaryRequestRequestTypeDef(TypedDict):
    Name: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
    }
# TagResourceRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }
# UntagResourceRequestRequestTypeDef definition

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

ArtifactConfigInputTypeDef#

# ArtifactConfigInputTypeDef usage example

from mypy_boto3_synthetics.type_defs import ArtifactConfigInputTypeDef

def get_value() -> ArtifactConfigInputTypeDef:
    return {
        "S3Encryption": ...,
    }
# ArtifactConfigInputTypeDef definition

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

ArtifactConfigOutputTypeDef#

# ArtifactConfigOutputTypeDef usage example

from mypy_boto3_synthetics.type_defs import ArtifactConfigOutputTypeDef

def get_value() -> ArtifactConfigOutputTypeDef:
    return {
        "S3Encryption": ...,
    }
# ArtifactConfigOutputTypeDef definition

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

VisualReferenceInputTypeDef#

# VisualReferenceInputTypeDef usage example

from mypy_boto3_synthetics.type_defs import VisualReferenceInputTypeDef

def get_value() -> VisualReferenceInputTypeDef:
    return {
        "BaseCanaryRunId": ...,
    }
# VisualReferenceInputTypeDef definition

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

VisualReferenceOutputTypeDef#

# VisualReferenceOutputTypeDef usage example

from mypy_boto3_synthetics.type_defs import VisualReferenceOutputTypeDef

def get_value() -> VisualReferenceOutputTypeDef:
    return {
        "BaseScreenshots": ...,
    }
# VisualReferenceOutputTypeDef definition

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

CanaryRunTypeDef#

# CanaryRunTypeDef usage example

from mypy_boto3_synthetics.type_defs import CanaryRunTypeDef

def get_value() -> CanaryRunTypeDef:
    return {
        "Id": ...,
    }
# 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

CreateGroupResponseTypeDef#

# CreateGroupResponseTypeDef usage example

from mypy_boto3_synthetics.type_defs import CreateGroupResponseTypeDef

def get_value() -> CreateGroupResponseTypeDef:
    return {
        "Group": ...,
        "ResponseMetadata": ...,
    }
# CreateGroupResponseTypeDef definition

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

GetGroupResponseTypeDef#

# GetGroupResponseTypeDef usage example

from mypy_boto3_synthetics.type_defs import GetGroupResponseTypeDef

def get_value() -> GetGroupResponseTypeDef:
    return {
        "Group": ...,
        "ResponseMetadata": ...,
    }
# GetGroupResponseTypeDef definition

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

DescribeRuntimeVersionsResponseTypeDef#

# DescribeRuntimeVersionsResponseTypeDef usage example

from mypy_boto3_synthetics.type_defs import DescribeRuntimeVersionsResponseTypeDef

def get_value() -> DescribeRuntimeVersionsResponseTypeDef:
    return {
        "RuntimeVersions": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeRuntimeVersionsResponseTypeDef definition

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

ListAssociatedGroupsResponseTypeDef#

# ListAssociatedGroupsResponseTypeDef usage example

from mypy_boto3_synthetics.type_defs import ListAssociatedGroupsResponseTypeDef

def get_value() -> ListAssociatedGroupsResponseTypeDef:
    return {
        "Groups": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListAssociatedGroupsResponseTypeDef definition

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

ListGroupsResponseTypeDef#

# ListGroupsResponseTypeDef usage example

from mypy_boto3_synthetics.type_defs import ListGroupsResponseTypeDef

def get_value() -> ListGroupsResponseTypeDef:
    return {
        "Groups": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListGroupsResponseTypeDef definition

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

CreateCanaryRequestRequestTypeDef#

# CreateCanaryRequestRequestTypeDef usage example

from mypy_boto3_synthetics.type_defs import CreateCanaryRequestRequestTypeDef

def get_value() -> CreateCanaryRequestRequestTypeDef:
    return {
        "Name": ...,
        "Code": ...,
        "ArtifactS3Location": ...,
        "ExecutionRoleArn": ...,
        "Schedule": ...,
        "RuntimeVersion": ...,
    }
# 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 usage example

from mypy_boto3_synthetics.type_defs import UpdateCanaryRequestRequestTypeDef

def get_value() -> UpdateCanaryRequestRequestTypeDef:
    return {
        "Name": ...,
    }
# 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

CanaryTypeDef#

# CanaryTypeDef usage example

from mypy_boto3_synthetics.type_defs import CanaryTypeDef

def get_value() -> CanaryTypeDef:
    return {
        "Id": ...,
    }
# 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

CanaryLastRunTypeDef#

# CanaryLastRunTypeDef usage example

from mypy_boto3_synthetics.type_defs import CanaryLastRunTypeDef

def get_value() -> CanaryLastRunTypeDef:
    return {
        "CanaryName": ...,
    }
# CanaryLastRunTypeDef definition

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

GetCanaryRunsResponseTypeDef#

# GetCanaryRunsResponseTypeDef usage example

from mypy_boto3_synthetics.type_defs import GetCanaryRunsResponseTypeDef

def get_value() -> GetCanaryRunsResponseTypeDef:
    return {
        "CanaryRuns": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# GetCanaryRunsResponseTypeDef definition

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

CreateCanaryResponseTypeDef#

# CreateCanaryResponseTypeDef usage example

from mypy_boto3_synthetics.type_defs import CreateCanaryResponseTypeDef

def get_value() -> CreateCanaryResponseTypeDef:
    return {
        "Canary": ...,
        "ResponseMetadata": ...,
    }
# CreateCanaryResponseTypeDef definition

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

DescribeCanariesResponseTypeDef#

# DescribeCanariesResponseTypeDef usage example

from mypy_boto3_synthetics.type_defs import DescribeCanariesResponseTypeDef

def get_value() -> DescribeCanariesResponseTypeDef:
    return {
        "Canaries": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeCanariesResponseTypeDef definition

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

GetCanaryResponseTypeDef#

# GetCanaryResponseTypeDef usage example

from mypy_boto3_synthetics.type_defs import GetCanaryResponseTypeDef

def get_value() -> GetCanaryResponseTypeDef:
    return {
        "Canary": ...,
        "ResponseMetadata": ...,
    }
# GetCanaryResponseTypeDef definition

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

DescribeCanariesLastRunResponseTypeDef#

# DescribeCanariesLastRunResponseTypeDef usage example

from mypy_boto3_synthetics.type_defs import DescribeCanariesLastRunResponseTypeDef

def get_value() -> DescribeCanariesLastRunResponseTypeDef:
    return {
        "CanariesLastRun": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeCanariesLastRunResponseTypeDef definition

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