Skip to content

Type definitions#

Index > Synthetics > Type definitions

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

BlobTypeDef#

# BlobTypeDef Union usage example

from types_boto3_synthetics.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

BaseScreenshotUnionTypeDef#

# BaseScreenshotUnionTypeDef Union usage example

from types_boto3_synthetics.type_defs import BaseScreenshotUnionTypeDef


def get_value() -> BaseScreenshotUnionTypeDef:
    return ...


# BaseScreenshotUnionTypeDef definition

BaseScreenshotUnionTypeDef = Union[
    BaseScreenshotTypeDef,  # (1)
    BaseScreenshotOutputTypeDef,  # (2)
]
  1. See BaseScreenshotTypeDef
  2. See BaseScreenshotOutputTypeDef

S3EncryptionConfigTypeDef#

# S3EncryptionConfigTypeDef TypedDict usage example

from types_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

AssociateResourceRequestTypeDef#

# AssociateResourceRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import AssociateResourceRequestTypeDef


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


# AssociateResourceRequestTypeDef definition

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

BaseScreenshotOutputTypeDef#

# BaseScreenshotOutputTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import BaseScreenshotOutputTypeDef


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


# BaseScreenshotOutputTypeDef definition

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

BaseScreenshotTypeDef#

# BaseScreenshotTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import BaseScreenshotTypeDef


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


# BaseScreenshotTypeDef definition

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

BrowserConfigTypeDef#

# BrowserConfigTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import BrowserConfigTypeDef


def get_value() -> BrowserConfigTypeDef:
    return {
        "BrowserType": ...,
    }


# BrowserConfigTypeDef definition

class BrowserConfigTypeDef(TypedDict):
    BrowserType: NotRequired[BrowserTypeType],  # (1)
  1. See BrowserTypeType

DependencyTypeDef#

# DependencyTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import DependencyTypeDef


def get_value() -> DependencyTypeDef:
    return {
        "Type": ...,
    }


# DependencyTypeDef definition

class DependencyTypeDef(TypedDict):
    Reference: str,
    Type: NotRequired[DependencyTypeType],  # (1)
  1. See DependencyTypeType

CanaryDryRunConfigOutputTypeDef#

# CanaryDryRunConfigOutputTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import CanaryDryRunConfigOutputTypeDef


def get_value() -> CanaryDryRunConfigOutputTypeDef:
    return {
        "DryRunId": ...,
    }


# CanaryDryRunConfigOutputTypeDef definition

class CanaryDryRunConfigOutputTypeDef(TypedDict):
    DryRunId: NotRequired[str],

CanaryRunConfigInputTypeDef#

# CanaryRunConfigInputTypeDef TypedDict usage example

from types_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]],
    EphemeralStorage: NotRequired[int],

CanaryRunConfigOutputTypeDef#

# CanaryRunConfigOutputTypeDef TypedDict usage example

from types_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],
    EphemeralStorage: NotRequired[int],

CanaryRunStatusTypeDef#

# CanaryRunStatusTypeDef TypedDict usage example

from types_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)
    TestResult: NotRequired[CanaryRunTestResultType],  # (3)
  1. See CanaryRunStateType
  2. See CanaryRunStateReasonCodeType
  3. See CanaryRunTestResultType

CanaryRunTimelineTypeDef#

# CanaryRunTimelineTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import CanaryRunTimelineTypeDef


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


# CanaryRunTimelineTypeDef definition

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

RetryConfigInputTypeDef#

# RetryConfigInputTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import RetryConfigInputTypeDef


def get_value() -> RetryConfigInputTypeDef:
    return {
        "MaxRetries": ...,
    }


# RetryConfigInputTypeDef definition

class RetryConfigInputTypeDef(TypedDict):
    MaxRetries: int,

RetryConfigOutputTypeDef#

# RetryConfigOutputTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import RetryConfigOutputTypeDef


def get_value() -> RetryConfigOutputTypeDef:
    return {
        "MaxRetries": ...,
    }


# RetryConfigOutputTypeDef definition

class RetryConfigOutputTypeDef(TypedDict):
    MaxRetries: NotRequired[int],

CanaryStatusTypeDef#

# CanaryStatusTypeDef TypedDict usage example

from types_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 TypedDict usage example

from types_boto3_synthetics.type_defs import CanaryTimelineTypeDef


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


# CanaryTimelineTypeDef definition

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

DryRunConfigOutputTypeDef#

# DryRunConfigOutputTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import DryRunConfigOutputTypeDef


def get_value() -> DryRunConfigOutputTypeDef:
    return {
        "DryRunId": ...,
    }


# DryRunConfigOutputTypeDef definition

class DryRunConfigOutputTypeDef(TypedDict):
    DryRunId: NotRequired[str],
    LastDryRunExecutionStatus: NotRequired[str],

EngineConfigTypeDef#

# EngineConfigTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import EngineConfigTypeDef


def get_value() -> EngineConfigTypeDef:
    return {
        "EngineArn": ...,
    }


# EngineConfigTypeDef definition

class EngineConfigTypeDef(TypedDict):
    EngineArn: NotRequired[str],
    BrowserType: NotRequired[BrowserTypeType],  # (1)
  1. See BrowserTypeType

VpcConfigOutputTypeDef#

# VpcConfigOutputTypeDef TypedDict usage example

from types_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]],
    Ipv6AllowedForDualStack: NotRequired[bool],

VpcConfigInputTypeDef#

# VpcConfigInputTypeDef TypedDict usage example

from types_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]],
    Ipv6AllowedForDualStack: NotRequired[bool],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

CreateGroupRequestTypeDef#

# CreateGroupRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import CreateGroupRequestTypeDef


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


# CreateGroupRequestTypeDef definition

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

GroupTypeDef#

# GroupTypeDef TypedDict usage example

from types_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.datetime],
    LastModifiedTime: NotRequired[datetime.datetime],

DeleteCanaryRequestTypeDef#

# DeleteCanaryRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import DeleteCanaryRequestTypeDef


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


# DeleteCanaryRequestTypeDef definition

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

DeleteGroupRequestTypeDef#

# DeleteGroupRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import DeleteGroupRequestTypeDef


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


# DeleteGroupRequestTypeDef definition

class DeleteGroupRequestTypeDef(TypedDict):
    GroupIdentifier: str,

DescribeCanariesLastRunRequestTypeDef#

# DescribeCanariesLastRunRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import DescribeCanariesLastRunRequestTypeDef


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


# DescribeCanariesLastRunRequestTypeDef definition

class DescribeCanariesLastRunRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Names: NotRequired[Sequence[str]],
    BrowserType: NotRequired[BrowserTypeType],  # (1)
  1. See BrowserTypeType

DescribeCanariesRequestTypeDef#

# DescribeCanariesRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import DescribeCanariesRequestTypeDef


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


# DescribeCanariesRequestTypeDef definition

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

DescribeRuntimeVersionsRequestTypeDef#

# DescribeRuntimeVersionsRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import DescribeRuntimeVersionsRequestTypeDef


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


# DescribeRuntimeVersionsRequestTypeDef definition

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

RuntimeVersionTypeDef#

# RuntimeVersionTypeDef TypedDict usage example

from types_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.datetime],
    DeprecationDate: NotRequired[datetime.datetime],

DisassociateResourceRequestTypeDef#

# DisassociateResourceRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import DisassociateResourceRequestTypeDef


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


# DisassociateResourceRequestTypeDef definition

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

GetCanaryRequestTypeDef#

# GetCanaryRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import GetCanaryRequestTypeDef


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


# GetCanaryRequestTypeDef definition

class GetCanaryRequestTypeDef(TypedDict):
    Name: str,
    DryRunId: NotRequired[str],

GetCanaryRunsRequestTypeDef#

# GetCanaryRunsRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import GetCanaryRunsRequestTypeDef


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


# GetCanaryRunsRequestTypeDef definition

class GetCanaryRunsRequestTypeDef(TypedDict):
    Name: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    DryRunId: NotRequired[str],
    RunType: NotRequired[RunTypeType],  # (1)
  1. See RunTypeType

GetGroupRequestTypeDef#

# GetGroupRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import GetGroupRequestTypeDef


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


# GetGroupRequestTypeDef definition

class GetGroupRequestTypeDef(TypedDict):
    GroupIdentifier: str,

GroupSummaryTypeDef#

# GroupSummaryTypeDef TypedDict usage example

from types_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],

ListAssociatedGroupsRequestTypeDef#

# ListAssociatedGroupsRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import ListAssociatedGroupsRequestTypeDef


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


# ListAssociatedGroupsRequestTypeDef definition

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

ListGroupResourcesRequestTypeDef#

# ListGroupResourcesRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import ListGroupResourcesRequestTypeDef


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


# ListGroupResourcesRequestTypeDef definition

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

