Class: Aws::Synthetics::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb

Overview

An API client for Synthetics. To construct a client, you need to configure a :region and :credentials.

client = Aws::Synthetics::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Synthetics::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Synthetics::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



466
467
468
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 466

def initialize(*args)
  super
end

Instance Method Details

#associate_resource(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.associate_resource({
  group_identifier: "GroupIdentifier", # required
  resource_arn: "CanaryArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_identifier (required, String) —

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

  • :resource_arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



499
500
501
502
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 499

def associate_resource(params = {}, options = {})
  req = build_request(:associate_resource, params)
  req.send_request(options)
end

#create_canary(params = {}) ⇒ Types::CreateCanaryResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_canary({
  name: "CanaryName", # required
  code: { # required
    s3_bucket: "String",
    s3_key: "String",
    s3_version: "String",
    zip_file: "data",
    handler: "CodeHandler", # required
  },
  artifact_s3_location: "String", # required
  execution_role_arn: "RoleArn", # required
  schedule: { # required
    expression: "String", # required
    duration_in_seconds: 1,
    retry_config: {
      max_retries: 1, # required
    },
  },
  run_config: {
    timeout_in_seconds: 1,
    memory_in_mb: 1,
    active_tracing: false,
    environment_variables: {
      "EnvironmentVariableName" => "EnvironmentVariableValue",
    },
    ephemeral_storage: 1,
  },
  success_retention_period_in_days: 1,
  failure_retention_period_in_days: 1,
  runtime_version: "String", # required
  vpc_config: {
    subnet_ids: ["SubnetId"],
    security_group_ids: ["SecurityGroupId"],
    ipv_6_allowed_for_dual_stack: false,
  },
  resources_to_replicate_tags: ["lambda-function"], # accepts lambda-function
  provisioned_resource_cleanup: "AUTOMATIC", # accepts AUTOMATIC, OFF
  tags: {
    "TagKey" => "TagValue",
  },
  artifact_config: {
    s3_encryption: {
      encryption_mode: "SSE_S3", # accepts SSE_S3, SSE_KMS
      kms_key_arn: "KmsKeyArn",
    },
  },
})

Response structure


resp.canary.id #=> String
resp.canary.name #=> String
resp.canary.code.source_location_arn #=> String
resp.canary.code.handler #=> String
resp.canary.execution_role_arn #=> String
resp.canary.schedule.expression #=> String
resp.canary.schedule.duration_in_seconds #=> Integer
resp.canary.schedule.retry_config.max_retries #=> Integer
resp.canary.run_config.timeout_in_seconds #=> Integer
resp.canary.run_config.memory_in_mb #=> Integer
resp.canary.run_config.active_tracing #=> Boolean
resp.canary.run_config.ephemeral_storage #=> Integer
resp.canary.success_retention_period_in_days #=> Integer
resp.canary.failure_retention_period_in_days #=> Integer
resp.canary.status.state #=> String, one of "CREATING", "READY", "STARTING", "RUNNING", "UPDATING", "STOPPING", "STOPPED", "ERROR", "DELETING"
resp.canary.status.state_reason #=> String
resp.canary.status.state_reason_code #=> String, one of "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"
resp.canary.timeline.created #=> Time
resp.canary.timeline.last_modified #=> Time
resp.canary.timeline.last_started #=> Time
resp.canary.timeline.last_stopped #=> Time
resp.canary.artifact_s3_location #=> String
resp.canary.engine_arn #=> String
resp.canary.runtime_version #=> String
resp.canary.vpc_config.vpc_id #=> String
resp.canary.vpc_config.subnet_ids #=> Array
resp.canary.vpc_config.subnet_ids[0] #=> String
resp.canary.vpc_config.security_group_ids #=> Array
resp.canary.vpc_config.security_group_ids[0] #=> String
resp.canary.vpc_config.ipv_6_allowed_for_dual_stack #=> Boolean
resp.canary.visual_reference.base_screenshots #=> Array
resp.canary.visual_reference.base_screenshots[0].screenshot_name #=> String
resp.canary.visual_reference.base_screenshots[0].ignore_coordinates #=> Array
resp.canary.visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
resp.canary.visual_reference.base_canary_run_id #=> String
resp.canary.provisioned_resource_cleanup #=> String, one of "AUTOMATIC", "OFF"
resp.canary.tags #=> Hash
resp.canary.tags["TagKey"] #=> String
resp.canary.artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
resp.canary.artifact_config.s3_encryption.kms_key_arn #=> String
resp.canary.dry_run_config.dry_run_id #=> String
resp.canary.dry_run_config.last_dry_run_execution_status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    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 (required, Types::CanaryCodeInput) —

    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 (required, String) —

    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 (required, String) —

    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 (required, Types::CanaryScheduleInput) —

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

  • :run_config (Types::CanaryRunConfigInput) —

    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 (Integer) —

    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 (Integer) —

    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 (required, String) —

    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 (Types::VpcConfigInput) —

    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 (Array<String>) —

    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 (String) —

    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 (Hash<String,String>) —

    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 (Types::ArtifactConfigInput) —

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

