Struct Client

pub struct Client { /* private fields */ }

Client for Synthetics

Client for invoking operations on Synthetics. Each operation on Synthetics is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_synthetics::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_synthetics::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateResource operation has a Client::associate_resource, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_resource()
    .group_identifier("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_resource(&self) -> AssociateResourceFluentBuilder

Constructs a fluent builder for the AssociateResource operation.

• The fluent builder is configurable:
  • group_identifier(impl Into<String>) / set_group_identifier(Option<String>):
    required: true
    

    Specifies the group. You can specify the group name, the ARN, or the group ID as the GroupIdentifier.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the canary that you want to associate with the specified group.

    
    
• On success, responds with AssociateResourceOutput
• On failure, responds with SdkError<AssociateResourceError>

impl Client

pub fn create_canary(&self) -> CreateCanaryFluentBuilder

Constructs a fluent builder for the CreateCanary operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

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

    
    
  • code(CanaryCodeInput) / set_code(Option<CanaryCodeInput>):
    required: true
    

    A structure that includes the entry point from which the canary should start running your script. If the script is stored in an Amazon S3 bucket, the bucket name, key, and version are also included.

    
    
  • artifact_s3_location(impl Into<String>) / set_artifact_s3_location(Option<String>):
    required: true
    

    The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the Amazon S3 bucket can’t include a period (.).

    
    
  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):
    required: true
    

    The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

    • s3:PutObject

    • s3:GetBucketLocation

    • s3:ListAllMyBuckets

    • cloudwatch:PutMetricData

    • logs:CreateLogGroup

    • logs:CreateLogStream

    • logs:PutLogEvents

    
    
  • schedule(CanaryScheduleInput) / set_schedule(Option<CanaryScheduleInput>):
    required: true
    

    A structure that contains information about how often the canary is to run and when these test runs are to stop.

    
    
  • run_config(CanaryRunConfigInput) / set_run_config(Option<CanaryRunConfigInput>):
    required: false
    

    A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.

    Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.

    
    
  • success_retention_period_in_days(i32) / set_success_retention_period_in_days(Option<i32>):
    required: false
    

    The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

    This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.

    
    
  • failure_retention_period_in_days(i32) / set_failure_retention_period_in_days(Option<i32>):
    required: false
    

    The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

    This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.

    
    
  • runtime_version(impl Into<String>) / set_runtime_version(Option<String>):
    required: true
    

    Specifies the runtime version to use for the canary. For a list of valid runtime versions and more information about runtime versions, see Canary Runtime Versions.

    
    
  • vpc_config(VpcConfigInput) / set_vpc_config(Option<VpcConfigInput>):
    required: false
    

    If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.

    
    
  • resources_to_replicate_tags(ResourceToTag) / set_resources_to_replicate_tags(Option<Vec::<ResourceToTag>>):
    required: false
    

    To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.

    If you specify this parameter and don’t specify any tags in the Tags parameter, the canary creation fails.

    
    
  • provisioned_resource_cleanup(ProvisionedResourceCleanupSetting) / set_provisioned_resource_cleanup(Option<ProvisionedResourceCleanupSetting>):
    required: false
    

    Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that the Lambda functions and layers will be deleted when the canary is deleted.

    If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

    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 the resources that have certain tag values.

    To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.

    
    
  • artifact_config(ArtifactConfigInput) / set_artifact_config(Option<ArtifactConfigInput>):
    required: false
    

    A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

    
    
• On success, responds with CreateCanaryOutput with field(s):
  • canary(Option<Canary>):

    The full details about the canary you have created.

• On failure, responds with SdkError<CreateCanaryError>

impl Client

pub fn create_group(&self) -> CreateGroupFluentBuilder

Constructs a fluent builder for the CreateGroup operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name for the group. It can include any Unicode characters.

    The names for all groups in your account, across all Regions, must be unique.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A list of key-value pairs to associate with the group. You can associate as many as 50 tags with a 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 the resources that have certain tag values.

    
    
• On success, responds with CreateGroupOutput with field(s):
  • group(Option<Group>):

    A structure that contains information about the group that was just created.

• On failure, responds with SdkError<CreateGroupError>

impl Client

pub fn delete_canary(&self) -> DeleteCanaryFluentBuilder

Constructs a fluent builder for the DeleteCanary operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries.

    
    
  • delete_lambda(bool) / set_delete_lambda(Option<bool>):
    required: false
    

    Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

    Your setting for this parameter is used only if the canary doesn’t have AUTOMATIC for its ProvisionedResourceCleanup field. If that field is set to AUTOMATIC, then the Lambda functions and layers will be deleted when this canary is deleted.

    Type: Boolean

    
    
• On success, responds with DeleteCanaryOutput
• On failure, responds with SdkError<DeleteCanaryError>

