Skip to content

Synthetics Classes

ArtifactConfigInputTypeDef

S3Encryption

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.S3EncryptionConfigTypeDef]

ArtifactConfigOutputTypeDef

S3Encryption

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.S3EncryptionConfigTypeDef]

AssociateResourceRequestRequestTypeDef

GroupIdentifier

  • Type:
  • Required: Yes

ResourceArn

  • Type:
  • Required: Yes

BaseScreenshotTypeDef

ScreenshotName

  • Type:
  • Required: Yes

IgnoreCoordinates

  • Type: typing.Optional[typing.List[str]]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CanaryCodeInputTypeDef

Handler

  • Type:
  • Required: Yes

S3Bucket

  • Type: typing.Optional[str]

S3Key

  • Type: typing.Optional[str]

S3Version

  • Type: typing.Optional[str]

ZipFile

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], NoneType]

CanaryCodeOutputTypeDef

SourceLocationArn

  • Type: typing.Optional[str]

Handler

  • Type: typing.Optional[str]

CanaryLastRunTypeDef

CanaryName

  • Type: typing.Optional[str]

LastRun

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.CanaryRunTypeDef]

CanaryRunConfigInputTypeDef

TimeoutInSeconds

  • Type: typing.Optional[int]

MemoryInMB

  • Type: typing.Optional[int]

ActiveTracing

  • Type: typing.Optional[bool]

EnvironmentVariables

  • Type: typing.Optional[typing.Mapping[str, str]]

CanaryRunConfigOutputTypeDef

TimeoutInSeconds

  • Type: typing.Optional[int]

MemoryInMB

  • Type: typing.Optional[int]

ActiveTracing

  • Type: typing.Optional[bool]

CanaryRunStatusTypeDef

State

  • Type: typing.Optional[typing.Literal['FAILED', 'PASSED', 'RUNNING']]

StateReason

  • Type: typing.Optional[str]

StateReasonCode

  • Type: typing.Optional[typing.Literal['CANARY_FAILURE', 'EXECUTION_FAILURE']]

CanaryRunTimelineTypeDef

Started

  • Type: typing.Optional[datetime.datetime]

Completed

  • Type: typing.Optional[datetime.datetime]

CanaryRunTypeDef

Id

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.CanaryRunStatusTypeDef]

Timeline

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.CanaryRunTimelineTypeDef]

ArtifactS3Location

  • Type: typing.Optional[str]

CanaryScheduleInputTypeDef

Expression

  • Type:
  • Required: Yes

DurationInSeconds

  • Type: typing.Optional[int]

CanaryScheduleOutputTypeDef

Expression

  • Type: typing.Optional[str]

DurationInSeconds

  • Type: typing.Optional[int]

CanaryStatusTypeDef

State

  • Type: typing.Optional[typing.Literal['CREATING', 'DELETING', 'ERROR', 'READY', 'RUNNING', 'STARTING', 'STOPPED', 'STOPPING', 'UPDATING']]

StateReason

  • Type: typing.Optional[str]

StateReasonCode

  • Type: typing.Optional[typing.Literal['CREATE_FAILED', 'CREATE_IN_PROGRESS', 'CREATE_PENDING', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'INVALID_PERMISSIONS', 'ROLLBACK_COMPLETE', 'ROLLBACK_FAILED', 'SYNC_DELETE_IN_PROGRESS', 'UPDATE_COMPLETE', 'UPDATE_IN_PROGRESS', 'UPDATE_PENDING']]

CanaryTimelineTypeDef

Created

  • Type: typing.Optional[datetime.datetime]

LastModified

  • Type: typing.Optional[datetime.datetime]

LastStarted

  • Type: typing.Optional[datetime.datetime]

LastStopped

  • Type: typing.Optional[datetime.datetime]

CanaryTypeDef

Id

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

Code

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.CanaryCodeOutputTypeDef]

ExecutionRoleArn

  • Type: typing.Optional[str]

Schedule

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.CanaryScheduleOutputTypeDef]

RunConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.CanaryRunConfigOutputTypeDef]

SuccessRetentionPeriodInDays

  • Type: typing.Optional[int]

FailureRetentionPeriodInDays

  • Type: typing.Optional[int]

Status

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.CanaryStatusTypeDef]

Timeline

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.CanaryTimelineTypeDef]

ArtifactS3Location

  • Type: typing.Optional[str]

EngineArn

  • Type: typing.Optional[str]

RuntimeVersion

  • Type: typing.Optional[str]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.VpcConfigOutputTypeDef]

VisualReference

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.VisualReferenceOutputTypeDef]

Tags

  • Type: typing.Optional[typing.Dict[str, str]]

ArtifactConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.ArtifactConfigOutputTypeDef]

CreateCanaryRequestRequestTypeDef

Name

  • Type:
  • Required: Yes

Code

  • Type:
  • Required: Yes

ArtifactS3Location

  • Type:
  • Required: Yes

ExecutionRoleArn

  • Type:
  • Required: Yes

Schedule

  • Type:
  • Required: Yes

RuntimeVersion

  • Type:
  • Required: Yes

RunConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.CanaryRunConfigInputTypeDef]

SuccessRetentionPeriodInDays

  • Type: typing.Optional[int]

FailureRetentionPeriodInDays

  • Type: typing.Optional[int]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.VpcConfigInputTypeDef]

Tags

  • Type: typing.Optional[typing.Mapping[str, str]]

ArtifactConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.ArtifactConfigInputTypeDef]

CreateCanaryResponseTypeDef