Returns:

See Also:



774
775
776
777
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 774

def create_canary(params = {}, options = {})
  req = build_request(:create_canary, params)
  req.send_request(options)
end

#create_group(params = {}) ⇒ Types::CreateGroupResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_group({
  name: "GroupName", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.group.id #=> String
resp.group.name #=> String
resp.group.arn #=> String
resp.group.tags #=> Hash
resp.group.tags["TagKey"] #=> String
resp.group.created_time #=> Time
resp.group.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    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 (Hash<String,String>) —

    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.

Returns:

See Also:



845
846
847
848
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 845

def create_group(params = {}, options = {})
  req = build_request(:create_group, params)
  req.send_request(options)
end

#delete_canary(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_canary({
  name: "CanaryName", # required
  delete_lambda: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :delete_lambda (Boolean) —

    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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



914
915
916
917
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 914

def delete_canary(params = {}, options = {})
  req = build_request(:delete_canary, params)
  req.send_request(options)
end

#delete_group(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_group({
  group_identifier: "GroupIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_identifier (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



943
944
945
946
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 943

def delete_group(params = {}, options = {})
  req = build_request(:delete_group, params)
  req.send_request(options)
end

#describe_canaries(params = {}) ⇒ Types::DescribeCanariesResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_canaries({
  next_token: "Token",
  max_results: 1,
  names: ["CanaryName"],
})

Response structure


resp.canaries #=> Array
resp.canaries[0].id #=> String
resp.canaries[0].name #=> String
resp.canaries[0].code.source_location_arn #=> String
resp.canaries[0].code.handler #=> String
resp.canaries[0].execution_role_arn #=> String
resp.canaries[0].schedule.expression #=> String
resp.canaries[0].schedule.duration_in_seconds #=> Integer
resp.canaries[0].schedule.retry_config.max_retries #=> Integer
resp.canaries[0].run_config.timeout_in_seconds #=> Integer
resp.canaries[0].run_config.memory_in_mb #=> Integer
resp.canaries[0].run_config.active_tracing #=> Boolean
resp.canaries[0].run_config.ephemeral_storage #=> Integer
resp.canaries[0].success_retention_period_in_days #=> Integer
resp.canaries[0].failure_retention_period_in_days #=> Integer
resp.canaries[0].status.state #=> String, one of "CREATING", "READY", "STARTING", "RUNNING", "UPDATING", "STOPPING", "STOPPED", "ERROR", "DELETING"
resp.canaries[0].status.state_reason #=> String
resp.canaries[0].status.state_reason_code #=> String, one of "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"
resp.canaries[0].timeline.created #=> Time
resp.canaries[0].timeline.last_modified #=> Time
resp.canaries[0].timeline.last_started #=> Time
resp.canaries[0].timeline.last_stopped #=> Time
resp.canaries[0].artifact_s3_location #=> String
resp.canaries[0].engine_arn #=> String
resp.canaries[0].runtime_version #=> String
resp.canaries[0].vpc_config.vpc_id #=> String
resp.canaries[0].vpc_config.subnet_ids #=> Array
resp.canaries[0].vpc_config.subnet_ids[0] #=> String
resp.canaries[0].vpc_config.security_group_ids #=> Array
resp.canaries[0].vpc_config.security_group_ids[0] #=> String
resp.canaries[0].vpc_config.ipv_6_allowed_for_dual_stack #=> Boolean
resp.canaries[0].visual_reference.base_screenshots #=> Array
resp.canaries[0].visual_reference.base_screenshots[0].screenshot_name #=> String
resp.canaries[0].visual_reference.base_screenshots[0].ignore_coordinates #=> Array
resp.canaries[0].visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
resp.canaries[0].visual_reference.base_canary_run_id #=> String
resp.canaries[0].provisioned_resource_cleanup #=> String, one of "AUTOMATIC", "OFF"
resp.canaries[0].tags #=> Hash
resp.canaries[0].tags["TagKey"] #=> String
resp.canaries[0].artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
resp.canaries[0].artifact_config.s3_encryption.kms_key_arn #=> String
resp.canaries[0].dry_run_config.dry_run_id #=> String
resp.canaries[0].dry_run_config.last_dry_run_execution_status #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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 (Integer) —

    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 (Array<String>) —

    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.