ListGroupsRequestTypeDef#

# ListGroupsRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import ListGroupsRequestTypeDef


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


# ListGroupsRequestTypeDef definition

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

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import ListTagsForResourceRequestTypeDef


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


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    ResourceArn: str,

StartCanaryRequestTypeDef#

# StartCanaryRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import StartCanaryRequestTypeDef


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


# StartCanaryRequestTypeDef definition

class StartCanaryRequestTypeDef(TypedDict):
    Name: str,

StopCanaryRequestTypeDef#

# StopCanaryRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import StopCanaryRequestTypeDef


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


# StopCanaryRequestTypeDef definition

class StopCanaryRequestTypeDef(TypedDict):
    Name: str,

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import TagResourceRequestTypeDef


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


# TagResourceRequestTypeDef definition

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

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import UntagResourceRequestTypeDef


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


# UntagResourceRequestTypeDef definition

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

ArtifactConfigInputTypeDef#

# ArtifactConfigInputTypeDef TypedDict usage example

from types_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 TypedDict usage example

from types_boto3_synthetics.type_defs import ArtifactConfigOutputTypeDef


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


# ArtifactConfigOutputTypeDef definition

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

VisualReferenceOutputTypeDef#

# VisualReferenceOutputTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import VisualReferenceOutputTypeDef


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


# VisualReferenceOutputTypeDef definition

class VisualReferenceOutputTypeDef(TypedDict):
    BaseScreenshots: NotRequired[List[BaseScreenshotOutputTypeDef]],  # (1)
    BaseCanaryRunId: NotRequired[str],
    BrowserType: NotRequired[BrowserTypeType],  # (2)
  1. See List[BaseScreenshotOutputTypeDef]
  2. See BrowserTypeType

CanaryCodeInputTypeDef#

# CanaryCodeInputTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import CanaryCodeInputTypeDef


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


# CanaryCodeInputTypeDef definition

class CanaryCodeInputTypeDef(TypedDict):
    S3Bucket: NotRequired[str],
    S3Key: NotRequired[str],
    S3Version: NotRequired[str],
    ZipFile: NotRequired[BlobTypeDef],
    Handler: NotRequired[str],
    BlueprintTypes: NotRequired[Sequence[str]],
    Dependencies: NotRequired[Sequence[DependencyTypeDef]],  # (1)
  1. See Sequence[DependencyTypeDef]

CanaryCodeOutputTypeDef#

# CanaryCodeOutputTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import CanaryCodeOutputTypeDef


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


# CanaryCodeOutputTypeDef definition

class CanaryCodeOutputTypeDef(TypedDict):
    SourceLocationArn: NotRequired[str],
    Handler: NotRequired[str],
    BlueprintTypes: NotRequired[List[str]],
    Dependencies: NotRequired[List[DependencyTypeDef]],  # (1)
  1. See List[DependencyTypeDef]

CanaryRunTypeDef#

# CanaryRunTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import CanaryRunTypeDef


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


# CanaryRunTypeDef definition

class CanaryRunTypeDef(TypedDict):
    Id: NotRequired[str],
    ScheduledRunId: NotRequired[str],
    RetryAttempt: NotRequired[int],
    Name: NotRequired[str],
    Status: NotRequired[CanaryRunStatusTypeDef],  # (1)
    Timeline: NotRequired[CanaryRunTimelineTypeDef],  # (2)
    ArtifactS3Location: NotRequired[str],
    DryRunConfig: NotRequired[CanaryDryRunConfigOutputTypeDef],  # (3)
    BrowserType: NotRequired[BrowserTypeType],  # (4)
  1. See CanaryRunStatusTypeDef
  2. See CanaryRunTimelineTypeDef
  3. See CanaryDryRunConfigOutputTypeDef
  4. See BrowserTypeType

CanaryScheduleInputTypeDef#

# CanaryScheduleInputTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import CanaryScheduleInputTypeDef


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


# CanaryScheduleInputTypeDef definition

class CanaryScheduleInputTypeDef(TypedDict):
    Expression: str,
    DurationInSeconds: NotRequired[int],
    RetryConfig: NotRequired[RetryConfigInputTypeDef],  # (1)
  1. See RetryConfigInputTypeDef

CanaryScheduleOutputTypeDef#

# CanaryScheduleOutputTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import CanaryScheduleOutputTypeDef


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


# CanaryScheduleOutputTypeDef definition