impl Client

pub fn delete_group(&self) -> DeleteGroupFluentBuilder

Constructs a fluent builder for the DeleteGroup operation.

• The fluent builder is configurable:
  • group_identifier(impl Into<String>) / set_group_identifier(Option<String>):
    required: true
    

    Specifies which group to delete. You can specify the group name, the ARN, or the group ID as the GroupIdentifier.

    
    
• On success, responds with DeleteGroupOutput
• On failure, responds with SdkError<DeleteGroupError>

impl Client

pub fn describe_canaries(&self) -> DescribeCanariesFluentBuilder

Constructs a fluent builder for the DescribeCanaries operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 20 is used.

    
    
  • names(impl Into<String>) / set_names(Option<Vec::<String>>):
    required: false
    

    Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

    If you specify this 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 this 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.

    
    
• On success, responds with DescribeCanariesOutput with field(s):
  • canaries(Option<Vec::<Canary>>):

    Returns an array. Each item in the array contains the full information about one canary.

  • next_token(Option<String>):

    A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next set of results.

• On failure, responds with SdkError<DescribeCanariesError>

impl Client

pub fn describe_canaries_last_run(&self) -> DescribeCanariesLastRunFluentBuilder

Constructs a fluent builder for the DescribeCanariesLastRun operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanariesLastRun operation to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specify this parameter to limit how many runs are returned each time you use the DescribeLastRun operation. If you omit this parameter, the default of 100 is used.

    
    
  • names(impl Into<String>) / set_names(Option<Vec::<String>>):
    required: false
    

    Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

    If you specify this 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.

    
    
• On success, responds with DescribeCanariesLastRunOutput with field(s):
  • canaries_last_run(Option<Vec::<CanaryLastRun>>):

    An array that contains the information from the most recent run of each canary.

  • next_token(Option<String>):

    A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanariesLastRun operation to retrieve the next set of results.

• On failure, responds with SdkError<DescribeCanariesLastRunError>

impl Client

pub fn describe_runtime_versions(&self) -> DescribeRuntimeVersionsFluentBuilder

Constructs a fluent builder for the DescribeRuntimeVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token that indicates that there is more data available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specify this parameter to limit how many runs are returned each time you use the DescribeRuntimeVersions operation. If you omit this parameter, the default of 100 is used.

    
    
• On success, responds with DescribeRuntimeVersionsOutput with field(s):
  • runtime_versions(Option<Vec::<RuntimeVersion>>):

    An array of objects that display the details about each Synthetics canary runtime version.

  • next_token(Option<String>):

    A token that indicates that there is more data available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results.

• On failure, responds with SdkError<DescribeRuntimeVersionsError>

impl Client

pub fn disassociate_resource(&self) -> DisassociateResourceFluentBuilder

Constructs a fluent builder for the DisassociateResource operation.

• The fluent builder is configurable:
  • group_identifier(impl Into<String>) / set_group_identifier(Option<String>):
    required: true
    

    Specifies the group. You can specify the group name, the ARN, or the group ID as the GroupIdentifier.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the canary that you want to remove from the specified group.

    
    
• On success, responds with DisassociateResourceOutput
• On failure, responds with SdkError<DisassociateResourceError>

impl Client

pub fn get_canary(&self) -> GetCanaryFluentBuilder

Constructs a fluent builder for the GetCanary operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the canary that you want details for.

    
    
  • dry_run_id(impl Into<String>) / set_dry_run_id(Option<String>):
    required: false
    

    The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.

    
    
• On success, responds with GetCanaryOutput with field(s):
  • canary(Option<Canary>):

    A structure that contains the full information about the canary.

• On failure, responds with SdkError<GetCanaryError>

impl Client

pub fn get_canary_runs(&self) -> GetCanaryRunsFluentBuilder

Constructs a fluent builder for the GetCanaryRuns operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the canary that you want to see runs for.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.

    When auto retry is enabled for the canary, the first subsequent retry is suffixed with *1 indicating its the first retry and the next subsequent try is suffixed with *2.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used.

    
    
  • dry_run_id(impl Into<String>) / set_dry_run_id(Option<String>):
    required: false
    

    The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.

    
    
  • run_type(RunType) / set_run_type(Option<RunType>):
    required: false
    

    • When you provide RunType=CANARY_RUN and dryRunId, you will get an exception

    • When a value is not provided for RunType, the default value is CANARY_RUN

    • When CANARY_RUN is provided, all canary runs excluding dry runs are returned

    • When DRY_RUN is provided, all dry runs excluding canary runs are returned

    
    
• On success, responds with GetCanaryRunsOutput with field(s):
  • canary_runs(Option<Vec::<CanaryRun>>):

    An array of structures. Each structure contains the details of one of the retrieved canary runs.

  • next_token(Option<String>):

    A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.