Returns:

See Also:



1061
1062
1063
1064
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1061

def describe_canaries(params = {}, options = {})
  req = build_request(:describe_canaries, params)
  req.send_request(options)
end

#describe_canaries_last_run(params = {}) ⇒ Types::DescribeCanariesLastRunResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_canaries_last_run({
  next_token: "Token",
  max_results: 1,
  names: ["CanaryName"],
})

Response structure


resp.canaries_last_run #=> Array
resp.canaries_last_run[0].canary_name #=> String
resp.canaries_last_run[0].last_run.id #=> String
resp.canaries_last_run[0].last_run.scheduled_run_id #=> String
resp.canaries_last_run[0].last_run.retry_attempt #=> Integer
resp.canaries_last_run[0].last_run.name #=> String
resp.canaries_last_run[0].last_run.status.state #=> String, one of "RUNNING", "PASSED", "FAILED"
resp.canaries_last_run[0].last_run.status.state_reason #=> String
resp.canaries_last_run[0].last_run.status.state_reason_code #=> String, one of "CANARY_FAILURE", "EXECUTION_FAILURE"
resp.canaries_last_run[0].last_run.status.test_result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.canaries_last_run[0].last_run.timeline.started #=> Time
resp.canaries_last_run[0].last_run.timeline.completed #=> Time
resp.canaries_last_run[0].last_run.timeline.metric_timestamp_for_run_and_retries #=> Time
resp.canaries_last_run[0].last_run.artifact_s3_location #=> String
resp.canaries_last_run[0].last_run.dry_run_config.dry_run_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (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.

  • :max_results (Integer) —

    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 (Array<String>) —

    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.

Returns:

See Also:



1151
1152
1153
1154
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1151

def describe_canaries_last_run(params = {}, options = {})
  req = build_request(:describe_canaries_last_run, params)
  req.send_request(options)
end

#describe_runtime_versions(params = {}) ⇒ Types::DescribeRuntimeVersionsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_runtime_versions({
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.runtime_versions #=> Array
resp.runtime_versions[0].version_name #=> String
resp.runtime_versions[0].description #=> String
resp.runtime_versions[0].release_date #=> Time
resp.runtime_versions[0].deprecation_date #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (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.

  • :max_results (Integer) —

    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.

Returns:

See Also:



1200
1201
1202
1203
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1200

def describe_runtime_versions(params = {}, options = {})
  req = build_request(:describe_runtime_versions, params)
  req.send_request(options)
end

#disassociate_resource(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.disassociate_resource({
  group_identifier: "GroupIdentifier", # required
  resource_arn: "CanaryArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_identifier (required, String) —

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

  • :resource_arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1229
1230
1231
1232
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1229

def disassociate_resource(params = {}, options = {})
  req = build_request(:disassociate_resource, params)
  req.send_request(options)
end

#get_canary(params = {}) ⇒ Types::GetCanaryResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_canary({
  name: "CanaryName", # required
  dry_run_id: "UUID",
})

