# frozen_string_literal: true

# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE

require 'seahorse/client/plugins/content_length'
require 'aws-sdk-core/plugins/credentials_configuration'
require 'aws-sdk-core/plugins/logging'
require 'aws-sdk-core/plugins/param_converter'
require 'aws-sdk-core/plugins/param_validator'
require 'aws-sdk-core/plugins/user_agent'
require 'aws-sdk-core/plugins/helpful_socket_errors'
require 'aws-sdk-core/plugins/retry_errors'
require 'aws-sdk-core/plugins/global_configuration'
require 'aws-sdk-core/plugins/regional_endpoint'
require 'aws-sdk-core/plugins/endpoint_discovery'
require 'aws-sdk-core/plugins/endpoint_pattern'
require 'aws-sdk-core/plugins/response_paging'
require 'aws-sdk-core/plugins/stub_responses'
require 'aws-sdk-core/plugins/idempotency_token'
require 'aws-sdk-core/plugins/invocation_id'
require 'aws-sdk-core/plugins/jsonvalue_converter'
require 'aws-sdk-core/plugins/client_metrics_plugin'
require 'aws-sdk-core/plugins/client_metrics_send_plugin'
require 'aws-sdk-core/plugins/transfer_encoding'
require 'aws-sdk-core/plugins/http_checksum'
require 'aws-sdk-core/plugins/checksum_algorithm'
require 'aws-sdk-core/plugins/request_compression'
require 'aws-sdk-core/plugins/defaults_mode'
require 'aws-sdk-core/plugins/recursion_detection'
require 'aws-sdk-core/plugins/telemetry'
require 'aws-sdk-core/plugins/sign'
require 'aws-sdk-core/plugins/protocols/rest_json'

