AssociateResource

$result = $client->associateResource([/* ... */]);
$promise = $client->associateResourceAsync([/* ... */]);

Associates a canary with a group. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.

You must run this operation in the Region where the canary exists.

Parameter Syntax

$result = $client->associateResource([
    'GroupIdentifier' => '<string>', // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

ResourceNotFoundException:

One of the specified resources was not found.

ConflictException:

A conflicting operation is already in progress.

ServiceQuotaExceededException:

The request exceeded a service quota value.

CreateCanary

$result = $client->createCanary([/* ... */]);
$promise = $client->createCanaryAsync([/* ... */]);

Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.

Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead.

To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

Parameter Syntax

$result = $client->createCanary([
    'ArtifactConfig' => [
        'S3Encryption' => [
            'EncryptionMode' => 'SSE_S3|SSE_KMS',
            'KmsKeyArn' => '<string>',
        ],
    ],
    'ArtifactS3Location' => '<string>', // REQUIRED
    'BrowserConfigs' => [
        [
            'BrowserType' => 'CHROME|FIREFOX',
        ],
        // ...
    ],
    'Code' => [ // REQUIRED
        'BlueprintTypes' => ['<string>', ...],
        'Dependencies' => [
            [
                'Reference' => '<string>', // REQUIRED
                'Type' => 'LambdaLayer',
            ],
            // ...
        ],
        'Handler' => '<string>',
        'S3Bucket' => '<string>',
        'S3Key' => '<string>',
        'S3Version' => '<string>',
        'ZipFile' => <string || resource || Psr\Http\Message\StreamInterface>,
    ],
    'ExecutionRoleArn' => '<string>', // REQUIRED
    'FailureRetentionPeriodInDays' => <integer>,
    'Name' => '<string>', // REQUIRED
    'ProvisionedResourceCleanup' => 'AUTOMATIC|OFF',
    'ResourcesToReplicateTags' => ['<string>', ...],
    'RunConfig' => [
        'ActiveTracing' => true || false,
        'EnvironmentVariables' => ['<string>', ...],
        'EphemeralStorage' => <integer>,
        'MemoryInMB' => <integer>,
        'TimeoutInSeconds' => <integer>,
    ],
    'RuntimeVersion' => '<string>', // REQUIRED
    'Schedule' => [ // REQUIRED
        'DurationInSeconds' => <integer>,
        'Expression' => '<string>', // REQUIRED
        'RetryConfig' => [
            'MaxRetries' => <integer>, // REQUIRED
        ],
    ],
    'SuccessRetentionPeriodInDays' => <integer>,
    'Tags' => ['<string>', ...],
    'VpcConfig' => [
        'Ipv6AllowedForDualStack' => true || false,
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'Canary' => [
        'ArtifactConfig' => [
            'S3Encryption' => [
                'EncryptionMode' => 'SSE_S3|SSE_KMS',
                'KmsKeyArn' => '<string>',
            ],
        ],
        'ArtifactS3Location' => '<string>',
        'BrowserConfigs' => [
            [
                'BrowserType' => 'CHROME|FIREFOX',
            ],
            // ...
        ],
        'Code' => [
            'BlueprintTypes' => ['<string>', ...],
            'Dependencies' => [
                [
                    'Reference' => '<string>',
                    'Type' => 'LambdaLayer',
                ],
                // ...
            ],
            'Handler' => '<string>',
            'SourceLocationArn' => '<string>',
        ],
        'DryRunConfig' => [
            'DryRunId' => '<string>',
            'LastDryRunExecutionStatus' => '<string>',
        ],
        'EngineArn' => '<string>',
        'EngineConfigs' => [
            [
                'BrowserType' => 'CHROME|FIREFOX',
                'EngineArn' => '<string>',
            ],
            // ...
        ],
        'ExecutionRoleArn' => '<string>',
        'FailureRetentionPeriodInDays' => <integer>,
        'Id' => '<string>',
        'Name' => '<string>',
        'ProvisionedResourceCleanup' => 'AUTOMATIC|OFF',
        'RunConfig' => [
            'ActiveTracing' => true || false,
            'EphemeralStorage' => <integer>,
            'MemoryInMB' => <integer>,
            'TimeoutInSeconds' => <integer>,
        ],
        'RuntimeVersion' => '<string>',
        'Schedule' => [
            'DurationInSeconds' => <integer>,
            'Expression' => '<string>',
            'RetryConfig' => [
                'MaxRetries' => <integer>,
            ],
        ],
        'Status' => [
            'State' => 'CREATING|READY|STARTING|RUNNING|UPDATING|STOPPING|STOPPED|ERROR|DELETING',
            'StateReason' => '<string>',
            'StateReasonCode' => 'INVALID_PERMISSIONS|CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|UPDATE_PENDING|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|ROLLBACK_COMPLETE|ROLLBACK_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED|SYNC_DELETE_IN_PROGRESS',
        ],
        'SuccessRetentionPeriodInDays' => <integer>,
        'Tags' => ['<string>', ...],
        'Timeline' => [
            'Created' => <DateTime>,
            'LastModified' => <DateTime>,
            'LastStarted' => <DateTime>,
            'LastStopped' => <DateTime>,
        ],
        'VisualReference' => [
            'BaseCanaryRunId' => '<string>',
            'BaseScreenshots' => [
                [
                    'IgnoreCoordinates' => ['<string>', ...],
                    'ScreenshotName' => '<string>',
                ],
                // ...
            ],
            'BrowserType' => 'CHROME|FIREFOX',
        ],
        'VisualReferences' => [
            [
                'BaseCanaryRunId' => '<string>',
                'BaseScreenshots' => [
                    [
                        'IgnoreCoordinates' => ['<string>', ...],
                        'ScreenshotName' => '<string>',
                    ],
                    // ...
                ],
                'BrowserType' => 'CHROME|FIREFOX',
            ],
            // ...
        ],
        'VpcConfig' => [
            'Ipv6AllowedForDualStack' => true || false,
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VpcId' => '<string>',
        ],
    ],
]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

RequestEntityTooLargeException:

One of the input resources is larger than is allowed.

CreateGroup

$result = $client->createGroup([/* ... */]);
$promise = $client->createGroupAsync([/* ... */]);

Creates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.

Groups are global resources. When you create a group, it is replicated across Amazon Web Services Regions, and you can view it and add canaries to it from any Region. Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region. This means that you can put canaries from multiple Regions into the same group, and then use that group to view and manage all of those canaries in a single view.

Groups are supported in all Regions except the Regions that are disabled by default. For more information about these Regions, see Enabling a Region.

Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary can be a member of up to 10 groups.

Parameter Syntax

$result = $client->createGroup([
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Group' => [
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Id' => '<string>',
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

ConflictException:

A conflicting operation is already in progress.

ServiceQuotaExceededException:

The request exceeded a service quota value.

DeleteCanary

$result = $client->deleteCanary([/* ... */]);
$promise = $client->deleteCanaryAsync([/* ... */]);

Permanently deletes the specified canary.

If the canary's ProvisionedResourceCleanup field is set to AUTOMATIC or you specify DeleteLambda in this operation as true, CloudWatch Synthetics also deletes the Lambda functions and layers that are used by the canary.

Other resources used and created by the canary are not automatically deleted. After you delete a canary, you should also delete the following:

• The CloudWatch alarms created for this canary. These alarms have a name of Synthetics-Alarm-first-198-characters-of-canary-name-canaryId-alarm number

• Amazon S3 objects and buckets, such as the canary's artifact location.

• IAM roles created for the canary. If they were created in the console, these roles have the name role/service-role/CloudWatchSyntheticsRole-First-21-Characters-of-CanaryName

• CloudWatch Logs log groups created for the canary. These logs groups have the name /aws/lambda/cwsyn-First-21-Characters-of-CanaryName

Before you delete a canary, you might want to use GetCanary to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary.

Parameter Syntax

$result = $client->deleteCanary([
    'DeleteLambda' => true || false,
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

ResourceNotFoundException:

One of the specified resources was not found.

ConflictException:

A conflicting operation is already in progress.

DeleteGroup

$result = $client->deleteGroup([/* ... */]);
$promise = $client->deleteGroupAsync([/* ... */]);

Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group, they are not deleted when you delete the group.

Groups are a global resource that appear in all Regions, but the request to delete a group must be made from its home Region. You can find the home Region of a group within its ARN.

Parameter Syntax

$result = $client->deleteGroup([
    'GroupIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

ResourceNotFoundException:

One of the specified resources was not found.

ConflictException:

A conflicting operation is already in progress.

DescribeCanaries

$result = $client->describeCanaries([/* ... */]);
$promise = $client->describeCanariesAsync([/* ... */]);

This operation returns a list of the canaries in your account, along with full details about each canary.

This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

Parameter Syntax

$result = $client->describeCanaries([
    'MaxResults' => <integer>,
    'Names' => ['<string>', ...],
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Canaries' => [
        [
            'ArtifactConfig' => [
                'S3Encryption' => [
                    'EncryptionMode' => 'SSE_S3|SSE_KMS',
                    'KmsKeyArn' => '<string>',
                ],
            ],
            'ArtifactS3Location' => '<string>',
            'BrowserConfigs' => [
                [
                    'BrowserType' => 'CHROME|FIREFOX',
                ],
                // ...
            ],
            'Code' => [
                'BlueprintTypes' => ['<string>', ...],
                'Dependencies' => [
                    [
                        'Reference' => '<string>',
                        'Type' => 'LambdaLayer',
                    ],
                    // ...
                ],
                'Handler' => '<string>',
                'SourceLocationArn' => '<string>',
            ],
            'DryRunConfig' => [
                'DryRunId' => '<string>',
                'LastDryRunExecutionStatus' => '<string>',
            ],
            'EngineArn' => '<string>',
            'EngineConfigs' => [
                [
                    'BrowserType' => 'CHROME|FIREFOX',
                    'EngineArn' => '<string>',
                ],
                // ...
            ],
            'ExecutionRoleArn' => '<string>',
            'FailureRetentionPeriodInDays' => <integer>,
            'Id' => '<string>',
            'Name' => '<string>',
            'ProvisionedResourceCleanup' => 'AUTOMATIC|OFF',
            'RunConfig' => [
                'ActiveTracing' => true || false,
                'EphemeralStorage' => <integer>,
                'MemoryInMB' => <integer>,
                'TimeoutInSeconds' => <integer>,
            ],
            'RuntimeVersion' => '<string>',
            'Schedule' => [
                'DurationInSeconds' => <integer>,
                'Expression' => '<string>',
                'RetryConfig' => [
                    'MaxRetries' => <integer>,
                ],
            ],
            'Status' => [
                'State' => 'CREATING|READY|STARTING|RUNNING|UPDATING|STOPPING|STOPPED|ERROR|DELETING',
                'StateReason' => '<string>',
                'StateReasonCode' => 'INVALID_PERMISSIONS|CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|UPDATE_PENDING|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|ROLLBACK_COMPLETE|ROLLBACK_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED|SYNC_DELETE_IN_PROGRESS',
            ],
            'SuccessRetentionPeriodInDays' => <integer>,
            'Tags' => ['<string>', ...],
            'Timeline' => [
                'Created' => <DateTime>,
                'LastModified' => <DateTime>,
                'LastStarted' => <DateTime>,
                'LastStopped' => <DateTime>,
            ],
            'VisualReference' => [
                'BaseCanaryRunId' => '<string>',
                'BaseScreenshots' => [
                    [
                        'IgnoreCoordinates' => ['<string>', ...],
                        'ScreenshotName' => '<string>',
                    ],
                    // ...
                ],
                'BrowserType' => 'CHROME|FIREFOX',
            ],
            'VisualReferences' => [
                [
                    'BaseCanaryRunId' => '<string>',
                    'BaseScreenshots' => [
                        [
                            'IgnoreCoordinates' => ['<string>', ...],
                            'ScreenshotName' => '<string>',
                        ],
                        // ...
                    ],
                    'BrowserType' => 'CHROME|FIREFOX',
                ],
                // ...
            ],
            'VpcConfig' => [
                'Ipv6AllowedForDualStack' => true || false,
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
                'VpcId' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

DescribeCanariesLastRun

$result = $client->describeCanariesLastRun([/* ... */]);
$promise = $client->describeCanariesLastRunAsync([/* ... */]);

Use this operation to see information from the most recent run of each canary that you have created.

This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

Parameter Syntax

$result = $client->describeCanariesLastRun([
    'BrowserType' => 'CHROME|FIREFOX',
    'MaxResults' => <integer>,
    'Names' => ['<string>', ...],
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CanariesLastRun' => [
        [
            'CanaryName' => '<string>',
            'LastRun' => [
                'ArtifactS3Location' => '<string>',
                'BrowserType' => 'CHROME|FIREFOX',
                'DryRunConfig' => [
                    'DryRunId' => '<string>',
                ],
                'Id' => '<string>',
                'Name' => '<string>',
                'RetryAttempt' => <integer>,
                'ScheduledRunId' => '<string>',
                'Status' => [
                    'State' => 'RUNNING|PASSED|FAILED',
                    'StateReason' => '<string>',
                    'StateReasonCode' => 'CANARY_FAILURE|EXECUTION_FAILURE',
                    'TestResult' => 'PASSED|FAILED|UNKNOWN',
                ],
                'Timeline' => [
                    'Completed' => <DateTime>,
                    'MetricTimestampForRunAndRetries' => <DateTime>,
                    'Started' => <DateTime>,
                ],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

DescribeRuntimeVersions

$result = $client->describeRuntimeVersions([/* ... */]);
$promise = $client->describeRuntimeVersionsAsync([/* ... */]);

Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.

Parameter Syntax

$result = $client->describeRuntimeVersions([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RuntimeVersions' => [
        [
            'DeprecationDate' => <DateTime>,
            'Description' => '<string>',
            'ReleaseDate' => <DateTime>,
            'VersionName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

DisassociateResource

$result = $client->disassociateResource([/* ... */]);
$promise = $client->disassociateResourceAsync([/* ... */]);

Removes a canary from a group. You must run this operation in the Region where the canary exists.

Parameter Syntax

$result = $client->disassociateResource([
    'GroupIdentifier' => '<string>', // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

ResourceNotFoundException:

One of the specified resources was not found.

ConflictException:

A conflicting operation is already in progress.

GetCanary

$result = $client->getCanary([/* ... */]);
$promise = $client->getCanaryAsync([/* ... */]);

Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries.

Parameter Syntax

$result = $client->getCanary([
    'DryRunId' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Canary' => [
        'ArtifactConfig' => [
            'S3Encryption' => [
                'EncryptionMode' => 'SSE_S3|SSE_KMS',
                'KmsKeyArn' => '<string>',
            ],
        ],
        'ArtifactS3Location' => '<string>',
        'BrowserConfigs' => [
            [
                'BrowserType' => 'CHROME|FIREFOX',
            ],
            // ...
        ],
        'Code' => [
            'BlueprintTypes' => ['<string>', ...],
            'Dependencies' => [
                [
                    'Reference' => '<string>',
                    'Type' => 'LambdaLayer',
                ],
                // ...
            ],
            'Handler' => '<string>',
            'SourceLocationArn' => '<string>',
        ],
        'DryRunConfig' => [
            'DryRunId' => '<string>',
            'LastDryRunExecutionStatus' => '<string>',
        ],
        'EngineArn' => '<string>',
        'EngineConfigs' => [
            [
                'BrowserType' => 'CHROME|FIREFOX',
                'EngineArn' => '<string>',
            ],
            // ...
        ],
        'ExecutionRoleArn' => '<string>',
        'FailureRetentionPeriodInDays' => <integer>,
        'Id' => '<string>',
        'Name' => '<string>',
        'ProvisionedResourceCleanup' => 'AUTOMATIC|OFF',
        'RunConfig' => [
            'ActiveTracing' => true || false,
            'EphemeralStorage' => <integer>,
            'MemoryInMB' => <integer>,
            'TimeoutInSeconds' => <integer>,
        ],
        'RuntimeVersion' => '<string>',
        'Schedule' => [
            'DurationInSeconds' => <integer>,
            'Expression' => '<string>',
            'RetryConfig' => [
                'MaxRetries' => <integer>,
            ],
        ],
        'Status' => [
            'State' => 'CREATING|READY|STARTING|RUNNING|UPDATING|STOPPING|STOPPED|ERROR|DELETING',
            'StateReason' => '<string>',
            'StateReasonCode' => 'INVALID_PERMISSIONS|CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|UPDATE_PENDING|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|ROLLBACK_COMPLETE|ROLLBACK_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED|SYNC_DELETE_IN_PROGRESS',
        ],
        'SuccessRetentionPeriodInDays' => <integer>,
        'Tags' => ['<string>', ...],
        'Timeline' => [
            'Created' => <DateTime>,
            'LastModified' => <DateTime>,
            'LastStarted' => <DateTime>,
            'LastStopped' => <DateTime>,
        ],
        'VisualReference' => [
            'BaseCanaryRunId' => '<string>',
            'BaseScreenshots' => [
                [
                    'IgnoreCoordinates' => ['<string>', ...],
                    'ScreenshotName' => '<string>',
                ],
                // ...
            ],
            'BrowserType' => 'CHROME|FIREFOX',
        ],
        'VisualReferences' => [
            [
                'BaseCanaryRunId' => '<string>',
                'BaseScreenshots' => [
                    [
                        'IgnoreCoordinates' => ['<string>', ...],
                        'ScreenshotName' => '<string>',
                    ],
                    // ...
                ],
                'BrowserType' => 'CHROME|FIREFOX',
            ],
            // ...
        ],
        'VpcConfig' => [
            'Ipv6AllowedForDualStack' => true || false,
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VpcId' => '<string>',
        ],
    ],
]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

GetCanaryRuns

$result = $client->getCanaryRuns([/* ... */]);
$promise = $client->getCanaryRunsAsync([/* ... */]);

Retrieves a list of runs for a specified canary.

Parameter Syntax

$result = $client->getCanaryRuns([
    'DryRunId' => '<string>',
    'MaxResults' => <integer>,
    'Name' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'RunType' => 'CANARY_RUN|DRY_RUN',
]);

Parameter Details

Result Syntax

[
    'CanaryRuns' => [
        [
            'ArtifactS3Location' => '<string>',
            'BrowserType' => 'CHROME|FIREFOX',
            'DryRunConfig' => [
                'DryRunId' => '<string>',
            ],
            'Id' => '<string>',
            'Name' => '<string>',
            'RetryAttempt' => <integer>,
            'ScheduledRunId' => '<string>',
            'Status' => [
                'State' => 'RUNNING|PASSED|FAILED',
                'StateReason' => '<string>',
                'StateReasonCode' => 'CANARY_FAILURE|EXECUTION_FAILURE',
                'TestResult' => 'PASSED|FAILED|UNKNOWN',
            ],
            'Timeline' => [
                'Completed' => <DateTime>,
                'MetricTimestampForRunAndRetries' => <DateTime>,
                'Started' => <DateTime>,
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

ResourceNotFoundException:

One of the specified resources was not found.

GetGroup

$result = $client->getGroup([/* ... */]);
$promise = $client->getGroupAsync([/* ... */]);

Returns information about one group. Groups are a global resource, so you can use this operation from any Region.

Parameter Syntax

$result = $client->getGroup([
    'GroupIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Group' => [
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Id' => '<string>',
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

ResourceNotFoundException:

One of the specified resources was not found.

ConflictException:

A conflicting operation is already in progress.

ListAssociatedGroups

$result = $client->listAssociatedGroups([/* ... */]);
$promise = $client->listAssociatedGroupsAsync([/* ... */]);

Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.

Parameter Syntax

$result = $client->listAssociatedGroups([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Groups' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

ResourceNotFoundException:

One of the specified resources was not found.

ListGroupResources

$result = $client->listGroupResources([/* ... */]);
$promise = $client->listGroupResourcesAsync([/* ... */]);

This operation returns a list of the ARNs of the canaries that are associated with the specified group.

Parameter Syntax

$result = $client->listGroupResources([
    'GroupIdentifier' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Resources' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

ResourceNotFoundException:

One of the specified resources was not found.

ConflictException:

A conflicting operation is already in progress.

ListGroups

$result = $client->listGroups([/* ... */]);
$promise = $client->listGroupsAsync([/* ... */]);

Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.

Parameter Syntax

$result = $client->listGroups([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Groups' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Displays the tags associated with a canary or group.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

The request was not valid.

NotFoundException:

The specified resource was not found.

TooManyRequestsException:

There were too many simultaneous requests. Try the operation again.

ConflictException:

A conflicting operation is already in progress.

InternalFailureException:

An internal failure occurred. Try the operation again.

StartCanary

$result = $client->startCanary([/* ... */]);
$promise = $client->startCanaryAsync([/* ... */]);

Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary.

Parameter Syntax

$result = $client->startCanary([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

ResourceNotFoundException:

One of the specified resources was not found.

ConflictException:

A conflicting operation is already in progress.

StartCanaryDryRun

$result = $client->startCanaryDryRun([/* ... */]);
$promise = $client->startCanaryDryRunAsync([/* ... */]);

Use this operation to start a dry run for a canary that has already been created

Parameter Syntax

$result = $client->startCanaryDryRun([
    'ArtifactConfig' => [
        'S3Encryption' => [
            'EncryptionMode' => 'SSE_S3|SSE_KMS',
            'KmsKeyArn' => '<string>',
        ],
    ],
    'ArtifactS3Location' => '<string>',
    'BrowserConfigs' => [
        [
            'BrowserType' => 'CHROME|FIREFOX',
        ],
        // ...
    ],
    'Code' => [
        'BlueprintTypes' => ['<string>', ...],
        'Dependencies' => [
            [
                'Reference' => '<string>', // REQUIRED
                'Type' => 'LambdaLayer',
            ],
            // ...
        ],
        'Handler' => '<string>',
        'S3Bucket' => '<string>',
        'S3Key' => '<string>',
        'S3Version' => '<string>',
        'ZipFile' => <string || resource || Psr\Http\Message\StreamInterface>,
    ],
    'ExecutionRoleArn' => '<string>',
    'FailureRetentionPeriodInDays' => <integer>,
    'Name' => '<string>', // REQUIRED
    'ProvisionedResourceCleanup' => 'AUTOMATIC|OFF',
    'RunConfig' => [
        'ActiveTracing' => true || false,
        'EnvironmentVariables' => ['<string>', ...],
        'EphemeralStorage' => <integer>,
        'MemoryInMB' => <integer>,
        'TimeoutInSeconds' => <integer>,
    ],
    'RuntimeVersion' => '<string>',
    'SuccessRetentionPeriodInDays' => <integer>,
    'VisualReference' => [
        'BaseCanaryRunId' => '<string>', // REQUIRED
        'BaseScreenshots' => [
            [
                'IgnoreCoordinates' => ['<string>', ...],
                'ScreenshotName' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'BrowserType' => 'CHROME|FIREFOX',
    ],
    'VisualReferences' => [
        [
            'BaseCanaryRunId' => '<string>', // REQUIRED
            'BaseScreenshots' => [
                [
                    'IgnoreCoordinates' => ['<string>', ...],
                    'ScreenshotName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'BrowserType' => 'CHROME|FIREFOX',
        ],
        // ...
    ],
    'VpcConfig' => [
        'Ipv6AllowedForDualStack' => true || false,
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'DryRunConfig' => [
        'DryRunId' => '<string>',
        'LastDryRunExecutionStatus' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

ResourceNotFoundException:

One of the specified resources was not found.

ConflictException:

A conflicting operation is already in progress.

AccessDeniedException:

You don't have permission to perform this operation on this resource.

StopCanary

$result = $client->stopCanary([/* ... */]);
$promise = $client->stopCanaryAsync([/* ... */]);

Stops the canary to prevent all future runs. If the canary is currently running,the run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run.

You can use StartCanary to start it running again with the canary’s current schedule at any point in the future.

Parameter Syntax

$result = $client->stopCanary([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

ResourceNotFoundException:

One of the specified resources was not found.

ConflictException:

A conflicting operation is already in progress.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns one or more tags (key-value pairs) to the specified canary or group.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a canary or group.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request was not valid.

NotFoundException:

The specified resource was not found.

TooManyRequestsException:

There were too many simultaneous requests. Try the operation again.

ConflictException:

A conflicting operation is already in progress.

InternalFailureException:

An internal failure occurred. Try the operation again.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request was not valid.

NotFoundException:

The specified resource was not found.

TooManyRequestsException:

There were too many simultaneous requests. Try the operation again.

ConflictException:

A conflicting operation is already in progress.

InternalFailureException:

An internal failure occurred. Try the operation again.

UpdateCanary

$result = $client->updateCanary([/* ... */]);
$promise = $client->updateCanaryAsync([/* ... */]);

Updates the configuration of a canary that has already been created.

For multibrowser canaries, you can add or remove browsers by updating the browserConfig list in the update call. For example:

• To add Firefox to a canary that currently uses Chrome, specify browserConfigs as [CHROME, FIREFOX]

• To remove Firefox and keep only Chrome, specify browserConfigs as [CHROME]

You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.

Parameter Syntax

$result = $client->updateCanary([
    'ArtifactConfig' => [
        'S3Encryption' => [
            'EncryptionMode' => 'SSE_S3|SSE_KMS',
            'KmsKeyArn' => '<string>',
        ],
    ],
    'ArtifactS3Location' => '<string>',
    'BrowserConfigs' => [
        [
            'BrowserType' => 'CHROME|FIREFOX',
        ],
        // ...
    ],
    'Code' => [
        'BlueprintTypes' => ['<string>', ...],
        'Dependencies' => [
            [
                'Reference' => '<string>', // REQUIRED
                'Type' => 'LambdaLayer',
            ],
            // ...
        ],
        'Handler' => '<string>',
        'S3Bucket' => '<string>',
        'S3Key' => '<string>',
        'S3Version' => '<string>',
        'ZipFile' => <string || resource || Psr\Http\Message\StreamInterface>,
    ],
    'DryRunId' => '<string>',
    'ExecutionRoleArn' => '<string>',
    'FailureRetentionPeriodInDays' => <integer>,
    'Name' => '<string>', // REQUIRED
    'ProvisionedResourceCleanup' => 'AUTOMATIC|OFF',
    'RunConfig' => [
        'ActiveTracing' => true || false,
        'EnvironmentVariables' => ['<string>', ...],
        'EphemeralStorage' => <integer>,
        'MemoryInMB' => <integer>,
        'TimeoutInSeconds' => <integer>,
    ],
    'RuntimeVersion' => '<string>',
    'Schedule' => [
        'DurationInSeconds' => <integer>,
        'Expression' => '<string>', // REQUIRED
        'RetryConfig' => [
            'MaxRetries' => <integer>, // REQUIRED
        ],
    ],
    'SuccessRetentionPeriodInDays' => <integer>,
    'VisualReference' => [
        'BaseCanaryRunId' => '<string>', // REQUIRED
        'BaseScreenshots' => [
            [
                'IgnoreCoordinates' => ['<string>', ...],
                'ScreenshotName' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'BrowserType' => 'CHROME|FIREFOX',
    ],
    'VisualReferences' => [
        [
            'BaseCanaryRunId' => '<string>', // REQUIRED
            'BaseScreenshots' => [
                [
                    'IgnoreCoordinates' => ['<string>', ...],
                    'ScreenshotName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'BrowserType' => 'CHROME|FIREFOX',
        ],
        // ...
    ],
    'VpcConfig' => [
        'Ipv6AllowedForDualStack' => true || false,
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unknown internal error occurred.

ValidationException:

A parameter could not be validated.

ResourceNotFoundException:

One of the specified resources was not found.

ConflictException:

A conflicting operation is already in progress.

RequestEntityTooLargeException:

One of the input resources is larger than is allowed.

AccessDeniedException:

You don't have permission to perform this operation on this resource.