class CanaryScheduleOutputTypeDef(TypedDict):
    Expression: NotRequired[str],
    DurationInSeconds: NotRequired[int],
    RetryConfig: NotRequired[RetryConfigOutputTypeDef],  # (1)
  1. See RetryConfigOutputTypeDef

ListGroupResourcesResponseTypeDef#

# ListGroupResourcesResponseTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import ListGroupResourcesResponseTypeDef


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


# ListGroupResourcesResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import ListTagsForResourceResponseTypeDef


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


# ListTagsForResourceResponseTypeDef definition

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

StartCanaryDryRunResponseTypeDef#

# StartCanaryDryRunResponseTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import StartCanaryDryRunResponseTypeDef


def get_value() -> StartCanaryDryRunResponseTypeDef:
    return {
        "DryRunConfig": ...,
    }


# StartCanaryDryRunResponseTypeDef definition

class StartCanaryDryRunResponseTypeDef(TypedDict):
    DryRunConfig: DryRunConfigOutputTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DryRunConfigOutputTypeDef
  2. See ResponseMetadataTypeDef

CreateGroupResponseTypeDef#

# CreateGroupResponseTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import CreateGroupResponseTypeDef


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


# CreateGroupResponseTypeDef definition

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

GetGroupResponseTypeDef#

# GetGroupResponseTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import GetGroupResponseTypeDef


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


# GetGroupResponseTypeDef definition

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

DescribeRuntimeVersionsResponseTypeDef#

# DescribeRuntimeVersionsResponseTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import DescribeRuntimeVersionsResponseTypeDef


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


# DescribeRuntimeVersionsResponseTypeDef definition

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

ListAssociatedGroupsResponseTypeDef#

# ListAssociatedGroupsResponseTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import ListAssociatedGroupsResponseTypeDef


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


# ListAssociatedGroupsResponseTypeDef definition

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

ListGroupsResponseTypeDef#

# ListGroupsResponseTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import ListGroupsResponseTypeDef


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


# ListGroupsResponseTypeDef definition

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

VisualReferenceInputTypeDef#

# VisualReferenceInputTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import VisualReferenceInputTypeDef


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


# VisualReferenceInputTypeDef definition

class VisualReferenceInputTypeDef(TypedDict):
    BaseCanaryRunId: str,
    BaseScreenshots: NotRequired[Sequence[BaseScreenshotUnionTypeDef]],  # (1)
    BrowserType: NotRequired[BrowserTypeType],  # (2)
  1. See Sequence[BaseScreenshotUnionTypeDef]
  2. See BrowserTypeType

CanaryLastRunTypeDef#

# CanaryLastRunTypeDef TypedDict usage example

from types_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 TypedDict usage example

from types_boto3_synthetics.type_defs import GetCanaryRunsResponseTypeDef


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


# GetCanaryRunsResponseTypeDef definition

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

CreateCanaryRequestTypeDef#

# CreateCanaryRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import CreateCanaryRequestTypeDef


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


# CreateCanaryRequestTypeDef definition

class CreateCanaryRequestTypeDef(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)
    ResourcesToReplicateTags: NotRequired[Sequence[ResourceToTagType]],  # (5)
    ProvisionedResourceCleanup: NotRequired[ProvisionedResourceCleanupSettingType],  # (6)
    BrowserConfigs: NotRequired[Sequence[BrowserConfigTypeDef]],  # (7)
    Tags: NotRequired[Mapping[str, str]],
    ArtifactConfig: NotRequired[ArtifactConfigInputTypeDef],  # (8)
  1. See CanaryCodeInputTypeDef
  2. See CanaryScheduleInputTypeDef
  3. See CanaryRunConfigInputTypeDef
  4. See VpcConfigInputTypeDef
  5. See Sequence[Literal['lambda-function']]
  6. See ProvisionedResourceCleanupSettingType
  7. See Sequence[BrowserConfigTypeDef]
  8. See ArtifactConfigInputTypeDef

CanaryTypeDef#

# CanaryTypeDef TypedDict usage example