• On failure, responds with SdkError<GetCanaryRunsError>

impl Client

pub fn get_group(&self) -> GetGroupFluentBuilder

Constructs a fluent builder for the GetGroup operation.

• The fluent builder is configurable:
  • group_identifier(impl Into<String>) / set_group_identifier(Option<String>):
    required: true
    

    Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier.

    
    
• On success, responds with GetGroupOutput with field(s):
  • group(Option<Group>):

    A structure that contains information about the group.

• On failure, responds with SdkError<GetGroupError>

impl Client

pub fn list_associated_groups(&self) -> ListAssociatedGroupsFluentBuilder

Constructs a fluent builder for the ListAssociatedGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specify this parameter to limit how many groups are returned each time you use the ListAssociatedGroups operation. If you omit this parameter, the default of 20 is used.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the canary that you want to view groups for.

    
    
• On success, responds with ListAssociatedGroupsOutput with field(s):
  • groups(Option<Vec::<GroupSummary>>):

    An array of structures that contain information about the groups that this canary is associated with.

  • next_token(Option<String>):

    A token that indicates that there is more data available. You can use this token in a subsequent ListAssociatedGroups operation to retrieve the next set of results.

• On failure, responds with SdkError<ListAssociatedGroupsError>

impl Client

pub fn list_group_resources(&self) -> ListGroupResourcesFluentBuilder

Constructs a fluent builder for the ListGroupResources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specify this parameter to limit how many canary ARNs are returned each time you use the ListGroupResources operation. If you omit this parameter, the default of 20 is used.

    
    
  • group_identifier(impl Into<String>) / set_group_identifier(Option<String>):
    required: true
    

    Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier.

    
    
• On success, responds with ListGroupResourcesOutput with field(s):
  • resources(Option<Vec::<String>>):

    An array of ARNs. These ARNs are for the canaries that are associated with the group.

  • next_token(Option<String>):

    A token that indicates that there is more data available. You can use this token in a subsequent ListGroupResources operation to retrieve the next set of results.

• On failure, responds with SdkError<ListGroupResourcesError>

impl Client

pub fn list_groups(&self) -> ListGroupsFluentBuilder

Constructs a fluent builder for the ListGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specify this parameter to limit how many groups are returned each time you use the ListGroups operation. If you omit this parameter, the default of 20 is used.

    
    
• On success, responds with ListGroupsOutput with field(s):
  • groups(Option<Vec::<GroupSummary>>):

    An array of structures that each contain information about one group.

  • next_token(Option<String>):

    A token that indicates that there is more data available. You can use this token in a subsequent ListGroups operation to retrieve the next set of results.

• On failure, responds with SdkError<ListGroupsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the canary or group that you want to view tags for.

    The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .

    The ARN format of a group is arn:aws:synthetics:Region:account-id:group:group-name

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The list of tag keys and values associated with the resource that you specified.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn start_canary(&self) -> StartCanaryFluentBuilder

Constructs a fluent builder for the StartCanary operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the canary that you want to run. To find canary names, use DescribeCanaries.

    
    
• On success, responds with StartCanaryOutput
• On failure, responds with SdkError<StartCanaryError>

impl Client

pub fn start_canary_dry_run(&self) -> StartCanaryDryRunFluentBuilder

Constructs a fluent builder for the StartCanaryDryRun operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the canary that you want to dry run. To find canary names, use DescribeCanaries.

    
    
  • code(CanaryCodeInput) / set_code(Option<CanaryCodeInput>):
    required: false
    

    Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an Amazon S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of Zipfile.

    If you are uploading your canary scripts with an Amazon S3 bucket, your zip file should include your script in a certain folder structure.

    • For Node.js canaries, the folder structure must be nodejs/node_modules/myCanaryFilename.js For more information, see Packaging your Node.js canary files

    • For Python canaries, the folder structure must be python/myCanaryFilename.py or python/myFolder/myCanaryFilename.py For more information, see Packaging your Python canary files

    
    
  • runtime_version(impl Into<String>) / set_runtime_version(Option<String>):
    required: false
    

    Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.

    
    
  • run_config(CanaryRunConfigInput) / set_run_config(Option<CanaryRunConfigInput>):
    required: false
    

    A structure that contains input information for a canary run.

    
    
  • vpc_config(VpcConfigInput) / set_vpc_config(Option<VpcConfigInput>):
    required: false
    

    If this canary is to test an endpoint in a VPC, this structure contains information about the subnets and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.

    
    
  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):
    required: false
    

    The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

    
    
  • success_retention_period_in_days(i32) / set_success_retention_period_in_days(Option<i32>):
    required: false
    

    The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

    This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.

    
    
  • failure_retention_period_in_days(i32) / set_failure_retention_period_in_days(Option<i32>):
    required: false
    

    The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

    This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.

    
    
  • visual_reference(VisualReferenceInput) / set_visual_reference(Option<VisualReferenceInput>):
    required: false
    

    An object that specifies what screenshots to use as a baseline for visual monitoring by this canary. It can optionally also specify parts of the screenshots to ignore during the visual monitoring comparison.

    Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

    
    
  • artifact_s3_location(impl Into<String>) / set_artifact_s3_location(Option<String>):
    required: false
    

    The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the Amazon S3 bucket can’t include a period (.).

    
    
  • artifact_config(ArtifactConfigInput) / set_artifact_config(Option<ArtifactConfigInput>):
    required: false
    

    A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

    
    
  • provisioned_resource_cleanup(ProvisionedResourceCleanupSetting) / set_provisioned_resource_cleanup(Option<ProvisionedResourceCleanupSetting>):
    required: false
    

    Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that the Lambda functions and layers will be deleted when the canary is deleted.

    If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.

    
    
