Typed dictionaries

Index > Synthetics > Typed dictionaries

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

S3EncryptionConfigTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import S3EncryptionConfigTypeDef

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

Definition

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

1. See EncryptionModeType

AssociateResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import AssociateResourceRequestRequestTypeDef

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

Definition

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

BaseScreenshotTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import BaseScreenshotTypeDef

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

Definition

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

CanaryCodeInputTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import CanaryCodeInputTypeDef

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

Definition

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

CanaryCodeOutputTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import CanaryCodeOutputTypeDef

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

Definition

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

CanaryRunConfigInputTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import CanaryRunConfigInputTypeDef

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

Definition

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

CanaryRunConfigOutputTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import CanaryRunConfigOutputTypeDef

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

Definition

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

CanaryRunStatusTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import CanaryRunStatusTypeDef

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

Definition

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

1. See CanaryRunStateType
2. See CanaryRunStateReasonCodeType

CanaryRunTimelineTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import CanaryRunTimelineTypeDef

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

Definition

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

CanaryScheduleInputTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import CanaryScheduleInputTypeDef

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

Definition

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

CanaryScheduleOutputTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import CanaryScheduleOutputTypeDef

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

Definition

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

CanaryStatusTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import CanaryStatusTypeDef

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

Definition

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

1. See CanaryStateType
2. See CanaryStateReasonCodeType

CanaryTimelineTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import CanaryTimelineTypeDef

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

Definition

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

VpcConfigOutputTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import VpcConfigOutputTypeDef

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

Definition

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

VpcConfigInputTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import VpcConfigInputTypeDef

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

Definition

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

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_synthetics.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,

CreateGroupRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import CreateGroupRequestRequestTypeDef

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

Definition

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

GroupTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import GroupTypeDef

def get_value() -> GroupTypeDef:
    return {
        "Id": ...,
    }

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

Usage Example

from mypy_boto3_synthetics.type_defs import DeleteCanaryRequestRequestTypeDef

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

Definition

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

DeleteGroupRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import DeleteGroupRequestRequestTypeDef

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

Definition

class DeleteGroupRequestRequestTypeDef(TypedDict):
    GroupIdentifier: str,

DescribeCanariesLastRunRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import DescribeCanariesLastRunRequestRequestTypeDef

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

Definition

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

DescribeCanariesRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import DescribeCanariesRequestRequestTypeDef

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

Definition

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

DescribeRuntimeVersionsRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import DescribeRuntimeVersionsRequestRequestTypeDef

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

Definition

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

RuntimeVersionTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import RuntimeVersionTypeDef

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

Definition

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

DisassociateResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import DisassociateResourceRequestRequestTypeDef

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

Definition

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

GetCanaryRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import GetCanaryRequestRequestTypeDef

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

Definition

class GetCanaryRequestRequestTypeDef(TypedDict):
    Name: str,

GetCanaryRunsRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import GetCanaryRunsRequestRequestTypeDef

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

Definition

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

GetGroupRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import GetGroupRequestRequestTypeDef

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

Definition

class GetGroupRequestRequestTypeDef(TypedDict):
    GroupIdentifier: str,

GroupSummaryTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import GroupSummaryTypeDef

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

Definition

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

ListAssociatedGroupsRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import ListAssociatedGroupsRequestRequestTypeDef

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

Definition

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

ListGroupResourcesRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import ListGroupResourcesRequestRequestTypeDef

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

Definition

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

ListGroupsRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import ListGroupsRequestRequestTypeDef

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

Definition

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

ListTagsForResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import ListTagsForResourceRequestRequestTypeDef

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

Definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

StartCanaryRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import StartCanaryRequestRequestTypeDef

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

Definition

class StartCanaryRequestRequestTypeDef(TypedDict):
    Name: str,

StopCanaryRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import StopCanaryRequestRequestTypeDef

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

Definition

class StopCanaryRequestRequestTypeDef(TypedDict):
    Name: str,

TagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import TagResourceRequestRequestTypeDef

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

Definition

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

UntagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import UntagResourceRequestRequestTypeDef

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

Definition

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

ArtifactConfigInputTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import ArtifactConfigInputTypeDef

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

Definition

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

1. See S3EncryptionConfigTypeDef

ArtifactConfigOutputTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import ArtifactConfigOutputTypeDef

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

Definition

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

1. See S3EncryptionConfigTypeDef

VisualReferenceInputTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import VisualReferenceInputTypeDef

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

Definition

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

1. See BaseScreenshotTypeDef

VisualReferenceOutputTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import VisualReferenceOutputTypeDef

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

Definition

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

1. See BaseScreenshotTypeDef

CanaryRunTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import CanaryRunTypeDef

def get_value() -> CanaryRunTypeDef:
    return {
        "Id": ...,
    }

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

Usage Example

from mypy_boto3_synthetics.type_defs import ListGroupResourcesResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import ListTagsForResourceResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

CreateGroupResponseTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import CreateGroupResponseTypeDef

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

Definition

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

1. See GroupTypeDef
2. See ResponseMetadataTypeDef

GetGroupResponseTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import GetGroupResponseTypeDef

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

Definition

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

1. See GroupTypeDef
2. See ResponseMetadataTypeDef

DescribeRuntimeVersionsResponseTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import DescribeRuntimeVersionsResponseTypeDef

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

Definition

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

1. See RuntimeVersionTypeDef
2. See ResponseMetadataTypeDef

ListAssociatedGroupsResponseTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import ListAssociatedGroupsResponseTypeDef

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

Definition

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

1. See GroupSummaryTypeDef
2. See ResponseMetadataTypeDef

ListGroupsResponseTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import ListGroupsResponseTypeDef

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

Definition

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

1. See GroupSummaryTypeDef
2. See ResponseMetadataTypeDef

CreateCanaryRequestRequestTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import CreateCanaryRequestRequestTypeDef

def get_value() -> CreateCanaryRequestRequestTypeDef:
    return {
        "Name": ...,
        "Code": ...,
        "ArtifactS3Location": ...,
        "ExecutionRoleArn": ...,
        "Schedule": ...,
        "RuntimeVersion": ...,
    }

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

Usage Example

from mypy_boto3_synthetics.type_defs import UpdateCanaryRequestRequestTypeDef

def get_value() -> UpdateCanaryRequestRequestTypeDef:
    return {
        "Name": ...,
    }

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

Usage Example

from mypy_boto3_synthetics.type_defs import CanaryTypeDef

def get_value() -> CanaryTypeDef:
    return {
        "Id": ...,
    }

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

Usage Example

from mypy_boto3_synthetics.type_defs import CanaryLastRunTypeDef

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

Definition

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

1. See CanaryRunTypeDef

GetCanaryRunsResponseTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import GetCanaryRunsResponseTypeDef

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

Definition

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

1. See CanaryRunTypeDef
2. See ResponseMetadataTypeDef

CreateCanaryResponseTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import CreateCanaryResponseTypeDef

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

Definition

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

1. See CanaryTypeDef
2. See ResponseMetadataTypeDef

DescribeCanariesResponseTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import DescribeCanariesResponseTypeDef

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

Definition

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

1. See CanaryTypeDef
2. See ResponseMetadataTypeDef

GetCanaryResponseTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import GetCanaryResponseTypeDef

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

Definition

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

1. See CanaryTypeDef
2. See ResponseMetadataTypeDef

DescribeCanariesLastRunResponseTypeDef

Usage Example

from mypy_boto3_synthetics.type_defs import DescribeCanariesLastRunResponseTypeDef

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

Definition

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

1. See CanaryLastRunTypeDef
2. See ResponseMetadataTypeDef