from types_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)
    ProvisionedResourceCleanup: NotRequired[ProvisionedResourceCleanupSettingType],  # (8)
    BrowserConfigs: NotRequired[List[BrowserConfigTypeDef]],  # (9)
    EngineConfigs: NotRequired[List[EngineConfigTypeDef]],  # (10)
    VisualReferences: NotRequired[List[VisualReferenceOutputTypeDef]],  # (11)
    Tags: NotRequired[Dict[str, str]],
    ArtifactConfig: NotRequired[ArtifactConfigOutputTypeDef],  # (12)
    DryRunConfig: NotRequired[DryRunConfigOutputTypeDef],  # (13)
  1. See CanaryCodeOutputTypeDef
  2. See CanaryScheduleOutputTypeDef
  3. See CanaryRunConfigOutputTypeDef
  4. See CanaryStatusTypeDef
  5. See CanaryTimelineTypeDef
  6. See VpcConfigOutputTypeDef
  7. See VisualReferenceOutputTypeDef
  8. See ProvisionedResourceCleanupSettingType
  9. See List[BrowserConfigTypeDef]
  10. See List[EngineConfigTypeDef]
  11. See List[VisualReferenceOutputTypeDef]
  12. See ArtifactConfigOutputTypeDef
  13. See DryRunConfigOutputTypeDef

StartCanaryDryRunRequestTypeDef#

# StartCanaryDryRunRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import StartCanaryDryRunRequestTypeDef


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


# StartCanaryDryRunRequestTypeDef definition

class StartCanaryDryRunRequestTypeDef(TypedDict):
    Name: str,
    Code: NotRequired[CanaryCodeInputTypeDef],  # (1)
    RuntimeVersion: NotRequired[str],
    RunConfig: NotRequired[CanaryRunConfigInputTypeDef],  # (2)
    VpcConfig: NotRequired[VpcConfigInputTypeDef],  # (3)
    ExecutionRoleArn: NotRequired[str],
    SuccessRetentionPeriodInDays: NotRequired[int],
    FailureRetentionPeriodInDays: NotRequired[int],
    VisualReference: NotRequired[VisualReferenceInputTypeDef],  # (4)
    ArtifactS3Location: NotRequired[str],
    ArtifactConfig: NotRequired[ArtifactConfigInputTypeDef],  # (5)
    ProvisionedResourceCleanup: NotRequired[ProvisionedResourceCleanupSettingType],  # (6)
    BrowserConfigs: NotRequired[Sequence[BrowserConfigTypeDef]],  # (7)
    VisualReferences: NotRequired[Sequence[VisualReferenceInputTypeDef]],  # (8)
  1. See CanaryCodeInputTypeDef
  2. See CanaryRunConfigInputTypeDef
  3. See VpcConfigInputTypeDef
  4. See VisualReferenceInputTypeDef
  5. See ArtifactConfigInputTypeDef
  6. See ProvisionedResourceCleanupSettingType
  7. See Sequence[BrowserConfigTypeDef]
  8. See Sequence[VisualReferenceInputTypeDef]

UpdateCanaryRequestTypeDef#

# UpdateCanaryRequestTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import UpdateCanaryRequestTypeDef


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


# UpdateCanaryRequestTypeDef definition

class UpdateCanaryRequestTypeDef(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)
    ProvisionedResourceCleanup: NotRequired[ProvisionedResourceCleanupSettingType],  # (7)
    DryRunId: NotRequired[str],
    VisualReferences: NotRequired[Sequence[VisualReferenceInputTypeDef]],  # (8)
    BrowserConfigs: NotRequired[Sequence[BrowserConfigTypeDef]],  # (9)
  1. See CanaryCodeInputTypeDef
  2. See CanaryScheduleInputTypeDef
  3. See CanaryRunConfigInputTypeDef
  4. See VpcConfigInputTypeDef
  5. See VisualReferenceInputTypeDef
  6. See ArtifactConfigInputTypeDef
  7. See ProvisionedResourceCleanupSettingType
  8. See Sequence[VisualReferenceInputTypeDef]
  9. See Sequence[BrowserConfigTypeDef]

DescribeCanariesLastRunResponseTypeDef#

# DescribeCanariesLastRunResponseTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import DescribeCanariesLastRunResponseTypeDef


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


# DescribeCanariesLastRunResponseTypeDef definition

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

CreateCanaryResponseTypeDef#

# CreateCanaryResponseTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import CreateCanaryResponseTypeDef


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


# CreateCanaryResponseTypeDef definition

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

DescribeCanariesResponseTypeDef#

# DescribeCanariesResponseTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import DescribeCanariesResponseTypeDef


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


# DescribeCanariesResponseTypeDef definition

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

GetCanaryResponseTypeDef#

# GetCanaryResponseTypeDef TypedDict usage example

from types_boto3_synthetics.type_defs import GetCanaryResponseTypeDef


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


# GetCanaryResponseTypeDef definition

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