Response structure


resp.canary.id #=> String
resp.canary.name #=> String
resp.canary.code.source_location_arn #=> String
resp.canary.code.handler #=> String
resp.canary.execution_role_arn #=> String
resp.canary.schedule.expression #=> String
resp.canary.schedule.duration_in_seconds #=> Integer
resp.canary.schedule.retry_config.max_retries #=> Integer
resp.canary.run_config.timeout_in_seconds #=> Integer
resp.canary.run_config.memory_in_mb #=> Integer
resp.canary.run_config.active_tracing #=> Boolean
resp.canary.run_config.ephemeral_storage #=> Integer
resp.canary.success_retention_period_in_days #=> Integer
resp.canary.failure_retention_period_in_days #=> Integer
resp.canary.status.state #=> String, one of "CREATING", "READY", "STARTING", "RUNNING", "UPDATING", "STOPPING", "STOPPED", "ERROR", "DELETING"
resp.canary.status.state_reason #=> String
resp.canary.status.state_reason_code #=> String, one of "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"
resp.canary.timeline.created #=> Time
resp.canary.timeline.last_modified #=> Time
resp.canary.timeline.last_started #=> Time
resp.canary.timeline.last_stopped #=> Time
resp.canary.artifact_s3_location #=> String
resp.canary.engine_arn #=> String
resp.canary.runtime_version #=> String
resp.canary.vpc_config.vpc_id #=> String
resp.canary.vpc_config.subnet_ids #=> Array
resp.canary.vpc_config.subnet_ids[0] #=> String
resp.canary.vpc_config.security_group_ids #=> Array
resp.canary.vpc_config.security_group_ids[0] #=> String
resp.canary.vpc_config.ipv_6_allowed_for_dual_stack #=> Boolean
resp.canary.visual_reference.base_screenshots #=> Array
resp.canary.visual_reference.base_screenshots[0].screenshot_name #=> String
resp.canary.visual_reference.base_screenshots[0].ignore_coordinates #=> Array
resp.canary.visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
resp.canary.visual_reference.base_canary_run_id #=> String
resp.canary.provisioned_resource_cleanup #=> String, one of "AUTOMATIC", "OFF"
resp.canary.tags #=> Hash
resp.canary.tags["TagKey"] #=> String
resp.canary.artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
resp.canary.artifact_config.s3_encryption.kms_key_arn #=> String
resp.canary.dry_run_config.dry_run_id #=> String
resp.canary.dry_run_config.last_dry_run_execution_status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the canary that you want details for.

  • :dry_run_id (String) —

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

Returns:

See Also:



1309
1310
1311
1312
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1309

def get_canary(params = {}, options = {})
  req = build_request(:get_canary, params)
  req.send_request(options)
end

#get_canary_runs(params = {}) ⇒ Types::GetCanaryRunsResponse

Retrieves a list of runs for a specified canary.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_canary_runs({
  name: "CanaryName", # required
  next_token: "Token",
  max_results: 1,
  dry_run_id: "UUID",
  run_type: "CANARY_RUN", # accepts CANARY_RUN, DRY_RUN
})

Response structure