• On success, responds with StartCanaryDryRunOutput with field(s):
  • dry_run_config(Option<DryRunConfigOutput>):

    Returns the dry run configurations for a canary.

• On failure, responds with SdkError<StartCanaryDryRunError>

impl Client

pub fn stop_canary(&self) -> StopCanaryFluentBuilder

Constructs a fluent builder for the StopCanary operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the canary that you want to stop. To find the names of your canaries, use ListCanaries.

    
    
• On success, responds with StopCanaryOutput
• On failure, responds with SdkError<StopCanaryError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the canary or group that you’re adding tags to.

    The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .

    The ARN format of a group is arn:aws:synthetics:Region:account-id:group:group-name

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The list of key-value pairs to associate with the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the canary or group that you’re removing tags from.

    The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .

    The ARN format of a group is arn:aws:synthetics:Region:account-id:group:group-name

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The list of tag keys to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_canary(&self) -> UpdateCanaryFluentBuilder

Constructs a fluent builder for the UpdateCanary operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.

    You cannot change the name of a canary that has already been created.

    
    
  • code(CanaryCodeInput) / set_code(Option<CanaryCodeInput>):
    required: false
    

    A structure that includes the entry point from which the canary should start running your script. If the script is stored in an Amazon S3 bucket, the bucket name, key, and version are also included.

    
    
  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):
    required: false
    

    The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

    • s3:PutObject

    • s3:GetBucketLocation

    • s3:ListAllMyBuckets

    • cloudwatch:PutMetricData

    • logs:CreateLogGroup

    • logs:CreateLogStream

    • logs:CreateLogStream

    
    
  • runtime_version(impl Into<String>) / set_runtime_version(Option<String>):
    required: false
    

    Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.

    
    
  • schedule(CanaryScheduleInput) / set_schedule(Option<CanaryScheduleInput>):
    required: false
    

    A structure that contains information about how often the canary is to run, and when these runs are to stop.

    
    
  • run_config(CanaryRunConfigInput) / set_run_config(Option<CanaryRunConfigInput>):
    required: false
    

    A structure that contains the timeout value that is used for each individual run of the canary.

    Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.

    
    
  • success_retention_period_in_days(i32) / set_success_retention_period_in_days(Option<i32>):
    required: false
    

    The number of days to retain data about successful runs of this canary.

    This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.

    
    
  • failure_retention_period_in_days(i32) / set_failure_retention_period_in_days(Option<i32>):
    required: false
    

    The number of days to retain data about failed runs of this canary.

    This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.

    
    
  • vpc_config(VpcConfigInput) / set_vpc_config(Option<VpcConfigInput>):
    required: false
    

    If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.

    
    
  • visual_reference(VisualReferenceInput) / set_visual_reference(Option<VisualReferenceInput>):
    required: false
    

    Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.

    Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

    
    
  • artifact_s3_location(impl Into<String>) / set_artifact_s3_location(Option<String>):
    required: false
    

    The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the Amazon S3 bucket can’t include a period (.).

    
    
  • artifact_config(ArtifactConfigInput) / set_artifact_config(Option<ArtifactConfigInput>):
    required: false
    

    A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

    
    
  • provisioned_resource_cleanup(ProvisionedResourceCleanupSetting) / set_provisioned_resource_cleanup(Option<ProvisionedResourceCleanupSetting>):
    required: false
    

    Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.

    If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.

    
    
  • dry_run_id(impl Into<String>) / set_dry_run_id(Option<String>):
    required: false
    

    Update the existing canary using the updated configurations from the DryRun associated with the DryRunId.

    When you use the dryRunId field when updating a canary, the only other field you can provide is the Schedule. Adding any other field will thrown an exception.

    
    
• On success, responds with UpdateCanaryOutput
• On failure, responds with SdkError<UpdateCanaryError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.