Canary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateGroupRequestRequestTypeDef

Name

  • Type:
  • Required: Yes

Tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateGroupResponseTypeDef

Group

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteCanaryRequestRequestTypeDef

Name

  • Type:
  • Required: Yes

DeleteLambda

  • Type: typing.Optional[bool]

DeleteGroupRequestRequestTypeDef

GroupIdentifier

  • Type:
  • Required: Yes

DescribeCanariesLastRunRequestRequestTypeDef

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

Names

  • Type: typing.Optional[typing.Sequence[str]]

DescribeCanariesLastRunResponseTypeDef

CanariesLastRun

  • Type: typing.List[aws_resource_validator.pydantic_models.synthetics_classes.CanaryLastRunTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeCanariesRequestRequestTypeDef

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

Names

  • Type: typing.Optional[typing.Sequence[str]]

DescribeCanariesResponseTypeDef

Canaries

  • Type: typing.List[aws_resource_validator.pydantic_models.synthetics_classes.CanaryTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeRuntimeVersionsRequestRequestTypeDef

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

DescribeRuntimeVersionsResponseTypeDef

RuntimeVersions

  • Type: typing.List[aws_resource_validator.pydantic_models.synthetics_classes.RuntimeVersionTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DisassociateResourceRequestRequestTypeDef

GroupIdentifier

  • Type:
  • Required: Yes

ResourceArn

  • Type:
  • Required: Yes

GetCanaryRequestRequestTypeDef

Name

  • Type:
  • Required: Yes

GetCanaryResponseTypeDef

Canary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetCanaryRunsRequestRequestTypeDef

Name

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

GetCanaryRunsResponseTypeDef

CanaryRuns

  • Type: typing.List[aws_resource_validator.pydantic_models.synthetics_classes.CanaryRunTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetGroupRequestRequestTypeDef

GroupIdentifier

  • Type:
  • Required: Yes

GetGroupResponseTypeDef

Group

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GroupSummaryTypeDef

Id

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

Arn

  • Type: typing.Optional[str]

GroupTypeDef

Id

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

Arn

  • Type: typing.Optional[str]

Tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreatedTime

  • Type: typing.Optional[datetime.datetime]

LastModifiedTime

  • Type: typing.Optional[datetime.datetime]

ListAssociatedGroupsRequestRequestTypeDef

ResourceArn

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListAssociatedGroupsResponseTypeDef

Groups

  • Type: typing.List[aws_resource_validator.pydantic_models.synthetics_classes.GroupSummaryTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListGroupResourcesRequestRequestTypeDef

GroupIdentifier

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListGroupResourcesResponseTypeDef

Resources

  • Type: typing.List[str]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListGroupsRequestRequestTypeDef

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListGroupsResponseTypeDef

Groups

  • Type: typing.List[aws_resource_validator.pydantic_models.synthetics_classes.GroupSummaryTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTagsForResourceRequestRequestTypeDef

ResourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponseTypeDef

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HostId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

RuntimeVersionTypeDef

VersionName

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

ReleaseDate

  • Type: typing.Optional[datetime.datetime]

DeprecationDate

  • Type: typing.Optional[datetime.datetime]

S3EncryptionConfigTypeDef

EncryptionMode

  • Type: typing.Optional[typing.Literal['SSE_KMS', 'SSE_S3']]

KmsKeyArn

  • Type: typing.Optional[str]

StartCanaryRequestRequestTypeDef

Name

  • Type:
  • Required: Yes

StopCanaryRequestRequestTypeDef

Name

  • Type:
  • Required: Yes

TagResourceRequestRequestTypeDef

ResourceArn

  • Type:
  • Required: Yes

Tags

  • Type: typing.Mapping[str, str]
  • Required: Yes

UntagResourceRequestRequestTypeDef

ResourceArn

  • Type:
  • Required: Yes

TagKeys

  • Type: typing.Sequence[str]
  • Required: Yes

UpdateCanaryRequestRequestTypeDef

Name

  • Type:
  • Required: Yes

Code

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.CanaryCodeInputTypeDef]

ExecutionRoleArn

  • Type: typing.Optional[str]

RuntimeVersion

  • Type: typing.Optional[str]

Schedule

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.CanaryScheduleInputTypeDef]

RunConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.CanaryRunConfigInputTypeDef]

SuccessRetentionPeriodInDays

  • Type: typing.Optional[int]

FailureRetentionPeriodInDays

  • Type: typing.Optional[int]

VpcConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.VpcConfigInputTypeDef]

VisualReference

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.VisualReferenceInputTypeDef]

ArtifactS3Location

  • Type: typing.Optional[str]

ArtifactConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.synthetics_classes.ArtifactConfigInputTypeDef]

VisualReferenceInputTypeDef

BaseCanaryRunId

  • Type:
  • Required: Yes

BaseScreenshots

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.synthetics_classes.BaseScreenshotTypeDef]]

VisualReferenceOutputTypeDef

BaseScreenshots

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.synthetics_classes.BaseScreenshotTypeDef]]

BaseCanaryRunId

  • Type: typing.Optional[str]

VpcConfigInputTypeDef

SubnetIds

  • Type: typing.Optional[typing.Sequence[str]]

SecurityGroupIds

  • Type: typing.Optional[typing.Sequence[str]]

VpcConfigOutputTypeDef

VpcId

  • Type: typing.Optional[str]

SubnetIds

  • Type: typing.Optional[typing.List[str]]

SecurityGroupIds

  • Type: typing.Optional[typing.List[str]]