resp.canary_runs #=> Array
resp.canary_runs[0].id #=> String
resp.canary_runs[0].scheduled_run_id #=> String
resp.canary_runs[0].retry_attempt #=> Integer
resp.canary_runs[0].name #=> String
resp.canary_runs[0].status.state #=> String, one of "RUNNING", "PASSED", "FAILED"
resp.canary_runs[0].status.state_reason #=> String
resp.canary_runs[0].status.state_reason_code #=> String, one of "CANARY_FAILURE", "EXECUTION_FAILURE"
resp.canary_runs[0].status.test_result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.canary_runs[0].timeline.started #=> Time
resp.canary_runs[0].timeline.completed #=> Time
resp.canary_runs[0].timeline.metric_timestamp_for_run_and_retries #=> Time
resp.canary_runs[0].artifact_s3_location #=> String
resp.canary_runs[0].dry_run_config.dry_run_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :next_token (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.

    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 (Integer) —

    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 (String) —

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

  • :run_type (String) —

    • 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

Returns:

See Also:



1391
1392
1393
1394
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1391

def get_canary_runs(params = {}, options = {})
  req = build_request(:get_canary_runs, params)
  req.send_request(options)
end

#get_group(params = {}) ⇒ Types::GetGroupResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_group({
  group_identifier: "GroupIdentifier", # required
})

Response structure


resp.group.id #=> String
resp.group.name #=> String
resp.group.arn #=> String
resp.group.tags #=> Hash
resp.group.tags["TagKey"] #=> String
resp.group.created_time #=> Time
resp.group.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_identifier (required, String) —

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

Returns:

See Also:



1427
1428
1429
1430
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1427

def get_group(params = {}, options = {})
  req = build_request(:get_group, params)
  req.send_request(options)
end

#list_associated_groups(params = {}) ⇒ Types::ListAssociatedGroupsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_associated_groups({
  next_token: "PaginationToken",
  max_results: 1,
  resource_arn: "CanaryArn", # required
})

Response structure


resp.groups #=> Array
resp.groups[0].id #=> String
resp.groups[0].name #=> String
resp.groups[0].arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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 (Integer) —

    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 (required, String) —

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

Returns:

See Also:



1475
1476
1477
1478
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1475

def list_associated_groups(params = {}, options = {})
  req = build_request(:list_associated_groups, params)
  req.send_request(options)
end

#list_group_resources(params = {}) ⇒ Types::ListGroupResourcesResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_group_resources({
  next_token: "PaginationToken",
  max_results: 1,
  group_identifier: "GroupIdentifier", # required
})

Response structure