module Aws::Synthetics
  # 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
  #
  # See {#initialize} for a full list of supported configuration options.
  class Client < Seahorse::Client::Base

    include Aws::ClientStubs

    @identifier = :synthetics

    set_api(ClientApi::API)

    add_plugin(Seahorse::Client::Plugins::ContentLength)
    add_plugin(Aws::Plugins::CredentialsConfiguration)
    add_plugin(Aws::Plugins::Logging)
    add_plugin(Aws::Plugins::ParamConverter)
    add_plugin(Aws::Plugins::ParamValidator)
    add_plugin(Aws::Plugins::UserAgent)
    add_plugin(Aws::Plugins::HelpfulSocketErrors)
    add_plugin(Aws::Plugins::RetryErrors)
    add_plugin(Aws::Plugins::GlobalConfiguration)
    add_plugin(Aws::Plugins::RegionalEndpoint)
    add_plugin(Aws::Plugins::EndpointDiscovery)
    add_plugin(Aws::Plugins::EndpointPattern)
    add_plugin(Aws::Plugins::ResponsePaging)
    add_plugin(Aws::Plugins::StubResponses)
    add_plugin(Aws::Plugins::IdempotencyToken)
    add_plugin(Aws::Plugins::InvocationId)
    add_plugin(Aws::Plugins::JsonvalueConverter)
    add_plugin(Aws::Plugins::ClientMetricsPlugin)
    add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
    add_plugin(Aws::Plugins::TransferEncoding)
    add_plugin(Aws::Plugins::HttpChecksum)
    add_plugin(Aws::Plugins::ChecksumAlgorithm)
    add_plugin(Aws::Plugins::RequestCompression)
    add_plugin(Aws::Plugins::DefaultsMode)
    add_plugin(Aws::Plugins::RecursionDetection)
    add_plugin(Aws::Plugins::Telemetry)
    add_plugin(Aws::Plugins::Sign)
    add_plugin(Aws::Plugins::Protocols::RestJson)
    add_plugin(Aws::Synthetics::Plugins::Endpoints)

    # @overload initialize(options)
    #   @param [Hash] options
    #
    #   @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
    #     A list of plugins to apply to the client. Each plugin is either a
    #     class name or an instance of a plugin class.
    #
    #   @option options [required, Aws::CredentialProvider] :credentials
    #     Your AWS credentials used for authentication. This can be any class that includes and implements
    #     `Aws::CredentialProvider`, or 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`.
    #
    #   @option options [required, String] :region
    #     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`
    #
    #   @option options [String] :access_key_id
    #
    #   @option options [String] :account_id
    #
    #   @option options [Boolean] :active_endpoint_cache (false)
    #     When set to `true`, a thread polling for endpoints will be running in
    #     the background every 60 secs (default). Defaults to `false`.
    #
    #   @option options [Boolean] :adaptive_retry_wait_to_fill (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.
    #
    #   @option options [Array<String>] :auth_scheme_preference
    #     A list of preferred authentication schemes to use when making a request. Supported values are:
    #     `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
    #     shared config as `auth_scheme_preference`, the value should be a comma-separated list.
    #
    #   @option options [Boolean] :client_side_monitoring (false)
    #     When `true`, client-side metrics will be collected for all API requests from
    #     this client.
    #
    #   @option options [String] :client_side_monitoring_client_id ("")
    #     Allows you to provide an identifier for this client which will be attached to
    #     all generated client side metrics. Defaults to an empty string.
    #
    #   @option options [String] :client_side_monitoring_host ("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.
    #
    #   @option options [Integer] :client_side_monitoring_port (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.
    #
    #   @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
    #     Allows you to provide a custom client-side monitoring publisher class. By default,
    #     will use the Client Side Monitoring Agent Publisher.
    #
    #   @option options [Boolean] :convert_params (true)
    #     When `true`, an attempt is made to coerce request parameters into
    #     the required types.
    #
    #   @option options [Boolean] :correct_clock_skew (true)
    #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
    #     a clock skew correction and retry requests with skewed client clocks.
    #
    #   @option options [String] :defaults_mode ("legacy")
    #     See {Aws::DefaultsModeConfiguration} for a list of the
    #     accepted modes and the configuration defaults that are included.
    #
    #   @option options [Boolean] :disable_host_prefix_injection (false)
    #     When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
    #
    #   @option options [Boolean] :disable_request_compression (false)
    #     When set to 'true' the request body will not be compressed
    #     for supported operations.
    #
    #   @option options [String, URI::HTTPS, URI::HTTP] :endpoint
    #     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'
    #
    #   @option options [Integer] :endpoint_cache_max_entries (1000)
    #     Used for the maximum size limit of the LRU cache storing endpoints data
    #     for endpoint discovery enabled operations. Defaults to 1000.
    #
    #   @option options [Integer] :endpoint_cache_max_threads (10)
    #     Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
    #
    #   @option options [Integer] :endpoint_cache_poll_interval (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.
    #
    #   @option options [Boolean] :endpoint_discovery (false)
    #     When set to `true`, endpoint discovery will be enabled for operations when available.
    #
    #   @option options [Boolean] :ignore_configured_endpoint_urls
    #     Setting to true disables use of endpoint URLs provided via environment
    #     variables and the shared configuration file.
    #
    #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
    #     The log formatter.
    #
    #   @option options [Symbol] :log_level (:info)
    #     The log level to send messages to the `:logger` at.
    #
    #   @option options [Logger] :logger
    #     The Logger instance to send log messages to.  If this option
    #     is not set, logging will be disabled.
    #
    #   @option options [Integer] :max_attempts (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.
    #
    #   @option options [String] :profile ("default")
    #     Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
    #     When not specified, 'default' is used.
    #
    #   @option options [String] :request_checksum_calculation ("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.
    #
    #   @option options [Integer] :request_min_compression_size_bytes (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.
    #
    #   @option options [String] :response_checksum_validation ("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`.
    #
    #   @option options [Proc] :retry_backoff
    #     A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
    #     This option is only used in the `legacy` retry mode.
    #
    #   @option options [Float] :retry_base_delay (0.3)
    #     The base delay in seconds used by the default backoff function. This option
    #     is only used in the `legacy` retry mode.
    #
    #   @option options [Symbol] :retry_jitter (: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
    #
    #   @option options [Integer] :retry_limit (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.
    #
    #   @option options [Integer] :retry_max_delay (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.
    #
    #   @option options [String] :retry_mode ("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.
    #
    #   @option options [String] :sdk_ua_app_id
    #     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.
    #
    #   @option options [String] :secret_access_key
    #
    #   @option options [String] :session_token
    #
    #   @option options [Array] :sigv4a_signing_region_set
    #     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`
    #
    #   @option options [Boolean] :stub_responses (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.
    #
    #   @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (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.
    #
    #   @option options [Aws::TokenProvider] :token_provider
    #     Your Bearer token used for authentication. This can be any class that includes and implements
    #     `Aws::TokenProvider`, or 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.
    #
    #   @option options [Boolean] :use_dualstack_endpoint
    #     When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
    #     will be used if available.
    #
    #   @option options [Boolean] :use_fips_endpoint
    #     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`.
    #
    #   @option options [Boolean] :validate_params (true)
    #     When `true`, request parameters are validated before
    #     sending the request.
    #
    #   @option options [Aws::Synthetics::EndpointProvider] :endpoint_provider
    #     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`.
    #
    #   @option options [Float] :http_continue_timeout (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.
    #
    #   @option options [Float] :http_idle_timeout (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.
    #
    #   @option options [Float] :http_open_timeout (15)
    #     The default number of seconds to wait for response data.
    #     This value can safely be set per-request on the session.
    #
    #   @option options [URI::HTTP,String] :http_proxy
    #     A proxy to send requests through.  Formatted like 'http://proxy.com:123'.
    #
    #   @option options [Float] :http_read_timeout (60)
    #     The default number of seconds to wait for response data.
    #     This value can safely be set per-request on the session.
    #
    #   @option options [Boolean] :http_wire_trace (false)
    #     When `true`,  HTTP debug output will be sent to the `:logger`.
    #
    #   @option options [Proc] :on_chunk_received
    #     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`).
    #
    #   @option options [Proc] :on_chunk_sent
    #     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.
    #
    #   @option options [Boolean] :raise_response_errors (true)
    #     When `true`, response errors are raised.
    #
    #   @option options [String] :ssl_ca_bundle
    #     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.
    #
    #   @option options [String] :ssl_ca_directory
    #     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.
    #
    #   @option options [String] :ssl_ca_store
    #     Sets the X509::Store to verify peer certificate.
    #
    #   @option options [OpenSSL::X509::Certificate] :ssl_cert
    #     Sets a client certificate when creating http connections.
    #
    #   @option options [OpenSSL::PKey] :ssl_key
    #     Sets a client key when creating http connections.
    #
    #   @option options [Float] :ssl_timeout
    #     Sets the SSL timeout in seconds
    #
    #   @option options [Boolean] :ssl_verify_peer (true)
    #     When `true`, SSL peer certificates are verified when establishing a connection.
    #
    def initialize(*args)
      super
    end

    # @!group API Operations

    # 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.
    #
    # @option params [required, String] :group_identifier
    #   Specifies the group. You can specify the group name, the ARN, or the
    #   group ID as the `GroupIdentifier`.
    #
    # @option params [required, String] :resource_arn
    #   The ARN of the canary that you want to associate with the specified
    #   group.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.associate_resource({
    #     group_identifier: "GroupIdentifier", # required
    #     resource_arn: "CanaryArn", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/AssociateResource AWS API Documentation
    #
    # @overload associate_resource(params = {})
    # @param [Hash] params ({})
    def associate_resource(params = {}, options = {})
      req = build_request(:associate_resource, params)
      req.send_request(options)
    end

    # 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][1] 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][2].
    #
    # 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][3].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_UpdateCanary.html
    # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Roles
    # [3]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html
    #
    # @option params [required, String] :name
    #   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][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html
    #
    # @option params [required, Types::CanaryCodeInput] :code
    #   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.
    #
    # @option params [required, String] :artifact_s3_location
    #   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 (.).
    #
    # @option params [required, String] :execution_role_arn
    #   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`
    #
    # @option params [required, Types::CanaryScheduleInput] :schedule
    #   A structure that contains information about how often the canary is to
    #   run and when these test runs are to stop.
    #
    # @option params [Types::CanaryRunConfigInput] :run_config
    #   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.
    #
    # @option params [Integer] :success_retention_period_in_days
    #   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][1], as well as the range of information displayed in
    #   the Synthetics console.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
    #
    # @option params [Integer] :failure_retention_period_in_days
    #   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][1], as well as the range of information displayed in
    #   the Synthetics console.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
    #
    # @option params [required, String] :runtime_version
    #   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][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html
    #
    # @option params [Types::VpcConfigInput] :vpc_config
    #   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][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
    #
    # @option params [Array<String>] :resources_to_replicate_tags
    #   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.
    #
    # @option params [String] :provisioned_resource_cleanup
    #   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][1] operation determines
    #   whether the Lambda functions and layers will be deleted.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
    #
    # @option params [Array<Types::BrowserConfig>] :browser_configs
    #   CloudWatch Synthetics now supports multibrowser canaries for
    #   `syn-nodejs-puppeteer-11.0` and `syn-nodejs-playwright-3.0` runtimes.
    #   This feature allows you to run your canaries on both Firefox and
    #   Chrome browsers. To create a multibrowser canary, you need to specify
    #   the BrowserConfigs with a list of browsers you want to use.
    #
    #   <note markdown="1"> If not specified, `browserConfigs` defaults to Chrome.
    #
    #    </note>
    #
    # @option params [Hash<String,String>] :tags
    #   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`.
    #
    # @option params [Types::ArtifactConfigInput] :artifact_config
    #   A structure that contains the configuration for canary artifacts,
    #   including the encryption-at-rest settings for artifacts that the
    #   canary uploads to Amazon S3.
    #
    # @return [Types::CreateCanaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::CreateCanaryResponse#canary #canary} => Types::Canary
    #
    # @example 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",
    #       blueprint_types: ["BlueprintType"],
    #       dependencies: [
    #         {
    #           type: "LambdaLayer", # accepts LambdaLayer
    #           reference: "String", # 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
    #     browser_configs: [
    #       {
    #         browser_type: "CHROME", # accepts CHROME, FIREFOX
    #       },
    #     ],
    #     tags: {
    #       "TagKey" => "TagValue",
    #     },
    #     artifact_config: {
    #       s3_encryption: {
    #         encryption_mode: "SSE_S3", # accepts SSE_S3, SSE_KMS
    #         kms_key_arn: "KmsKeyArn",
    #       },
    #     },
    #   })
    #
    # @example Response structure
    #
    #   resp.canary.id #=> String
    #   resp.canary.name #=> String
    #   resp.canary.code.source_location_arn #=> String
    #   resp.canary.code.handler #=> String
    #   resp.canary.code.blueprint_types #=> Array
    #   resp.canary.code.blueprint_types[0] #=> String
    #   resp.canary.code.dependencies #=> Array
    #   resp.canary.code.dependencies[0].type #=> String, one of "LambdaLayer"
    #   resp.canary.code.dependencies[0].reference #=> 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.visual_reference.browser_type #=> String, one of "CHROME", "FIREFOX"
    #   resp.canary.provisioned_resource_cleanup #=> String, one of "AUTOMATIC", "OFF"
    #   resp.canary.browser_configs #=> Array
    #   resp.canary.browser_configs[0].browser_type #=> String, one of "CHROME", "FIREFOX"
    #   resp.canary.engine_configs #=> Array
    #   resp.canary.engine_configs[0].engine_arn #=> String
    #   resp.canary.engine_configs[0].browser_type #=> String, one of "CHROME", "FIREFOX"
    #   resp.canary.visual_references #=> Array
    #   resp.canary.visual_references[0].base_screenshots #=> Array
    #   resp.canary.visual_references[0].base_screenshots[0].screenshot_name #=> String
    #   resp.canary.visual_references[0].base_screenshots[0].ignore_coordinates #=> Array
    #   resp.canary.visual_references[0].base_screenshots[0].ignore_coordinates[0] #=> String
    #   resp.canary.visual_references[0].base_canary_run_id #=> String
    #   resp.canary.visual_references[0].browser_type #=> String, one of "CHROME", "FIREFOX"
    #   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
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CreateCanary AWS API Documentation
    #
    # @overload create_canary(params = {})
    # @param [Hash] params ({})
    def create_canary(params = {}, options = {})
      req = build_request(:create_canary, params)
      req.send_request(options)
    end

    # 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][1].
    #
    # 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.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable
    #
    # @option params [required, String] :name
    #   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.
    #
    # @option params [Hash<String,String>] :tags
    #   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.
    #
    # @return [Types::CreateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::CreateGroupResponse#group #group} => Types::Group
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_group({
    #     name: "GroupName", # required
    #     tags: {
    #       "TagKey" => "TagValue",
    #     },
    #   })
    #
    # @example 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
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CreateGroup AWS API Documentation
    #
    # @overload create_group(params = {})
    # @param [Hash] params ({})
    def create_group(params = {}, options = {})
      req = build_request(:create_group, params)
      req.send_request(options)
    end

    # 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.
    #
    # @option params [required, String] :name
    #   The name of the canary that you want to delete. To find the names of
    #   your canaries, use [DescribeCanaries][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html
    #
    # @option params [Boolean] :delete_lambda
    #   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
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_canary({
    #     name: "CanaryName", # required
    #     delete_lambda: false,
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DeleteCanary AWS API Documentation
    #
    # @overload delete_canary(params = {})
    # @param [Hash] params ({})
    def delete_canary(params = {}, options = {})
      req = build_request(:delete_canary, params)
      req.send_request(options)
    end

    # 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.
    #
    # @option params [required, String] :group_identifier
    #   Specifies which group to delete. You can specify the group name, the
    #   ARN, or the group ID as the `GroupIdentifier`.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_group({
    #     group_identifier: "GroupIdentifier", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DeleteGroup AWS API Documentation
    #
    # @overload delete_group(params = {})
    # @param [Hash] params ({})
    def delete_group(params = {}, options = {})
      req = build_request(:delete_group, params)
      req.send_request(options)
    end

    # 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][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html
    #
    # @option params [String] :next_token
    #   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.
    #
    # @option params [Integer] :max_results
    #   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.
    #
    # @option params [Array<String>] :names
    #   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][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html
    #
    # @return [Types::DescribeCanariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::DescribeCanariesResponse#canaries #canaries} => Array&lt;Types::Canary&gt;
    #   * {Types::DescribeCanariesResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.describe_canaries({
    #     next_token: "Token",
    #     max_results: 1,
    #     names: ["CanaryName"],
    #   })
    #
    # @example 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].code.blueprint_types #=> Array
    #   resp.canaries[0].code.blueprint_types[0] #=> String
    #   resp.canaries[0].code.dependencies #=> Array
    #   resp.canaries[0].code.dependencies[0].type #=> String, one of "LambdaLayer"
    #   resp.canaries[0].code.dependencies[0].reference #=> 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].visual_reference.browser_type #=> String, one of "CHROME", "FIREFOX"
    #   resp.canaries[0].provisioned_resource_cleanup #=> String, one of "AUTOMATIC", "OFF"
    #   resp.canaries[0].browser_configs #=> Array
    #   resp.canaries[0].browser_configs[0].browser_type #=> String, one of "CHROME", "FIREFOX"
    #   resp.canaries[0].engine_configs #=> Array
    #   resp.canaries[0].engine_configs[0].engine_arn #=> String
    #   resp.canaries[0].engine_configs[0].browser_type #=> String, one of "CHROME", "FIREFOX"
    #   resp.canaries[0].visual_references #=> Array
    #   resp.canaries[0].visual_references[0].base_screenshots #=> Array
    #   resp.canaries[0].visual_references[0].base_screenshots[0].screenshot_name #=> String
    #   resp.canaries[0].visual_references[0].base_screenshots[0].ignore_coordinates #=> Array
    #   resp.canaries[0].visual_references[0].base_screenshots[0].ignore_coordinates[0] #=> String
    #   resp.canaries[0].visual_references[0].base_canary_run_id #=> String
    #   resp.canaries[0].visual_references[0].browser_type #=> String, one of "CHROME", "FIREFOX"
    #   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
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeCanaries AWS API Documentation
    #
    # @overload describe_canaries(params = {})
    # @param [Hash] params ({})
    def describe_canaries(params = {}, options = {})
      req = build_request(:describe_canaries, params)
      req.send_request(options)
    end

    # 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][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html
    #
    # @option params [String] :next_token
    #   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.
    #
    # @option params [Integer] :max_results
    #   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.
    #
    # @option params [Array<String>] :names
    #   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][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html
    #
    # @option params [String] :browser_type
    #   The type of browser to use for the canary run.
    #
    # @return [Types::DescribeCanariesLastRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::DescribeCanariesLastRunResponse#canaries_last_run #canaries_last_run} => Array&lt;Types::CanaryLastRun&gt;
    #   * {Types::DescribeCanariesLastRunResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.describe_canaries_last_run({
    #     next_token: "Token",
    #     max_results: 1,
    #     names: ["CanaryName"],
    #     browser_type: "CHROME", # accepts CHROME, FIREFOX
    #   })
    #
    # @example 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.canaries_last_run[0].last_run.browser_type #=> String, one of "CHROME", "FIREFOX"
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeCanariesLastRun AWS API Documentation
    #
    # @overload describe_canaries_last_run(params = {})
    # @param [Hash] params ({})
    def describe_canaries_last_run(params = {}, options = {})
      req = build_request(:describe_canaries_last_run, params)
      req.send_request(options)
    end

    # Returns a list of Synthetics canary runtime versions. For more
    # information, see [ Canary Runtime Versions][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html
    #
    # @option params [String] :next_token
    #   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.
    #
    # @option params [Integer] :max_results
    #   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.
    #
    # @return [Types::DescribeRuntimeVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::DescribeRuntimeVersionsResponse#runtime_versions #runtime_versions} => Array&lt;Types::RuntimeVersion&gt;
    #   * {Types::DescribeRuntimeVersionsResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.describe_runtime_versions({
    #     next_token: "Token",
    #     max_results: 1,
    #   })
    #
    # @example 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
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeRuntimeVersions AWS API Documentation
    #
    # @overload describe_runtime_versions(params = {})
    # @param [Hash] params ({})
    def describe_runtime_versions(params = {}, options = {})
      req = build_request(:describe_runtime_versions, params)
      req.send_request(options)
    end

    # Removes a canary from a group. You must run this operation in the
    # Region where the canary exists.
    #
    # @option params [required, String] :group_identifier
    #   Specifies the group. You can specify the group name, the ARN, or the
    #   group ID as the `GroupIdentifier`.
    #
    # @option params [required, String] :resource_arn
    #   The ARN of the canary that you want to remove from the specified
    #   group.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.disassociate_resource({
    #     group_identifier: "GroupIdentifier", # required
    #     resource_arn: "CanaryArn", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DisassociateResource AWS API Documentation
    #
    # @overload disassociate_resource(params = {})
    # @param [Hash] params ({})
    def disassociate_resource(params = {}, options = {})
      req = build_request(:disassociate_resource, params)
      req.send_request(options)
    end

    # 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][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html
    #
    # @option params [required, String] :name
    #   The name of the canary that you want details for.
    #
    # @option params [String] :dry_run_id
    #   The DryRunId associated with an existing canary’s dry run. You can use
    #   this DryRunId to retrieve information about the dry run.
    #
    # @return [Types::GetCanaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetCanaryResponse#canary #canary} => Types::Canary
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_canary({
    #     name: "CanaryName", # required
    #     dry_run_id: "UUID",
    #   })
    #
    # @example Response structure
    #
    #   resp.canary.id #=> String
    #   resp.canary.name #=> String
    #   resp.canary.code.source_location_arn #=> String
    #   resp.canary.code.handler #=> String
    #   resp.canary.code.blueprint_types #=> Array
    #   resp.canary.code.blueprint_types[0] #=> String
    #   resp.canary.code.dependencies #=> Array
    #   resp.canary.code.dependencies[0].type #=> String, one of "LambdaLayer"
    #   resp.canary.code.dependencies[0].reference #=> 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.visual_reference.browser_type #=> String, one of "CHROME", "FIREFOX"
    #   resp.canary.provisioned_resource_cleanup #=> String, one of "AUTOMATIC", "OFF"
    #   resp.canary.browser_configs #=> Array
    #   resp.canary.browser_configs[0].browser_type #=> String, one of "CHROME", "FIREFOX"
    #   resp.canary.engine_configs #=> Array
    #   resp.canary.engine_configs[0].engine_arn #=> String
    #   resp.canary.engine_configs[0].browser_type #=> String, one of "CHROME", "FIREFOX"
    #   resp.canary.visual_references #=> Array
    #   resp.canary.visual_references[0].base_screenshots #=> Array
    #   resp.canary.visual_references[0].base_screenshots[0].screenshot_name #=> String
    #   resp.canary.visual_references[0].base_screenshots[0].ignore_coordinates #=> Array
    #   resp.canary.visual_references[0].base_screenshots[0].ignore_coordinates[0] #=> String
    #   resp.canary.visual_references[0].base_canary_run_id #=> String
    #   resp.canary.visual_references[0].browser_type #=> String, one of "CHROME", "FIREFOX"
    #   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
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanary AWS API Documentation
    #
    # @overload get_canary(params = {})
    # @param [Hash] params ({})
    def get_canary(params = {}, options = {})
      req = build_request(:get_canary, params)
      req.send_request(options)
    end

    # Retrieves a list of runs for a specified canary.
    #
    # @option params [required, String] :name
    #   The name of the canary that you want to see runs for.
    #
    # @option params [String] :next_token
    #   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.
    #
    #   <note markdown="1"> 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.
    #
    #    </note>
    #
    # @option params [Integer] :max_results
    #   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.
    #
    # @option params [String] :dry_run_id
    #   The DryRunId associated with an existing canary’s dry run. You can use
    #   this DryRunId to retrieve information about the dry run.
    #
    # @option params [String] :run_type
    #   * 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
    #
    # @return [Types::GetCanaryRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetCanaryRunsResponse#canary_runs #canary_runs} => Array&lt;Types::CanaryRun&gt;
    #   * {Types::GetCanaryRunsResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example 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
    #   })
    #
    # @example 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.canary_runs[0].browser_type #=> String, one of "CHROME", "FIREFOX"
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanaryRuns AWS API Documentation
    #
    # @overload get_canary_runs(params = {})
    # @param [Hash] params ({})
    def get_canary_runs(params = {}, options = {})
      req = build_request(:get_canary_runs, params)
      req.send_request(options)
    end

    # Returns information about one group. Groups are a global resource, so
    # you can use this operation from any Region.
    #
    # @option params [required, String] :group_identifier
    #   Specifies the group to return information for. You can specify the
    #   group name, the ARN, or the group ID as the `GroupIdentifier`.
    #
    # @return [Types::GetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetGroupResponse#group #group} => Types::Group
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_group({
    #     group_identifier: "GroupIdentifier", # required
    #   })
    #
    # @example 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
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetGroup AWS API Documentation
    #
    # @overload get_group(params = {})
    # @param [Hash] params ({})
    def get_group(params = {}, options = {})
      req = build_request(:get_group, params)
      req.send_request(options)
    end

    # Returns a list of the groups that the specified canary is associated
    # with. The canary that you specify must be in the current Region.
    #
    # @option params [String] :next_token
    #   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.
    #
    # @option params [Integer] :max_results
    #   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.
    #
    # @option params [required, String] :resource_arn
    #   The ARN of the canary that you want to view groups for.
    #
    # @return [Types::ListAssociatedGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListAssociatedGroupsResponse#groups #groups} => Array&lt;Types::GroupSummary&gt;
    #   * {Types::ListAssociatedGroupsResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_associated_groups({
    #     next_token: "PaginationToken",
    #     max_results: 1,
    #     resource_arn: "CanaryArn", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.groups #=> Array
    #   resp.groups[0].id #=> String
    #   resp.groups[0].name #=> String
    #   resp.groups[0].arn #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListAssociatedGroups AWS API Documentation
    #
    # @overload list_associated_groups(params = {})
    # @param [Hash] params ({})
    def list_associated_groups(params = {}, options = {})
      req = build_request(:list_associated_groups, params)
      req.send_request(options)
    end

    # This operation returns a list of the ARNs of the canaries that are
    # associated with the specified group.
    #
    # @option params [String] :next_token
    #   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.
    #
    # @option params [Integer] :max_results
    #   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.
    #
    # @option params [required, String] :group_identifier
    #   Specifies the group to return information for. You can specify the
    #   group name, the ARN, or the group ID as the `GroupIdentifier`.
    #
    # @return [Types::ListGroupResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListGroupResourcesResponse#resources #resources} => Array&lt;String&gt;
    #   * {Types::ListGroupResourcesResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_group_resources({
    #     next_token: "PaginationToken",
    #     max_results: 1,
    #     group_identifier: "GroupIdentifier", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.resources #=> Array
    #   resp.resources[0] #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroupResources AWS API Documentation
    #
    # @overload list_group_resources(params = {})
    # @param [Hash] params ({})
    def list_group_resources(params = {}, options = {})
      req = build_request(:list_group_resources, params)
      req.send_request(options)
    end

    # Returns a list of all groups in the account, displaying their names,
    # unique IDs, and ARNs. The groups from all Regions are returned.
    #
    # @option params [String] :next_token
    #   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.
    #
    # @option params [Integer] :max_results
    #   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.
    #
    # @return [Types::ListGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListGroupsResponse#groups #groups} => Array&lt;Types::GroupSummary&gt;
    #   * {Types::ListGroupsResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_groups({
    #     next_token: "PaginationToken",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.groups #=> Array
    #   resp.groups[0].id #=> String
    #   resp.groups[0].name #=> String
    #   resp.groups[0].arn #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroups AWS API Documentation
    #
    # @overload list_groups(params = {})
    # @param [Hash] params ({})
    def list_groups(params = {}, options = {})
      req = build_request(:list_groups, params)
      req.send_request(options)
    end

    # Displays the tags associated with a canary or group.
    #
    # @option params [required, String] :resource_arn
    #   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 `
    #
    # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_tags_for_resource({
    #     resource_arn: "ResourceArn", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.tags #=> Hash
    #   resp.tags["TagKey"] #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListTagsForResource AWS API Documentation
    #
    # @overload list_tags_for_resource(params = {})
    # @param [Hash] params ({})
    def list_tags_for_resource(params = {}, options = {})
      req = build_request(:list_tags_for_resource, params)
      req.send_request(options)
    end

    # 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][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanary.html
    #
    # @option params [required, String] :name
    #   The name of the canary that you want to run. To find canary names, use
    #   [DescribeCanaries][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.start_canary({
    #     name: "CanaryName", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/StartCanary AWS API Documentation
    #
    # @overload start_canary(params = {})
    # @param [Hash] params ({})
    def start_canary(params = {}, options = {})
      req = build_request(:start_canary, params)
      req.send_request(options)
    end

    # Use this operation to start a dry run for a canary that has already
    # been created
    #
    # @option params [required, String] :name
    #   The name of the canary that you want to dry run. To find canary names,
    #   use [DescribeCanaries][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html
    #
    # @option params [Types::CanaryCodeInput] :code
    #   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][1]
    #
    #   * 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][2]
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Nodejs.html#CloudWatch_Synthetics_Canaries_package
    #   [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Python.html#CloudWatch_Synthetics_Canaries_WritingCanary_Python_package
    #
    # @option params [String] :runtime_version
    #   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][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html
    #
    # @option params [Types::CanaryRunConfigInput] :run_config
    #   A structure that contains input information for a canary run.
    #
    # @option params [Types::VpcConfigInput] :vpc_config
    #   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][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
    #
    # @option params [String] :execution_role_arn
    #   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:
    #
    # @option params [Integer] :success_retention_period_in_days
    #   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][1], as well as the range of information displayed in
    #   the Synthetics console.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
    #
    # @option params [Integer] :failure_retention_period_in_days
    #   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][1], as well as the range of information displayed in
    #   the Synthetics console.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
    #
    # @option params [Types::VisualReferenceInput] :visual_reference
    #   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][1] and [ Visual monitoring blueprint][2]
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html
    #   [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html
    #
    # @option params [String] :artifact_s3_location
    #   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 (.).
    #
    # @option params [Types::ArtifactConfigInput] :artifact_config
    #   A structure that contains the configuration for canary artifacts,
    #   including the encryption-at-rest settings for artifacts that the
    #   canary uploads to Amazon S3.
    #
    # @option params [String] :provisioned_resource_cleanup
    #   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][1] operation determines
    #   whether the Lambda functions and layers will be deleted.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
    #
    # @option params [Array<Types::BrowserConfig>] :browser_configs
    #   A structure that specifies the browser type to use for a canary run.
    #   CloudWatch Synthetics supports running canaries on both `CHROME` and
    #   `FIREFOX` browsers.
    #
    #   <note markdown="1"> If not specified, `browserConfigs` defaults to Chrome.
    #
    #    </note>
    #
    # @option params [Array<Types::VisualReferenceInput>] :visual_references
    #   A list of visual reference configurations for the canary, one for each
    #   browser type that the canary is configured to run on. Visual
    #   references are used for visual monitoring comparisons.
    #
    #   `syn-nodejs-puppeteer-11.0` and above, and `syn-nodejs-playwright-3.0`
    #   and above, only supports `visualReferences`. `visualReference` field
    #   is not supported.
    #
    #   Versions older than `syn-nodejs-puppeteer-11.0` supports both
    #   `visualReference` and `visualReferences` for backward compatibility.
    #   It is recommended to use `visualReferences` for consistency and future
    #   compatibility.
    #
    # @return [Types::StartCanaryDryRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::StartCanaryDryRunResponse#dry_run_config #dry_run_config} => Types::DryRunConfigOutput
    #
    # @example 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",
    #       blueprint_types: ["BlueprintType"],
    #       dependencies: [
    #         {
    #           type: "LambdaLayer", # accepts LambdaLayer
    #           reference: "String", # 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
    #       browser_type: "CHROME", # accepts CHROME, FIREFOX
    #     },
    #     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
    #     browser_configs: [
    #       {
    #         browser_type: "CHROME", # accepts CHROME, FIREFOX
    #       },
    #     ],
    #     visual_references: [
    #       {
    #         base_screenshots: [
    #           {
    #             screenshot_name: "String", # required
    #             ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
    #           },
    #         ],
    #         base_canary_run_id: "String", # required
    #         browser_type: "CHROME", # accepts CHROME, FIREFOX
    #       },
    #     ],
    #   })
    #
    # @example Response structure
    #
    #   resp.dry_run_config.dry_run_id #=> String
    #   resp.dry_run_config.last_dry_run_execution_status #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/StartCanaryDryRun AWS API Documentation
    #
    # @overload start_canary_dry_run(params = {})
    # @param [Hash] params ({})
    def start_canary_dry_run(params = {}, options = {})
      req = build_request(:start_canary_dry_run, params)
      req.send_request(options)
    end

    # 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.
    #
    # @option params [required, String] :name
    #   The name of the canary that you want to stop. To find the names of
    #   your canaries, use [ListCanaries][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.stop_canary({
    #     name: "CanaryName", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/StopCanary AWS API Documentation
    #
    # @overload stop_canary(params = {})
    # @param [Hash] params ({})
    def stop_canary(params = {}, options = {})
      req = build_request(:stop_canary, params)
      req.send_request(options)
    end

    # 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.
    #
    # @option params [required, String] :resource_arn
    #   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 `
    #
    # @option params [required, Hash<String,String>] :tags
    #   The list of key-value pairs to associate with the resource.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.tag_resource({
    #     resource_arn: "ResourceArn", # required
    #     tags: { # required
    #       "TagKey" => "TagValue",
    #     },
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/TagResource AWS API Documentation
    #
    # @overload tag_resource(params = {})
    # @param [Hash] params ({})
    def tag_resource(params = {}, options = {})
      req = build_request(:tag_resource, params)
      req.send_request(options)
    end

    # Removes one or more tags from the specified resource.
    #
    # @option params [required, String] :resource_arn
    #   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 `
    #
    # @option params [required, Array<String>] :tag_keys
    #   The list of tag keys to remove from the resource.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.untag_resource({
    #     resource_arn: "ResourceArn", # required
    #     tag_keys: ["TagKey"], # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UntagResource AWS API Documentation
    #
    # @overload untag_resource(params = {})
    # @param [Hash] params ({})
    def untag_resource(params = {}, options = {})
      req = build_request(:untag_resource, params)
      req.send_request(options)
    end

    # Updates the configuration of a canary that has already been created.
    #
    # For multibrowser canaries, you can add or remove browsers by updating
    # the browserConfig list in the update call. For example:
    #
    # * To add Firefox to a canary that currently uses Chrome, specify
    #   browserConfigs as \[CHROME, FIREFOX\]
    #
    # * To remove Firefox and keep only Chrome, specify browserConfigs as
    #   \[CHROME\]
    #
    # You can't use this operation to update the tags of an existing
    # canary. To change the tags of an existing canary, use
    # [TagResource][1].
    #
    # <note markdown="1"> 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.
    #
    #  </note>
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_TagResource.html
    #
    # @option params [required, String] :name
    #   The name of the canary that you want to update. To find the names of
    #   your canaries, use [DescribeCanaries][1].
    #
    #   You cannot change the name of a canary that has already been created.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html
    #
    # @option params [Types::CanaryCodeInput] :code
    #   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.
    #
    # @option params [String] :execution_role_arn
    #   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`
    #
    # @option params [String] :runtime_version
    #   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][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html
    #
    # @option params [Types::CanaryScheduleInput] :schedule
    #   A structure that contains information about how often the canary is to
    #   run, and when these runs are to stop.
    #
    # @option params [Types::CanaryRunConfigInput] :run_config
    #   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.
    #
    # @option params [Integer] :success_retention_period_in_days
    #   The number of days to retain data about successful runs of this
    #   canary.
    #
    #   This setting affects the range of information returned by
    #   [GetCanaryRuns][1], as well as the range of information displayed in
    #   the Synthetics console.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
    #
    # @option params [Integer] :failure_retention_period_in_days
    #   The number of days to retain data about failed runs of this canary.
    #
    #   This setting affects the range of information returned by
    #   [GetCanaryRuns][1], as well as the range of information displayed in
    #   the Synthetics console.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
    #
    # @option params [Types::VpcConfigInput] :vpc_config
    #   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][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
    #
    # @option params [Types::VisualReferenceInput] :visual_reference
    #   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][1] and [ Visual monitoring blueprint][2]
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html
    #   [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html
    #
    # @option params [String] :artifact_s3_location
    #   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 (.).
    #
    # @option params [Types::ArtifactConfigInput] :artifact_config
    #   A structure that contains the configuration for canary artifacts,
    #   including the encryption-at-rest settings for artifacts that the
    #   canary uploads to Amazon S3.
    #
    # @option params [String] :provisioned_resource_cleanup
    #   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][1] operation determines
    #   whether the Lambda functions and layers will be deleted.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
    #
    # @option params [String] :dry_run_id
    #   Update the existing canary using the updated configurations from the
    #   DryRun associated with the DryRunId.
    #
    #   <note markdown="1"> 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.
    #
    #    </note>
    #
    # @option params [Array<Types::VisualReferenceInput>] :visual_references
    #   A list of visual reference configurations for the canary, one for each
    #   browser type that the canary is configured to run on. Visual
    #   references are used for visual monitoring comparisons.
    #
    #   `syn-nodejs-puppeteer-11.0` and above, and `syn-nodejs-playwright-3.0`
    #   and above, only supports `visualReferences`. `visualReference` field
    #   is not supported.
    #
    #   Versions older than `syn-nodejs-puppeteer-11.0` supports both
    #   `visualReference` and `visualReferences` for backward compatibility.
    #   It is recommended to use `visualReferences` for consistency and future
    #   compatibility.
    #
    #   For multibrowser visual monitoring, you can update the baseline for
    #   all configured browsers in a single update call by specifying a list
    #   of VisualReference objects, one per browser. Each VisualReference
    #   object maps to a specific browser configuration, allowing you to
    #   manage visual baselines for multiple browsers simultaneously.
    #
    #   For single configuration canaries using Chrome browser (default
    #   browser), use visualReferences for `syn-nodejs-puppeteer-11.0` and
    #   above, and `syn-nodejs-playwright-3.0` and above canaries. The
    #   browserType in the visualReference object is not mandatory.
    #
    # @option params [Array<Types::BrowserConfig>] :browser_configs
    #   A structure that specifies the browser type to use for a canary run.
    #   CloudWatch Synthetics supports running canaries on both `CHROME` and
    #   `FIREFOX` browsers.
    #
    #   <note markdown="1"> If not specified, `browserConfigs` defaults to Chrome.
    #
    #    </note>
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example 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",
    #       blueprint_types: ["BlueprintType"],
    #       dependencies: [
    #         {
    #           type: "LambdaLayer", # accepts LambdaLayer
    #           reference: "String", # 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
    #       browser_type: "CHROME", # accepts CHROME, FIREFOX
    #     },
    #     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",
    #     visual_references: [
    #       {
    #         base_screenshots: [
    #           {
    #             screenshot_name: "String", # required
    #             ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
    #           },
    #         ],
    #         base_canary_run_id: "String", # required
    #         browser_type: "CHROME", # accepts CHROME, FIREFOX
    #       },
    #     ],
    #     browser_configs: [
    #       {
    #         browser_type: "CHROME", # accepts CHROME, FIREFOX
    #       },
    #     ],
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanary AWS API Documentation
    #
    # @overload update_canary(params = {})
    # @param [Hash] params ({})
    def update_canary(params = {}, options = {})
      req = build_request(:update_canary, params)
      req.send_request(options)
    end

    # @!endgroup

    # @param params ({})
    # @api private
    def build_request(operation_name, params = {})
      handlers = @handlers.for(operation_name)
      tracer = config.telemetry_provider.tracer_provider.tracer(
        Aws::Telemetry.module_to_tracer_name('Aws::Synthetics')
      )
      context = Seahorse::Client::RequestContext.new(
        operation_name: operation_name,
        operation: config.api.operation(operation_name),
        client: self,
        params: params,
        config: config,
        tracer: tracer
      )
      context[:gem_name] = 'aws-sdk-synthetics'
      context[:gem_version] = '1.74.0'
      Seahorse::Client::Request.new(handlers, context)
    end

    # @api private
    # @deprecated
    def waiter_names
      []
    end

    class << self

      # @api private
      attr_reader :identifier

      # @api private
      def errors_module
        Errors
      end

    end
  end
end