resp.resources #=> Array
resp.resources[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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 (Integer) —

    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 (required, String) —

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

Returns:

See Also:



1522
1523
1524
1525
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1522

def list_group_resources(params = {}, options = {})
  req = build_request(:list_group_resources, params)
  req.send_request(options)
end

#list_groups(params = {}) ⇒ Types::ListGroupsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_groups({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.groups #=> Array
resp.groups[0].id #=> String
resp.groups[0].name #=> String
resp.groups[0].arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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 (Integer) —

    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.

Returns:

See Also:



1566
1567
1568
1569
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1566

def list_groups(params = {}, options = {})
  req = build_request(:list_groups, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Displays the tags associated with a canary or group.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    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

Returns:

See Also:



1601
1602
1603
1604
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1601

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#start_canary(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.start_canary({
  name: "CanaryName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1634
1635
1636
1637
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1634

def start_canary(params = {}, options = {})
  req = build_request(:start_canary, params)
  req.send_request(options)
end

#start_canary_dry_run(params = {}) ⇒ Types::StartCanaryDryRunResponse

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

Examples:

Request syntax with placeholder values


resp = client.start_canary_dry_run({
  name: "CanaryName", # required
  code: {
    s3_bucket: "String",
    s3_key: "String",
    s3_version: "String",
    zip_file: "data",
    handler: "CodeHandler", # required
  },
  runtime_version: "String",
  run_config: {
    timeout_in_seconds: 1,
    memory_in_mb: 1,
    active_tracing: false,
    environment_variables: {
      "EnvironmentVariableName" => "EnvironmentVariableValue",
    },
    ephemeral_storage: 1,
  },
  vpc_config: {
    subnet_ids: ["SubnetId"],
    security_group_ids: ["SecurityGroupId"],
    ipv_6_allowed_for_dual_stack: false,
  },
  execution_role_arn: "RoleArn",
  success_retention_period_in_days: 1,
  failure_retention_period_in_days: 1,
  visual_reference: {
    base_screenshots: [
      {
        screenshot_name: "String", # required
        ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
      },
    ],
    base_canary_run_id: "String", # required
  },
  artifact_s3_location: "String",
  artifact_config: {
    s3_encryption: {
      encryption_mode: "SSE_S3", # accepts SSE_S3, SSE_KMS
      kms_key_arn: "KmsKeyArn",
    },
  },
  provisioned_resource_cleanup: "AUTOMATIC", # accepts AUTOMATIC, OFF
})

Response structure


resp.dry_run_config.dry_run_id #=> String
resp.dry_run_config.last_dry_run_execution_status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :code (Types::CanaryCodeInput) —

    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.

  • :runtime_version (String) —

    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 (Types::CanaryRunConfigInput) —

    A structure that contains input information for a canary run.

  • :vpc_config (Types::VpcConfigInput) —

    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 (String) —

    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 (Integer) —

    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 (Integer) —

    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 (Types::VisualReferenceInput) —

    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 (String) —

    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 (Types::ArtifactConfigInput) —

    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 (String) —

    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.

Returns:

See Also:



1829
1830
1831
1832
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1829

def start_canary_dry_run(params = {}, options = {})
  req = build_request(:start_canary_dry_run, params)
  req.send_request(options)
end

#stop_canary(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.stop_canary({
  name: "CanaryName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1862
1863
1864
1865
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1862

def stop_canary(params = {}, options = {})
  req = build_request(:stop_canary, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    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 (required, Hash<String,String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1913
1914
1915
1916
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1913

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    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 (required, Array<String>) —

    The list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1945
1946
1947
1948
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 1945

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_canary(params = {}) ⇒ Struct

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

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

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.

Examples:

Request syntax with placeholder values


resp = client.update_canary({
  name: "CanaryName", # required
  code: {
    s3_bucket: "String",
    s3_key: "String",
    s3_version: "String",
    zip_file: "data",
    handler: "CodeHandler", # required
  },
  execution_role_arn: "RoleArn",
  runtime_version: "String",
  schedule: {
    expression: "String", # required
    duration_in_seconds: 1,
    retry_config: {
      max_retries: 1, # required
    },
  },
  run_config: {
    timeout_in_seconds: 1,
    memory_in_mb: 1,
    active_tracing: false,
    environment_variables: {
      "EnvironmentVariableName" => "EnvironmentVariableValue",
    },
    ephemeral_storage: 1,
  },
  success_retention_period_in_days: 1,
  failure_retention_period_in_days: 1,
  vpc_config: {
    subnet_ids: ["SubnetId"],
    security_group_ids: ["SecurityGroupId"],
    ipv_6_allowed_for_dual_stack: false,
  },
  visual_reference: {
    base_screenshots: [
      {
        screenshot_name: "String", # required
        ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
      },
    ],
    base_canary_run_id: "String", # required
  },
  artifact_s3_location: "String",
  artifact_config: {
    s3_encryption: {
      encryption_mode: "SSE_S3", # accepts SSE_S3, SSE_KMS
      kms_key_arn: "KmsKeyArn",
    },
  },
  provisioned_resource_cleanup: "AUTOMATIC", # accepts AUTOMATIC, OFF
  dry_run_id: "UUID",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    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 (Types::CanaryCodeInput) —

    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 (String) —

    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 (String) —

    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 (Types::CanaryScheduleInput) —

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

  • :run_config (Types::CanaryRunConfigInput) —

    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 (Integer) —

    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 (Integer) —

    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 (Types::VpcConfigInput) —

    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 (Types::VisualReferenceInput) —

    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 (String) —

    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 (Types::ArtifactConfigInput) —

    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 (String) —

    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 (String) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2165
2166
2167
2168
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/client.rb', line 2165

def update_canary(params = {}, options = {})
  req = build_request(:update_canary, params)
  req.send_request(options)
end