Class: Aws::Connect::Client

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

Overview

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

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

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

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

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

    Your AWS credentials 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.

  • :region (required, String) —

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :auth_scheme_preference (Array<String>) —

    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.

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

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

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

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

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

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

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

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

  • :ignore_configured_endpoint_urls (Boolean) —

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

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

    The log formatter.

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

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

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

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

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

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

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

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

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

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

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

  • :retry_limit (Integer) — default: 3 —

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

  • :retry_max_delay (Integer) — default: 0 —

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

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

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

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

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

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

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

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

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

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

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

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

    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.

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

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

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

  • :http_continue_timeout (Float) — default: 1 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

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

  • :on_chunk_sent (Proc) —

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

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

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

  • :ssl_ca_directory (String) —

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

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

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



471
472
473
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#activate_evaluation_form(params = {}) ⇒ Types::ActivateEvaluationFormResponse

Activates an evaluation form in the specified Connect Customer instance. After the evaluation form is activated, it is available to start new evaluations based on the form.

Examples:

Request syntax with placeholder values


resp = client.activate_evaluation_form({
  instance_id: "InstanceId", # required
  evaluation_form_id: "ResourceId", # required
  evaluation_form_version: 1, # required
})

Response structure


resp.evaluation_form_id #=> String
resp.evaluation_form_arn #=> String
resp.evaluation_form_version #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :evaluation_form_id (required, String) —

    The unique identifier for the evaluation form.

  • :evaluation_form_version (required, Integer) —

    The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated.

Returns:

See Also:



521
522
523
524
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 521

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

#associate_analytics_data_set(params = {}) ⇒ Types::AssociateAnalyticsDataSetResponse

Associates the specified dataset for a Connect Customer instance with the target account. You can associate only one dataset in a single call.

Examples:

Request syntax with placeholder values


resp = client.associate_analytics_data_set({
  instance_id: "InstanceId", # required
  data_set_id: "DataSetId", # required
  target_account_id: "AWSAccountId",
})

Response structure


resp.data_set_id #=> String
resp. #=> String
resp.resource_share_id #=> String
resp.resource_share_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :data_set_id (required, String) —

    The identifier of the dataset to associate with the target account.

  • :target_account_id (String) —

    The identifier of the target account. Use to associate a dataset to a different account than the one containing the Connect Customer instance. If not specified, by default this value is the Amazon Web Services account that has the Connect Customer instance.

Returns:

See Also:



573
574
575
576
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 573

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

#associate_approved_origin(params = {}) ⇒ Struct

This API is in preview release for Connect Customer and is subject to change.

Associates an approved origin to an Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.associate_approved_origin({
  instance_id: "InstanceId", # required
  origin: "Origin", # required
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :origin (required, String) —

    The domain to add to your allow list.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



621
622
623
624
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 621

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

#associate_bot(params = {}) ⇒ Struct

This API is in preview release for Connect Customer and is subject to change.

Allows the specified Connect Customer instance to access the specified Amazon Lex or Amazon Lex V2 bot.

Examples:

Request syntax with placeholder values


resp = client.associate_bot({
  instance_id: "InstanceId", # required
  lex_bot: {
    name: "BotName", # required
    lex_region: "LexRegion", # required
  },
  lex_v2_bot: {
    alias_arn: "AliasArn",
  },
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :lex_bot (Types::LexBot) —

    Configuration information of an Amazon Lex bot.

  • :lex_v2_bot (Types::LexV2Bot) —

    The Amazon Lex V2 bot to associate with the instance.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



679
680
681
682
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 679

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

#associate_contact_with_user(params = {}) ⇒ Struct

Associates a queued contact with an agent.

Use cases

Following are common uses cases for this API:

  • Programmatically assign queued contacts to available users.

  • Leverage the IAM context key connect:PreferredUserArn to restrict contact association to specific preferred user.

Important things to know

  • Use this API with chat, email, task, and voice contacts. For voice callbacks, this API does not support customer-first mode.

  • This API can be used to offer a contact to an agent even if the agent is currently at maximum concurrency for the channel.

  • Use it to associate contacts with users regardless of their current state, including custom states. Ensure your application logic accounts for user availability before making associations.

  • It honors the IAM context key connect:PreferredUserArn to prevent unauthorized contact associations.

  • It respects the IAM context key connect:PreferredUserArn to enforce authorization controls and prevent unauthorized contact associations. Verify that your IAM policies are properly configured to support your intended use cases.

  • The service quota Queues per routing profile per instance applies to manually assigned queues, too. For more information about this quota, see Connect Customer quotas in the Connect Customer Administrator Guide.

Endpoints: See Connect Customer endpoints and quotas.

Examples:

Request syntax with placeholder values


resp = client.associate_contact_with_user({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  user_id: "AgentResourceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer.

  • :user_id (required, String) —

    The identifier for the user. This can be the ID or the ARN of the user.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



756
757
758
759
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 756

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

#associate_default_vocabulary(params = {}) ⇒ Struct

Associates an existing vocabulary as the default. Contact Lens for Connect Customer uses the vocabulary in post-call and real-time analysis sessions for the given language.

Examples:

Request syntax with placeholder values


resp = client.associate_default_vocabulary({
  instance_id: "InstanceId", # required
  language_code: "ar-AE", # required, accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA, ca-ES, da-DK, fi-FI, id-ID, ms-MY, nl-NL, no-NO, pl-PL, sv-SE, tl-PH
  vocabulary_id: "VocabularyId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :language_code (required, String) —

    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

  • :vocabulary_id (String) —

    The identifier of the custom vocabulary. If this is empty, the default is set to none.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



800
801
802
803
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 800

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

#associate_email_address_alias(params = {}) ⇒ Struct

Associates an email address alias with an existing email address in an Connect Customer instance. This creates a forwarding relationship where emails sent to the alias email address are automatically forwarded to the primary email address.

Use cases

Following are common uses cases for this API:

  • Unified customer support: Create multiple entry points (for example, support@example.com, help@example.com, customercare@example.com) that all forward to a single agent queue for streamlined management.

  • Department consolidation: Forward emails from legacy department addresses (for example, sales@example.com, info@example.com) to a centralized customer service email during organizational restructuring.

  • Brand management: Enable you to use familiar brand-specific email addresses that forward to the appropriate Connect Customer instance email address.

Important things to know

  • Each email address can have a maximum of one alias. You cannot create multiple aliases for the same email address.

  • If the alias email address already receives direct emails, it continues to receive direct emails plus forwarded emails.

  • You cannot chain email aliases together (that is, create an alias of an alias).

AssociateEmailAddressAlias does not return the following information:

  • A confirmation of the alias relationship details (you must call DescribeEmailAddress to verify).

  • The timestamp of when the association occurred.

  • The status of the forwarding configuration.

Endpoints: See Connect Customer endpoints and quotas.

Related operations

Examples:

Request syntax with placeholder values


resp = client.associate_email_address_alias({
  email_address_id: "EmailAddressId", # required
  instance_id: "InstanceId", # required
  alias_configuration: { # required
    email_address_id: "EmailAddressId", # required
  },
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :email_address_id (required, String) —

    The identifier of the email address.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :alias_configuration (required, Types::AliasConfiguration) —

    Configuration object that specifies which email address will serve as the alias. The specified email address must already exist in the Connect Customer instance and cannot already be configured as an alias or have an alias of its own.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



928
929
930
931
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 928

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

#associate_flow(params = {}) ⇒ Struct

Associates a connect resource to a flow.

Examples:

Request syntax with placeholder values


resp = client.associate_flow({
  instance_id: "InstanceId", # required
  resource_id: "ARN", # required
  flow_id: "ARN", # required
  resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL, ANALYTICS_CONNECTOR, WHATSAPP_MESSAGING_PHONE_NUMBER
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :resource_id (required, String) —

    The identifier of the resource.

    • Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER

    • Amazon Web Services End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER

  • :flow_id (required, String) —

    The identifier of the flow.

  • :resource_type (required, String) —

    A valid resource type.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



973
974
975
976
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 973

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

#associate_hours_of_operations(params = {}) ⇒ Struct

Associates a set of hours of operations with another hours of operation. For more information about inheriting overrides from parent hours of operation, see Hours of operation overrides in the Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.associate_hours_of_operations({
  instance_id: "InstanceId", # required
  hours_of_operation_id: "HoursOfOperationId", # required
  parent_hours_of_operation_configs: [ # required
    {
      hours_of_operation_id: "HoursOfOperationId",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :hours_of_operation_id (required, String) —

    The identifier of the child hours of operation.

  • :parent_hours_of_operation_configs (required, Array<Types::ParentHoursOfOperationConfig>) —

    The Amazon Resource Names (ARNs) of the parent hours of operation resources to associate with the child hours of operation resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1020
1021
1022
1023
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1020

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

#associate_instance_storage_config(params = {}) ⇒ Types::AssociateInstanceStorageConfigResponse

This API is in preview release for Connect Customer and is subject to change.

Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.

This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.

Examples:

Request syntax with placeholder values


resp = client.associate_instance_storage_config({
  instance_id: "InstanceId", # required
  resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, ATTACHMENTS, CONTACT_EVALUATIONS, SCREEN_RECORDINGS, REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS, REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS, EMAIL_MESSAGES
  storage_config: { # required
    association_id: "AssociationId",
    storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
    s3_config: {
      bucket_name: "BucketName", # required
      bucket_prefix: "Prefix", # required
      encryption_config: {
        encryption_type: "KMS", # required, accepts KMS
        key_id: "KeyId", # required
      },
    },
    kinesis_video_stream_config: {
      prefix: "Prefix", # required
      retention_period_hours: 1, # required
      encryption_config: { # required
        encryption_type: "KMS", # required, accepts KMS
        key_id: "KeyId", # required
      },
    },
    kinesis_stream_config: {
      stream_arn: "ARN", # required
    },
    kinesis_firehose_config: {
      firehose_arn: "ARN", # required
    },
  },
  client_token: "ClientToken",
})

Response structure


resp.association_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :resource_type (required, String) —

    A valid resource type. To enable streaming for real-time analysis of contacts, use the following types:

    • For chat contacts, use REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS.

    • For voice contacts, use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.

    REAL_TIME_CONTACT_ANALYSIS_SEGMENTS is deprecated, but it is still supported and will apply only to VOICE channel contacts. Use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS for voice contacts moving forward.

    If you have previously associated a stream with REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, no action is needed to update the stream to REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.

  • :storage_config (required, Types::InstanceStorageConfig) —

    A valid storage type.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1131
1132
1133
1134
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1131

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

#associate_lambda_function(params = {}) ⇒ Struct

This API is in preview release for Connect Customer and is subject to change.

Allows the specified Connect Customer instance to access the specified Lambda function.

Examples:

Request syntax with placeholder values


resp = client.associate_lambda_function({
  instance_id: "InstanceId", # required
  function_arn: "FunctionArn", # required
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :function_arn (required, String) —

    The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1181
1182
1183
1184
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1181

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

#associate_lex_bot(params = {}) ⇒ Struct

This API is in preview release for Connect Customer and is subject to change.

Allows the specified Connect Customer instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.

Examples:

Request syntax with placeholder values


resp = client.associate_lex_bot({
  instance_id: "InstanceId", # required
  lex_bot: { # required
    name: "BotName", # required
    lex_region: "LexRegion", # required
  },
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :lex_bot (required, Types::LexBot) —

    The Amazon Lex bot to associate with the instance.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1234
1235
1236
1237
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1234

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

#associate_phone_number_contact_flow(params = {}) ⇒ Struct

Associates a flow with a phone number claimed to your Connect Customer instance.

If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Examples:

Request syntax with placeholder values


resp = client.associate_phone_number_contact_flow({
  phone_number_id: "PhoneNumberId", # required
  instance_id: "InstanceId", # required
  contact_flow_id: "ContactFlowId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    A unique identifier for the phone number.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_id (required, String) —

    The identifier of the flow.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1281
1282
1283
1284
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1281

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

#associate_queue_email_addresses(params = {}) ⇒ Struct

Associates a set of email addresses with a queue to enable agents to select different "From" (system) email addresses when replying to inbound email contacts or initiating outbound email contacts. This allows agents to handle email contacts across different brands and business units within the same queue.

Important things to know

  • You can associate up to 49 additional email addresses with a single queue, plus 1 default outbound email address, for a total of 50.

  • The email addresses must already exist in the Connect Customer instance before they can be associated with a queue.

  • Agents will be able to select from these associated email addresses when handling email contacts in the queue.

  • For inbound email contacts, agents can select from email addresses associated with the queue where the contact was accepted.

  • For outbound email contacts, agents can select from email addresses associated with their default outbound queue configured in their routing profile.

Examples:

Request syntax with placeholder values


resp = client.associate_queue_email_addresses({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  email_addresses_config: [ # required
    {
      email_address_id: "EmailAddressId", # required
    },
  ],
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :queue_id (required, String) —

    The identifier for the queue.

  • :email_addresses_config (required, Array<Types::EmailAddressConfig>) —

    Configuration list containing the email addresses to associate with the queue. Each configuration specifies an email address ID that should be linked to this queue for routing purposes.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1358
1359
1360
1361
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1358

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

#associate_queue_quick_connects(params = {}) ⇒ Struct

Associates a set of quick connects with a queue.

Examples:

Request syntax with placeholder values


resp = client.associate_queue_quick_connects({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  quick_connect_ids: ["QuickConnectId"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :queue_id (required, String) —

    The identifier for the queue.

  • :quick_connect_ids (required, Array<String>) —

    The quick connects to associate with this queue.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1393
1394
1395
1396
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1393

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

#associate_routing_profile_queues(params = {}) ⇒ Struct

Associates a set of queues with a routing profile.

Examples:

Request syntax with placeholder values


resp = client.associate_routing_profile_queues({
  instance_id: "InstanceId", # required
  routing_profile_id: "RoutingProfileId", # required
  queue_configs: [
    {
      queue_reference: { # required
        queue_id: "QueueId", # required
        channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      },
      priority: 1, # required
      delay: 1, # required
    },
  ],
  manual_assignment_queue_configs: [
    {
      queue_reference: { # required
        queue_id: "QueueId", # required
        channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      },
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :routing_profile_id (required, String) —

    The identifier of the routing profile.

  • :queue_configs (Array<Types::RoutingProfileQueueConfig>) —

    The queues to associate with this routing profile.

  • :manual_assignment_queue_configs (Array<Types::RoutingProfileManualAssignmentQueueConfig>) —

    The manual assignment queues to associate with this routing profile.

    For voice contacts, manual assignment supports only agent-first callback contacts. Chat, email, and task contacts are fully supported.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1453
1454
1455
1456
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1453

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

#associate_security_key(params = {}) ⇒ Types::AssociateSecurityKeyResponse

This API is in preview release for Connect Customer and is subject to change.

Associates a security key to the instance.

Examples:

Request syntax with placeholder values


resp = client.associate_security_key({
  instance_id: "InstanceId", # required
  key: "PEM", # required
  client_token: "ClientToken",
})

Response structure


resp.association_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :key (required, String) —

    A valid security key in PEM format as a String.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1507
1508
1509
1510
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1507

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

#associate_security_profiles(params = {}) ⇒ Struct

Associate security profiles with an Entity in an Amazon Connect instance.

Examples:

Request syntax with placeholder values


resp = client.associate_security_profiles({
  instance_id: "InstanceId", # required
  security_profiles: [ # required
    {
      id: "SecurityProfileId",
    },
  ],
  entity_type: "USER", # required, accepts USER, AI_AGENT
  entity_arn: "EntityArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :security_profiles (required, Array<Types::SecurityProfileItem>) —

    List of Security Profile Object.

  • :entity_type (required, String) —

    Only supported type is AI_AGENT.

  • :entity_arn (required, String) —

    Arn of a Q in Connect AI Agent.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1547
1548
1549
1550
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1547

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

#associate_traffic_distribution_group_user(params = {}) ⇒ Struct

Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

Examples:

Request syntax with placeholder values


resp = client.associate_traffic_distribution_group_user({
  traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :traffic_distribution_group_id (required, String) —

    The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.

  • :user_id (required, String) —

    The identifier of the user account. This can be the ID or the ARN of the user.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1586
1587
1588
1589
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1586

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

#associate_user_proficiencies(params = {}) ⇒ Struct

Associates a set of proficiencies with a user.

Examples:

Request syntax with placeholder values


resp = client.associate_user_proficiencies({
  instance_id: "InstanceId", # required
  user_id: "UserId", # required
  user_proficiencies: [ # required
    {
      attribute_name: "PredefinedAttributeName", # required
      attribute_value: "PredefinedAttributeStringValue", # required
      level: 1.0, # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN of the instance).

  • :user_id (required, String) —

    The identifier of the user account.

  • :user_proficiencies (required, Array<Types::UserProficiency>) —

    The proficiencies to associate with the user.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1623
1624
1625
1626
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1623

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

#associate_workspace(params = {}) ⇒ Types::AssociateWorkspaceResponse

Associates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages.

Examples:

Request syntax with placeholder values


resp = client.associate_workspace({
  instance_id: "InstanceId", # required
  workspace_id: "WorkspaceId", # required
  resource_arns: ["ARN"], # required
})

Response structure


resp.successful_list #=> Array
resp.successful_list[0].resource_arn #=> String
resp.failed_list #=> Array
resp.failed_list[0].resource_arn #=> String
resp.failed_list[0].error_code #=> String
resp.failed_list[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :workspace_id (required, String) —

    The identifier of the workspace.

  • :resource_arns (required, Array<String>) —

    The Amazon Resource Names (ARNs) of the resources to associate with the workspace. Valid resource types are users and routing profiles.

Returns:

See Also:



1672
1673
1674
1675
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1672

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

#batch_associate_analytics_data_set(params = {}) ⇒ Types::BatchAssociateAnalyticsDataSetResponse

Associates a list of analytics datasets for a given Connect Customer instance to a target account. You can associate multiple datasets in a single call.

Examples:

Request syntax with placeholder values


resp = client.batch_associate_analytics_data_set({
  instance_id: "InstanceId", # required
  data_set_ids: ["DataSetId"], # required
  target_account_id: "AWSAccountId",
})

Response structure


resp.created #=> Array
resp.created[0].data_set_id #=> String
resp.created[0]. #=> String
resp.created[0].resource_share_id #=> String
resp.created[0].resource_share_arn #=> String
resp.created[0].resource_share_status #=> String
resp.errors #=> Array
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :data_set_ids (required, Array<String>) —

    An array of dataset identifiers to associate.

  • :target_account_id (String) —

    The identifier of the target account. Use to associate a dataset to a different account than the one containing the Connect Customer instance. If not specified, by default this value is the Amazon Web Services account that has the Connect Customer instance.

Returns:

See Also:



1727
1728
1729
1730
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1727

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

#batch_create_data_table_value(params = {}) ⇒ Types::BatchCreateDataTableValueResponse

Creates values for attributes in a data table. The value may be a default or it may be associated with a primary value. The value must pass all customer defined validation as well as the default validation for the value type. The operation must conform to Batch Operation API Standards. Although the standard specifies that successful and failed entities are listed separately in the response, authorization fails if any primary values or attributes are unauthorized. The combination of primary values and the attribute name serve as the identifier for the individual item request.

Examples:

Request syntax with placeholder values


resp = client.batch_create_data_table_value({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
  values: [ # required
    {
      primary_values: [
        {
          attribute_name: "DataTableName", # required
          value: "String", # required
        },
      ],
      attribute_name: "DataTableName", # required
      value: "String", # required
      lock_version: {
        data_table: "String",
        attribute: "String",
        primary_values: "String",
        value: "String",
      },
      last_modified_time: Time.now,
      last_modified_region: "RegionName",
    },
  ],
})

Response structure


resp.successful #=> Array
resp.successful[0].primary_values #=> Array
resp.successful[0].primary_values[0].attribute_name #=> String
resp.successful[0].primary_values[0].value #=> String
resp.successful[0].attribute_name #=> String
resp.successful[0].record_id #=> String
resp.successful[0].lock_version.data_table #=> String
resp.successful[0].lock_version.attribute #=> String
resp.successful[0].lock_version.primary_values #=> String
resp.successful[0].lock_version.value #=> String
resp.failed #=> Array
resp.failed[0].primary_values #=> Array
resp.failed[0].primary_values[0].attribute_name #=> String
resp.failed[0].primary_values[0].value #=> String
resp.failed[0].attribute_name #=> String
resp.failed[0].message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If no alias is provided, the default behavior is identical to providing the $LATEST alias.

  • :values (required, Array<Types::DataTableValue>) —

    A list of values to create. Each value must specify the attribute name and optionally primary values if the table has primary attributes.

Returns:

See Also:



1809
1810
1811
1812
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1809

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

#batch_delete_data_table_value(params = {}) ⇒ Types::BatchDeleteDataTableValueResponse

Deletes multiple values from a data table. API users may delete values at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the attribute and its values were accessed. System managed values are not deletable by customers.

Examples:

Request syntax with placeholder values


resp = client.batch_delete_data_table_value({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
  values: [ # required
    {
      primary_values: [
        {
          attribute_name: "DataTableName", # required
          value: "String", # required
        },
      ],
      attribute_name: "DataTableName", # required
      lock_version: { # required
        data_table: "String",
        attribute: "String",
        primary_values: "String",
        value: "String",
      },
    },
  ],
})

Response structure


resp.successful #=> Array
resp.successful[0].primary_values #=> Array
resp.successful[0].primary_values[0].attribute_name #=> String
resp.successful[0].primary_values[0].value #=> String
resp.successful[0].attribute_name #=> String
resp.successful[0].lock_version.data_table #=> String
resp.successful[0].lock_version.attribute #=> String
resp.successful[0].lock_version.primary_values #=> String
resp.successful[0].lock_version.value #=> String
resp.failed #=> Array
resp.failed[0].primary_values #=> Array
resp.failed[0].primary_values[0].attribute_name #=> String
resp.failed[0].primary_values[0].value #=> String
resp.failed[0].attribute_name #=> String
resp.failed[0].message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table. Must also accept the table ARN with or without a version alias.

  • :values (required, Array<Types::DataTableDeleteValueIdentifier>) —

    A list of value identifiers to delete, each specifying primary values, attribute name, and lock version information.

Returns:

See Also:



1882
1883
1884
1885
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1882

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

#batch_describe_data_table_value(params = {}) ⇒ Types::BatchDescribeDataTableValueResponse

Retrieves multiple values from a data table without evaluating expressions. Returns the raw stored values along with metadata such as lock versions and modification timestamps. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

Examples:

Request syntax with placeholder values


resp = client.batch_describe_data_table_value({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
  values: [ # required
    {
      primary_values: [
        {
          attribute_name: "DataTableName", # required
          value: "String", # required
        },
      ],
      attribute_name: "DataTableName", # required
    },
  ],
})

Response structure


resp.successful #=> Array
resp.successful[0].record_id #=> String
resp.successful[0].attribute_id #=> String
resp.successful[0].primary_values #=> Array
resp.successful[0].primary_values[0].attribute_name #=> String
resp.successful[0].primary_values[0].attribute_id #=> String
resp.successful[0].primary_values[0].value #=> String
resp.successful[0].attribute_name #=> String
resp.successful[0].value #=> String
resp.successful[0].lock_version.data_table #=> String
resp.successful[0].lock_version.attribute #=> String
resp.successful[0].lock_version.primary_values #=> String
resp.successful[0].lock_version.value #=> String
resp.successful[0].last_modified_time #=> Time
resp.successful[0].last_modified_region #=> String
resp.failed #=> Array
resp.failed[0].primary_values #=> Array
resp.failed[0].primary_values[0].attribute_name #=> String
resp.failed[0].primary_values[0].value #=> String
resp.failed[0].attribute_name #=> String
resp.failed[0].message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table. Must also accept the table ARN with or without a version alias.

  • :values (required, Array<Types::DataTableValueIdentifier>) —

    A list of value identifiers to retrieve, each specifying primary values and attribute names.

Returns:

See Also:



1955
1956
1957
1958
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1955

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

#batch_disassociate_analytics_data_set(params = {}) ⇒ Types::BatchDisassociateAnalyticsDataSetResponse

Removes a list of analytics datasets associated with a given Connect Customer instance. You can disassociate multiple datasets in a single call.

Examples:

Request syntax with placeholder values


resp = client.batch_disassociate_analytics_data_set({
  instance_id: "InstanceId", # required
  data_set_ids: ["DataSetId"], # required
  target_account_id: "AWSAccountId",
})

Response structure


resp.deleted #=> Array
resp.deleted[0] #=> String
resp.errors #=> Array
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :data_set_ids (required, Array<String>) —

    An array of associated dataset identifiers to remove.

  • :target_account_id (String) —

    The identifier of the target account. Use to disassociate a dataset from a different account than the one containing the Connect Customer instance. If not specified, by default this value is the Amazon Web Services account that has the Connect Customer instance.

Returns:

See Also:



2006
2007
2008
2009
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2006

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

#batch_get_attached_file_metadata(params = {}) ⇒ Types::BatchGetAttachedFileMetadataResponse

Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.

Examples:

Request syntax with placeholder values


resp = client.batch_get_attached_file_metadata({
  file_ids: ["FileId"], # required
  instance_id: "InstanceId", # required
  associated_resource_arn: "ARN", # required
})

Response structure


resp.files #=> Array
resp.files[0].creation_time #=> String
resp.files[0].file_arn #=> String
resp.files[0].file_id #=> String
resp.files[0].file_name #=> String
resp.files[0].file_size_in_bytes #=> Integer
resp.files[0].file_status #=> String, one of "APPROVED", "REJECTED", "PROCESSING", "FAILED"
resp.files[0].created_by.connect_user_arn #=> String
resp.files[0].created_by.aws_identity_arn #=> String
resp.files[0].file_use_case_type #=> String, one of "CONTACT_ANALYSIS", "EMAIL_MESSAGE", "EMAIL_MESSAGE_PLAIN_TEXT", "EMAIL_MESSAGE_REDACTED", "EMAIL_MESSAGE_PLAIN_TEXT_REDACTED", "ATTACHMENT", "VOICE_RECORDING"
resp.files[0].associated_resource_arn #=> String
resp.files[0].tags #=> Hash
resp.files[0].tags["TagKey"] #=> String
resp.errors #=> Array
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String
resp.errors[0].file_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :file_ids (required, Array<String>) —

    The unique identifiers of the attached file resource.

  • :instance_id (required, String) —

    The unique identifier of the Connect instance.

  • :associated_resource_arn (required, String) —

    The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task.

    This value must be a valid ARN.

Returns:

See Also:



2072
2073
2074
2075
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2072

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

#batch_get_flow_association(params = {}) ⇒ Types::BatchGetFlowAssociationResponse

Retrieve the flow associations for the given resources.

Examples:

Request syntax with placeholder values


resp = client.batch_get_flow_association({
  instance_id: "InstanceId", # required
  resource_ids: ["ARN"], # required
  resource_type: "WHATSAPP_MESSAGING_PHONE_NUMBER", # accepts WHATSAPP_MESSAGING_PHONE_NUMBER, VOICE_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL, ANALYTICS_CONNECTOR
})

Response structure


resp.flow_association_summary_list #=> Array
resp.flow_association_summary_list[0].resource_id #=> String
resp.flow_association_summary_list[0].flow_id #=> String
resp.flow_association_summary_list[0].resource_type #=> String, one of "WHATSAPP_MESSAGING_PHONE_NUMBER", "VOICE_PHONE_NUMBER", "INBOUND_EMAIL", "OUTBOUND_EMAIL", "ANALYTICS_CONNECTOR"

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :resource_ids (required, Array<String>) —

    A list of resource identifiers to retrieve flow associations.

    • Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER

    • Amazon Web Services End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER

  • :resource_type (String) —

    The type of resource association.

Returns:

See Also:



2122
2123
2124
2125
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2122

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

#batch_put_contact(params = {}) ⇒ Types::BatchPutContactResponse

Only the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API.

Allows you to create a batch of contacts in Connect Customer. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.

Examples:

Request syntax with placeholder values


resp = client.batch_put_contact({
  client_token: "ClientToken",
  instance_id: "InstanceId", # required
  contact_data_request_list: [ # required
    {
      system_endpoint: {
        type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN, EMAIL_ADDRESS
        address: "EndpointAddress",
      },
      customer_endpoint: {
        type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN, EMAIL_ADDRESS
        address: "EndpointAddress",
      },
      request_identifier: "RequestIdentifier",
      queue_id: "QueueId",
      attributes: {
        "AttributeName" => "AttributeValue",
      },
      campaign: {
        campaign_id: "CampaignId",
      },
      outbound_strategy: {
        type: "AGENT_FIRST", # required, accepts AGENT_FIRST
        config: {
          agent_first: {
            preview: {
              post_accept_timeout_config: { # required
                duration_in_seconds: 1, # required
              },
              allowed_user_actions: ["CALL"], # required, accepts CALL, DISCARD
            },
          },
        },
      },
    },
  ],
})

Response structure


resp.successful_request_list #=> Array
resp.successful_request_list[0].request_identifier #=> String
resp.successful_request_list[0].contact_id #=> String
resp.failed_request_list #=> Array
resp.failed_request_list[0].request_identifier #=> String
resp.failed_request_list[0].failure_reason_code #=> String, one of "INVALID_ATTRIBUTE_KEY", "INVALID_CUSTOMER_ENDPOINT", "INVALID_SYSTEM_ENDPOINT", "INVALID_QUEUE", "INVALID_OUTBOUND_STRATEGY", "MISSING_CAMPAIGN", "MISSING_CUSTOMER_ENDPOINT", "MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT", "REQUEST_THROTTLED", "IDEMPOTENCY_EXCEPTION", "INTERNAL_ERROR"
resp.failed_request_list[0].failure_reason_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_data_request_list (required, Array<Types::ContactDataRequest>) —

    List of individual contact requests.

Returns:

See Also:



2227
2228
2229
2230
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2227

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

#batch_update_data_table_value(params = {}) ⇒ Types::BatchUpdateDataTableValueResponse

Updates multiple data table values using all properties from BatchCreateDataTableValue. System managed values are not modifiable by customers. The operation requires proper lock versions to prevent concurrent modification conflicts.

Examples:

Request syntax with placeholder values


resp = client.batch_update_data_table_value({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
  values: [ # required
    {
      primary_values: [
        {
          attribute_name: "DataTableName", # required
          value: "String", # required
        },
      ],
      attribute_name: "DataTableName", # required
      value: "String", # required
      lock_version: {
        data_table: "String",
        attribute: "String",
        primary_values: "String",
        value: "String",
      },
      last_modified_time: Time.now,
      last_modified_region: "RegionName",
    },
  ],
})

Response structure


resp.successful #=> Array
resp.successful[0].primary_values #=> Array
resp.successful[0].primary_values[0].attribute_name #=> String
resp.successful[0].primary_values[0].value #=> String
resp.successful[0].attribute_name #=> String
resp.successful[0].lock_version.data_table #=> String
resp.successful[0].lock_version.attribute #=> String
resp.successful[0].lock_version.primary_values #=> String
resp.successful[0].lock_version.value #=> String
resp.failed #=> Array
resp.failed[0].primary_values #=> Array
resp.failed[0].primary_values[0].attribute_name #=> String
resp.failed[0].primary_values[0].value #=> String
resp.failed[0].attribute_name #=> String
resp.failed[0].message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table. Must also accept the table ARN with or without a version alias.

  • :values (required, Array<Types::DataTableValue>) —

    A list of values to update, each including the current lock version to ensure optimistic locking.

Returns:

See Also:



2302
2303
2304
2305
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2302

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

#claim_phone_number(params = {}) ⇒ Types::ClaimPhoneNumberResponse

Claims an available phone number to your Connect Customer instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Connect Customer instance or traffic distribution group was created.

For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Connect Customer Administrator Guide.

You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.

If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

Examples:

Request syntax with placeholder values


resp = client.claim_phone_number({
  target_arn: "ARN",
  instance_id: "InstanceId",
  phone_number: "PhoneNumber", # required
  phone_number_description: "PhoneNumberDescription",
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken",
})

Response structure


resp.phone_number_id #=> String
resp.phone_number_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :target_arn (String) —

    The Amazon Resource Name (ARN) for Connect Customer instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.

  • :instance_id (String) —

    The identifier of the Connect Customer instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

  • :phone_number (required, String) —

    The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].

  • :phone_number_description (String) —

    The description of the phone number.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



2417
2418
2419
2420
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2417

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

#complete_attached_file_upload(params = {}) ⇒ Struct

Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.

Examples:

Request syntax with placeholder values


resp = client.complete_attached_file_upload({
  instance_id: "InstanceId", # required
  file_id: "FileId", # required
  associated_resource_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier of the Connect Customer instance.

  • :file_id (required, String) —

    The unique identifier of the attached file resource.

  • :associated_resource_arn (required, String) —

    The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task.

    This value must be a valid ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2459
2460
2461
2462
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2459

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

#create_agent_status(params = {}) ⇒ Types::CreateAgentStatusResponse

Creates an agent status for the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.create_agent_status({
  instance_id: "InstanceId", # required
  name: "AgentStatusName", # required
  description: "AgentStatusDescription",
  state: "ENABLED", # required, accepts ENABLED, DISABLED
  display_order: 1,
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.agent_status_arn #=> String
resp.agent_status_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    The name of the status.

  • :description (String) —

    The description of the status.

  • :state (required, String) —

    The state of the status.

  • :display_order (Integer) —

    The display order of the status.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

See Also:



2518
2519
2520
2521
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2518

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

#create_attached_file(params = {}) ⇒ Types::CreateAttachedFileResponse

Creates an attached file for a completed voice contact by copying a recording from a source S3 URI into Connect Customer managed storage. Use this API to attach voice recordings to contacts for downstream processing such as conversational analytics.

The AssociatedResourceArn must be the ARN of a completed voice contact, FileUseCaseType must be set to VOICE_RECORDING, and FileSourceUri must be a valid S3 URI.

For example, you can call CreateContact, then CreateAttachedFile, then StartContactConversationalAnalyticsJob to create a contact, attach a recording, and run post-call analytics.

Examples:

Request syntax with placeholder values


resp = client.create_attached_file({
  client_token: "ClientToken",
  instance_id: "InstanceId", # required
  file_use_case_type: "CONTACT_ANALYSIS", # required, accepts CONTACT_ANALYSIS, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT, EMAIL_MESSAGE_REDACTED, EMAIL_MESSAGE_PLAIN_TEXT_REDACTED, ATTACHMENT, VOICE_RECORDING
  file_source_uri: "FileSourceUri", # required
  associated_resource_arn: "ARN", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.file_arn #=> String
resp.file_id #=> String
resp.creation_time #=> String
resp.file_status #=> String, one of "APPROVED", "REJECTED", "PROCESSING", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :file_use_case_type (required, String) —

    The use case for the file.

    Only VOICE_RECORDING is supported.

  • :file_source_uri (required, String) —

    The S3 URI of the file to be attached. Only S3 source URIs are supported.

  • :associated_resource_arn (required, String) —

    The ARN of the completed voice contact to attach the file to. Only voice contacts with Telephony subtype are supported.

    This value must be a valid ARN.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Returns:

See Also:



2611
2612
2613
2614
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2611

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

#create_auth_code(params = {}) ⇒ Types::CreateAuthCodeResponse

Creates an authorization code for the specified Connect Customer instance. The authorization code can be used to establish a session with scoped permissions defined by the specified scope parameters.

Examples:

Request syntax with placeholder values


resp = client.create_auth_code({
  instance_id: "InstanceId", # required
  scope: { # required
    security_profile_ids: ["SecurityProfileId"],
    entity_type: "CUSTOMER_PROFILE", # required, accepts CUSTOMER_PROFILE
    entity_id: "EntityId",
    domain_name: "CustomerProfilesDomainName",
  },
  max_session_duration_minutes: 1,
  session_inactivity_duration_minutes: 1, # required
})

Response structure


resp.auth_code #=> String
resp.session_id #=> String
resp.entity_type #=> String, one of "CUSTOMER_PROFILE"
resp.entity_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :scope (required, Types::AuthScope) —

    The scope for the authorization code. Defines the permissions and access boundaries for the session.

  • :max_session_duration_minutes (Integer) —

    The maximum duration of the session, in minutes. Minimum value of 1440 (24 hours). Maximum value of 43200 (30 days). If no value is provided, the session will expire after 400 days.

  • :session_inactivity_duration_minutes (required, Integer) —

    The duration of inactivity, in minutes, after which the session expires. Minimum value of 1440 (24 hours). Maximum value of 20160 (14 days).

Returns:

See Also:



2674
2675
2676
2677
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2674

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

#create_contact(params = {}) ⇒ Types::CreateContactResponse

Only the VOICE, EMAIL, and TASK channels are supported.

  • For VOICE: The supported initiation method is TRANSFER. The contacts created with this initiation method have a subtype connect:ExternalAudio.

  • For EMAIL: The supported initiation methods are OUTBOUND, AGENT_REPLY, and FLOW.

  • For TASK: The supported initiation method is API. Contacts created with this API have a sub-type of connect:ExternalTask.

Creates a new VOICE, EMAIL, or TASK contact.

After a contact is created, you can move it to the desired state by using the InitiateAs parameter. While you can use API to create task contacts that are in the COMPLETED state, you must contact Amazon Web Services Support before using it for bulk import use cases. Bulk import causes your requests to be throttled or fail if your CreateContact limits aren't high enough.

Examples:

Request syntax with placeholder values


resp = client.create_contact({
  instance_id: "InstanceId", # required
  client_token: "ClientToken",
  related_contact_id: "ContactId",
  attributes: {
    "AttributeName" => "AttributeValue",
  },
  references: {
    "ReferenceKey" => {
      value: "ReferenceValue",
      type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT, EMAIL_MESSAGE_PLAIN_TEXT_REDACTED, EMAIL_MESSAGE_REDACTED
      status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
      arn: "ReferenceArn",
      status_reason: "ReferenceStatusReason",
    },
  },
  channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
  initiation_method: "INBOUND", # required, accepts INBOUND, OUTBOUND, TRANSFER, QUEUE_TRANSFER, CALLBACK, API, DISCONNECT, MONITOR, EXTERNAL_OUTBOUND, WEBRTC_API, AGENT_REPLY, FLOW
  expiry_duration_in_minutes: 1,
  user_info: {
    user_id: "AgentResourceId",
  },
  initiate_as: "CONNECTED_TO_USER", # accepts CONNECTED_TO_USER, COMPLETED
  name: "Name",
  description: "Description",
  segment_attributes: {
    "SegmentAttributeName" => {
      value_string: "SegmentAttributeValueString",
      value_map: {
        "SegmentAttributeName" => {
          # recursive SegmentAttributeValue
        },
      },
      value_integer: 1,
      value_list: [
        {
          # recursive SegmentAttributeValue
        },
      ],
      value_arn: "SegmentAttributeValueString",
    },
  },
  previous_contact_id: "ContactId",
})

Response structure


resp.contact_id #=> String
resp.contact_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :related_contact_id (String) —

    The identifier of the contact in this instance of Connect Customer.

  • :attributes (Hash<String,String>) —

    A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and can be accessed in flows just like any other contact attributes.

    There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

  • :references (Hash<String,Types::Reference>) —

    A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL | ATTACHMENT.

  • :channel (required, String) —

    The channel for the contact.

    The CHAT channel is not supported. The following information is incorrect. We're working to correct it.

  • :initiation_method (required, String) —

    Indicates how the contact was initiated.

    CreateContact only supports the following initiation methods. Valid values by channel are:

    • For VOICE: TRANSFER and the subtype connect:ExternalAudio

    • For EMAIL: OUTBOUND | AGENT_REPLY | FLOW

    • For TASK: API

    The other channels listed below are incorrect. We're working to correct this information.

  • :expiry_duration_in_minutes (Integer) —

    Number of minutes the contact will be active for before expiring

  • :user_info (Types::UserInfo) —

    User details for the contact

    UserInfo is required when creating an EMAIL contact with OUTBOUND and AGENT_REPLY contact initiation methods.

  • :initiate_as (String) —

    Initial state of the contact when it's created. Only TASK channel contacts can be initiated with COMPLETED state.

  • :name (String) —

    The name of a the contact.

  • :description (String) —

    A description of the contact.

  • :segment_attributes (Hash<String,Types::SegmentAttributeValue>) —

    A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.

    Attribute keys can include only alphanumeric, -, and _.

    This field can be used to set Segment Contact Expiry as a duration in minutes.

    To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}.

  • :previous_contact_id (String) —

    The ID of the previous contact when creating a transfer contact. This value can be provided only for external audio contacts. For more information, see Integrate Connect Customer Contact Lens with external voice systems in the Connect Customer Administrator Guide.

Returns:

See Also:



2869
2870
2871
2872
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2869

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

#create_contact_flow(params = {}) ⇒ Types::CreateContactFlowResponse

Creates a flow for the specified Connect Customer instance.

You can also create and update flows using the Connect Customer Flow language.

Examples:

Request syntax with placeholder values


resp = client.create_contact_flow({
  instance_id: "InstanceId", # required
  name: "ContactFlowName", # required
  type: "CONTACT_FLOW", # required, accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER, CAMPAIGN
  description: "ContactFlowDescription",
  content: "ContactFlowContent", # required
  status: "PUBLISHED", # accepts PUBLISHED, SAVED
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.contact_flow_id #=> String
resp.contact_flow_arn #=> String
resp.flow_content_sha_256 #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance.

  • :name (required, String) —

    The name of the flow.

  • :type (required, String) —

    The type of the flow. For descriptions of the available types, see Choose a flow type in the Connect Customer Administrator Guide.

  • :description (String) —

    The description of the flow.

  • :content (required, String) —

    The JSON string that represents the content of the flow. For an example, see Example flow in Connect Customer Flow language.

    Length Constraints: Minimum length of 1. Maximum length of 256000.

  • :status (String) —

    Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. the SAVED status does not initiate validation of the content. SAVED | PUBLISHED.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

See Also:



2951
2952
2953
2954
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2951

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

#create_contact_flow_module(params = {}) ⇒ Types::CreateContactFlowModuleResponse

Creates a flow module for the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.create_contact_flow_module({
  instance_id: "InstanceId", # required
  name: "ContactFlowModuleName", # required
  description: "ContactFlowModuleDescription",
  content: "ContactFlowModuleContent", # required
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken",
  settings: "FlowModuleSettings",
  external_invocation_configuration: {
    enabled: false,
  },
})

Response structure


resp.id #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    The name of the flow module.

  • :description (String) —

    The description of the flow module.

  • :content (required, String) —

    The JSON string that represents the content of the flow. For an example, see Example flow in Connect Customer Flow language.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :settings (String) —

    The configuration settings for the flow module.

  • :external_invocation_configuration (Types::ExternalInvocationConfiguration) —

    The external invocation configuration for the flow module.

Returns:

See Also:



3035
3036
3037
3038
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3035

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

#create_contact_flow_module_alias(params = {}) ⇒ Types::CreateContactFlowModuleAliasResponse

Creates a named alias that points to a specific version of a contact flow module.

Examples:

Request syntax with placeholder values


resp = client.create_contact_flow_module_alias({
  instance_id: "InstanceIdOrArn", # required
  description: "ContactFlowDescription",
  contact_flow_module_id: "ContactFlowModuleId", # required
  contact_flow_module_version: 1, # required
  alias_name: "ContactFlowModuleAlias", # required
})

Response structure


resp.contact_flow_module_arn #=> String
resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :description (String) —

    The description of the alias.

  • :contact_flow_module_id (required, String) —

    The identifier of the flow module.

  • :contact_flow_module_version (required, Integer) —

    The version of the flow module.

  • :alias_name (required, String) —

    The name of the alias.

Returns:

See Also:



3087
3088
3089
3090
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3087

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

#create_contact_flow_module_version(params = {}) ⇒ Types::CreateContactFlowModuleVersionResponse

Creates an immutable snapshot of a contact flow module, preserving its content and settings at a specific point in time for version control and rollback capabilities.

Examples:

Request syntax with placeholder values


resp = client.create_contact_flow_module_version({
  instance_id: "InstanceId", # required
  description: "ContactFlowModuleDescription",
  contact_flow_module_id: "ARN", # required
  flow_module_content_sha_256: "FlowModuleContentSha256",
})

Response structure


resp.contact_flow_module_arn #=> String
resp.version #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :description (String) —

    The description of the flow module version.

  • :contact_flow_module_id (required, String) —

    The identifier of the flow module.

  • :flow_module_content_sha_256 (String) —

    Indicates the checksum value of the flow module content.

Returns:

See Also:



3136
3137
3138
3139
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3136

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

#create_contact_flow_version(params = {}) ⇒ Types::CreateContactFlowVersionResponse

Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If the FlowContentSha256 provided is different from the FlowContentSha256 of the $LATEST published flow content, then an error is returned. This API only supports creating versions for flows of type Campaign.

Examples:

Request syntax with placeholder values


resp = client.create_contact_flow_version({
  instance_id: "InstanceId", # required
  description: "ContactFlowDescription",
  contact_flow_id: "ARN", # required
  flow_content_sha_256: "FlowContentSha256",
  contact_flow_version: 1,
  last_modified_time: Time.now,
  last_modified_region: "RegionName",
})

Response structure


resp.contact_flow_arn #=> String
resp.version #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance.

  • :description (String) —

    The description of the flow version.

  • :contact_flow_id (required, String) —

    The identifier of the flow.

  • :flow_content_sha_256 (String) —

    Indicates the checksum value of the flow content.

  • :contact_flow_version (Integer) —

    The identifier of the flow version.

  • :last_modified_time (Time, DateTime, Date, Integer, String) —

    The Amazon Web Services Region where this resource was last modified.

  • :last_modified_region (String) —

    The Amazon Web Services Region where this resource was last modified.

Returns:

See Also:



3194
3195
3196
3197
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3194

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

#create_data_table(params = {}) ⇒ Types::CreateDataTableResponse

Creates a new data table with the specified properties. Supports the creation of all table properties except for attributes and values. A table with no attributes and values is a valid state for a table. The number of tables per instance is limited to 100 per instance. Customers can request an increase by using Amazon Web Services Service Quotas.

Examples:

Request syntax with placeholder values


resp = client.create_data_table({
  instance_id: "InstanceId", # required
  name: "DataTableName", # required
  description: "DataTableDescription",
  time_zone: "TimeZone", # required
  value_lock_level: "NONE", # required, accepts NONE, DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE
  status: "PUBLISHED", # required, accepts PUBLISHED
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.lock_version.data_table #=> String
resp.lock_version.attribute #=> String
resp.lock_version.primary_values #=> String
resp.lock_version.value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance where the data table will be created.

  • :name (required, String) —

    The name for the data table. Must conform to Connect human readable string specification and have 1-127 characters. Whitespace must be trimmed first. Must not start with the reserved case insensitive values 'connect:' and 'aws:'. Must be unique for the instance using case-insensitive comparison.

  • :description (String) —

    An optional description for the data table. Must conform to Connect human readable string specification and have 0-250 characters. Whitespace must be trimmed first.

  • :time_zone (required, String) —

    The IANA timezone identifier to use when resolving time based dynamic values. Required even if no time slices are specified.

  • :value_lock_level (required, String) —

    The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. NONE is the default if unspecified. This determines how concurrent edits are handled when multiple users attempt to modify values simultaneously.

  • :status (required, String) —

    The status of the data table. One of PUBLISHED or SAVED. Required parameter that determines the initial state of the table.

  • :tags (Hash<String,String>) —

    Key value pairs for attribute based access control (TBAC or ABAC). Optional tags to apply to the data table for organization and access control purposes.

Returns:

See Also:



3274
3275
3276
3277
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3274

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

#create_data_table_attribute(params = {}) ⇒ Types::CreateDataTableAttributeResponse

Adds an attribute to an existing data table. Creating a new primary attribute uses the empty value for the specified value type for all existing records. This should not affect uniqueness of published data tables since the existing primary values will already be unique. Creating attributes does not create any values. System managed tables may not allow customers to create new attributes.

Examples:

Request syntax with placeholder values


resp = client.create_data_table_attribute({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
  name: "DataTableName", # required
  value_type: "TEXT", # required, accepts TEXT, NUMBER, BOOLEAN, TEXT_LIST, NUMBER_LIST
  description: "DataTableDescription",
  primary: false,
  validation: {
    min_length: 1,
    max_length: 1,
    min_values: 1,
    max_values: 1,
    ignore_case: false,
    minimum: 1.0,
    maximum: 1.0,
    exclusive_minimum: 1.0,
    exclusive_maximum: 1.0,
    multiple_of: 1.0,
    enum: {
      strict: false,
      values: ["String"],
    },
  },
})

Response structure


resp.name #=> String
resp.attribute_id #=> String
resp.lock_version.data_table #=> String
resp.lock_version.attribute #=> String
resp.lock_version.primary_values #=> String
resp.lock_version.value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the version is provided as part of the identifier or ARN, the version must be one of the two available system managed aliases, $SAVED or $LATEST.

  • :name (required, String) —

    The name for the attribute. Must conform to Connect human readable string specification and have 1-127 characters. Must not start with the reserved case insensitive values 'connect:' and 'aws:'. Whitespace trimmed before persisting. Must be unique for the data table using case-insensitive comparison.

  • :value_type (required, String) —

    The type of value allowed or the resultant type after the value's expression is evaluated. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, and BOOLEAN.

  • :description (String) —

    An optional description for the attribute. Must conform to Connect human readable string specification and have 0-250 characters. Whitespace trimmed before persisting.

  • :primary (Boolean) —

    Optional boolean that defaults to false. Determines if the value is used to identify a record in the table. Values for primary attributes must not be expressions.

  • :validation (Types::Validation) —

    Optional validation rules for the attribute. Borrows heavily from JSON Schema - Draft 2020-12. The maximum length of arrays within validations and depth of validations is 5. There are default limits that apply to all types. Customer specified limits in excess of the default limits are not permitted.

Returns:

See Also:



3370
3371
3372
3373
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3370

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

#create_email_address(params = {}) ⇒ Types::CreateEmailAddressResponse

Create new email address in the specified Connect Customer instance. For more information about email addresses, see Create email addresses in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.create_email_address({
  description: "Description",
  instance_id: "InstanceId", # required
  email_address: "EmailAddress", # required
  display_name: "EmailAddressDisplayName",
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken",
})

Response structure


resp.email_address_id #=> String
resp.email_address_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    The description of the email address.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :email_address (required, String) —

    The email address, including the domain.

  • :display_name (String) —

    The display name of email address

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Returns:

See Also:



3442
3443
3444
3445
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3442

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

#create_evaluation_form(params = {}) ⇒ Types::CreateEvaluationFormResponse

Creates an evaluation form in the specified Connect Customer instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.

Examples:

Request syntax with placeholder values


resp = client.create_evaluation_form({
  instance_id: "InstanceId", # required
  title: "EvaluationFormTitle", # required
  description: "EvaluationFormDescription",
  items: [ # required
    {
      section: {
        title: "EvaluationFormSectionTitle", # required
        ref_id: "ReferenceId", # required
        instructions: "EvaluationFormQuestionInstructions",
        items: { # required
          # recursive EvaluationFormItemsList
        },
        weight: 1.0,
        is_excluded_from_scoring: false,
        score_thresholds: [
          {
            performance_category: "NEEDS_IMPROVEMENT", # required, accepts NEEDS_IMPROVEMENT, EXCEEDS_EXPECTATIONS
            min_score_percentage: 1.0,
            max_score_percentage: 1.0,
          },
        ],
      },
      question: {
        title: "EvaluationFormQuestionTitle", # required
        instructions: "EvaluationFormQuestionInstructions",
        ref_id: "ReferenceId", # required
        not_applicable_enabled: false,
        question_type: "TEXT", # required, accepts TEXT, SINGLESELECT, NUMERIC, MULTISELECT, DATETIME
        question_type_properties: {
          numeric: {
            min_value: 1, # required
            max_value: 1, # required
            options: [
              {
                min_value: 1, # required
                max_value: 1, # required
                score: 1,
                automatic_fail: false,
                automatic_fail_configuration: {
                  target_section: "ReferenceId",
                },
                points_configuration: {
                  point_value: 1, # required
                  is_bonus: false,
                },
              },
            ],
            automation: {
              property_value: {
                label: "OVERALL_CUSTOMER_SENTIMENT_SCORE", # required, accepts OVERALL_CUSTOMER_SENTIMENT_SCORE, OVERALL_AGENT_SENTIMENT_SCORE, CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT, CUSTOMER_SENTIMENT_SCORE_WITH_AGENT, NON_TALK_TIME, NON_TALK_TIME_PERCENTAGE, NUMBER_OF_INTERRUPTIONS, CONTACT_DURATION, AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME, LONGEST_HOLD_DURATION, NUMBER_OF_HOLDS, AGENT_INTERACTION_AND_HOLD_DURATION
              },
              answer_source: {
                source_type: "CONTACT_LENS_DATA", # required, accepts CONTACT_LENS_DATA, GEN_AI
              },
            },
          },
          single_select: {
            options: [ # required
              {
                ref_id: "ReferenceId", # required
                text: "EvaluationFormSingleSelectQuestionOptionText", # required
                score: 1,
                automatic_fail: false,
                automatic_fail_configuration: {
                  target_section: "ReferenceId",
                },
                points_configuration: {
                  point_value: 1, # required
                  is_bonus: false,
                },
              },
            ],
            display_as: "DROPDOWN", # accepts DROPDOWN, RADIO
            automation: {
              options: [
                {
                  rule_category: {
                    category: "SingleSelectQuestionRuleCategoryAutomationLabel", # required
                    condition: "PRESENT", # required, accepts PRESENT, NOT_PRESENT
                    option_ref_id: "ReferenceId", # required
                  },
                },
              ],
              default_option_ref_id: "ReferenceId",
              answer_source: {
                source_type: "CONTACT_LENS_DATA", # required, accepts CONTACT_LENS_DATA, GEN_AI
              },
            },
          },
          text: {
            automation: {
              answer_source: {
                source_type: "CONTACT_LENS_DATA", # required, accepts CONTACT_LENS_DATA, GEN_AI
              },
            },
          },
          multi_select: {
            options: [ # required
              {
                ref_id: "ReferenceId", # required
                text: "EvaluationFormMultiSelectQuestionOptionText", # required
                score: 1,
                automatic_fail: false,
                automatic_fail_configuration: {
                  target_section: "ReferenceId",
                },
                points_configuration: {
                  point_value: 1, # required
                  is_bonus: false,
                },
              },
            ],
            display_as: "DROPDOWN", # accepts DROPDOWN, CHECKBOX
            automation: {
              options: [
                {
                  rule_category: {
                    category: "MultiSelectQuestionRuleCategoryAutomationLabel", # required
                    condition: "PRESENT", # required, accepts PRESENT, NOT_PRESENT
                    option_ref_ids: ["ReferenceId"], # required
                  },
                },
              ],
              default_option_ref_ids: ["ReferenceId"],
              answer_source: {
                source_type: "CONTACT_LENS_DATA", # required, accepts CONTACT_LENS_DATA, GEN_AI
              },
            },
          },
        },
        enablement: {
          condition: { # required
            operands: [ # required
              {
                expression: {
                  source: { # required
                    type: "QUESTION_REF_ID", # required, accepts QUESTION_REF_ID
                    ref_id: "ReferenceId",
                  },
                  values: [ # required
                    {
                      type: "OPTION_REF_ID", # required, accepts OPTION_REF_ID
                      ref_id: "ReferenceId",
                    },
                  ],
                  comparator: "IN", # required, accepts IN, NOT_IN, ALL_IN, EXACT
                },
                condition: {
                  # recursive EvaluationFormItemEnablementCondition
                },
              },
            ],
            operator: "OR", # accepts OR, AND
          },
          action: "DISABLE", # required, accepts DISABLE, ENABLE
          default_action: "DISABLE", # accepts DISABLE, ENABLE
        },
        weight: 1.0,
        scoring_configuration: {
          points_configuration: {
            max_point_value: 1,
            min_point_value: 1,
            is_bonus: false,
          },
          is_excluded_from_scoring: false,
          score_thresholds: [
            {
              performance_category: "NEEDS_IMPROVEMENT", # required, accepts NEEDS_IMPROVEMENT, EXCEEDS_EXPECTATIONS
              min_score_percentage: 1.0,
              max_score_percentage: 1.0,
            },
          ],
        },
      },
    },
  ],
  scoring_strategy: {
    mode: "QUESTION_ONLY", # required, accepts QUESTION_ONLY, SECTION_ONLY, POINTS_BASED
    status: "ENABLED", # required, accepts ENABLED, DISABLED
    score_thresholds: [
      {
        performance_category: "NEEDS_IMPROVEMENT", # required, accepts NEEDS_IMPROVEMENT, EXCEEDS_EXPECTATIONS
        min_score_percentage: 1.0,
        max_score_percentage: 1.0,
      },
    ],
  },
  auto_evaluation_configuration: {
    enabled: false, # required
  },
  client_token: "ClientToken",
  as_draft: false,
  tags: {
    "TagKey" => "TagValue",
  },
  review_configuration: {
    review_notification_recipients: [ # required
      {
        type: "USER_ID", # required, accepts USER_ID
        value: { # required
          user_id: "ResourceId",
        },
      },
    ],
    eligibility_days: 1,
  },
  target_configuration: {
    contact_interaction_type: "AGENT", # required, accepts AGENT, AUTOMATED, CUSTOMER
  },
  language_configuration: {
    form_language: "de-DE", # accepts de-DE, en-US, es-ES, fr-FR, it-IT, pt-BR, ja-JP, ko-KR, zh-CN, ms-MY
  },
})

Response structure


resp.evaluation_form_id #=> String
resp.evaluation_form_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :title (required, String) —

    A title of the evaluation form.

  • :description (String) —

    The description of the evaluation form.

  • :items (required, Array<Types::EvaluationFormItem>) —

    Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

  • :scoring_strategy (Types::EvaluationFormScoringStrategy) —

    A scoring strategy of the evaluation form.

  • :auto_evaluation_configuration (Types::EvaluationFormAutoEvaluationConfiguration) —

    Configuration information about automated evaluations.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :as_draft (Boolean) —

    A boolean flag indicating whether to create evaluation form in draft state.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

  • :review_configuration (Types::EvaluationReviewConfiguration) —

    Configuration information about evaluation reviews.

  • :target_configuration (Types::EvaluationFormTargetConfiguration) —

    Configuration that specifies the target for the evaluation form.

  • :language_configuration (Types::EvaluationFormLanguageConfiguration) —

    Configuration for language settings of the evaluation form.

Returns:

See Also:



3739
3740
3741
3742
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3739

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

#create_hours_of_operation(params = {}) ⇒ Types::CreateHoursOfOperationResponse

Creates hours of operation.

Examples:

Request syntax with placeholder values


resp = client.create_hours_of_operation({
  instance_id: "InstanceId", # required
  name: "CommonNameLength127", # required
  description: "HoursOfOperationDescription",
  time_zone: "TimeZone", # required
  config: [ # required
    {
      day: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
      start_time: { # required
        hours: 1, # required
        minutes: 1, # required
      },
      end_time: { # required
        hours: 1, # required
        minutes: 1, # required
      },
    },
  ],
  parent_hours_of_operation_configs: [
    {
      hours_of_operation_id: "HoursOfOperationId",
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.hours_of_operation_id #=> String
resp.hours_of_operation_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    The name of the hours of operation.

  • :description (String) —

    The description of the hours of operation.

  • :time_zone (required, String) —

    The time zone of the hours of operation.

  • :config (required, Array<Types::HoursOfOperationConfig>) —

    Configuration information for the hours of operation: day, start time, and end time.

  • :parent_hours_of_operation_configs (Array<Types::ParentHoursOfOperationConfig>) —

    Configuration for parent hours of operations. Eg: ResourceArn.

    For more information about parent hours of operations, see Link overrides from different hours of operation in the Administrator Guide.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

See Also:



3827
3828
3829
3830
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3827

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

#create_hours_of_operation_override(params = {}) ⇒ Types::CreateHoursOfOperationOverrideResponse

Creates an hours of operation override in an Connect Customer hours of operation resource.

Examples:

Request syntax with placeholder values


resp = client.create_hours_of_operation_override({
  instance_id: "InstanceId", # required
  hours_of_operation_id: "HoursOfOperationId", # required
  name: "CommonHumanReadableName", # required
  description: "CommonHumanReadableDescription",
  config: [ # required
    {
      day: "SUNDAY", # accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
      start_time: {
        hours: 1, # required
        minutes: 1, # required
      },
      end_time: {
        hours: 1, # required
        minutes: 1, # required
      },
    },
  ],
  effective_from: "HoursOfOperationOverrideYearMonthDayDateFormat", # required
  effective_till: "HoursOfOperationOverrideYearMonthDayDateFormat", # required
  recurrence_config: {
    recurrence_pattern: { # required
      frequency: "WEEKLY", # required, accepts WEEKLY, MONTHLY, YEARLY
      interval: 1, # required
      by_month: [1],
      by_month_day: [1],
      by_weekday_occurrence: [1],
    },
  },
  override_type: "STANDARD", # accepts STANDARD, OPEN, CLOSED
})

Response structure


resp.hours_of_operation_override_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance.

  • :hours_of_operation_id (required, String) —

    The identifier for the hours of operation

  • :name (required, String) —

    The name of the hours of operation override.

  • :description (String) —

    The description of the hours of operation override.

  • :config (required, Array<Types::HoursOfOperationOverrideConfig>) —

    Configuration information for the hours of operation override: day, start time, and end time.

  • :effective_from (required, String) —

    The date from when the hours of operation override is effective.

  • :effective_till (required, String) —

    The date until when the hours of operation override is effective.

  • :recurrence_config (Types::RecurrenceConfig) —

    Configuration for a recurring event.

  • :override_type (String) —

    Whether the override will be defined as a standard or as a recurring event.

    For more information about how override types are applied, see Build your list of overrides in the Administrator Guide.

Returns:

See Also:



3917
3918
3919
3920
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3917

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

#create_instance(params = {}) ⇒ Types::CreateInstanceResponse

This API is in preview release for Connect Customer and is subject to change.

Initiates an Connect Customer instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Connect Customer.

For more information, see Create an Connect Customer instance in the Connect Customer Administrator Guide.

Connect Customer enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

Examples:

Request syntax with placeholder values


resp = client.create_instance({
  client_token: "ClientToken",
  identity_management_type: "SAML", # required, accepts SAML, CONNECT_MANAGED, EXISTING_DIRECTORY
  instance_alias: "DirectoryAlias",
  directory_id: "DirectoryId",
  inbound_calls_enabled: false, # required
  outbound_calls_enabled: false, # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.id #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    The idempotency token.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :identity_management_type (required, String) —

    The type of identity management for your Connect Customer users.

  • :instance_alias (String) —

    The name for your instance.

  • :directory_id (String) —

    The identifier for the directory.

  • :inbound_calls_enabled (required, Boolean) —

    Your contact center handles incoming contacts.

  • :outbound_calls_enabled (required, Boolean) —

    Your contact center allows outbound calls.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Returns:

See Also:



3997
3998
3999
4000
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3997

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

#create_integration_association(params = {}) ⇒ Types::CreateIntegrationAssociationResponse

Creates an Amazon Web Services resource association with an Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.create_integration_association({
  instance_id: "InstanceId", # required
  integration_type: "EVENT", # required, accepts EVENT, VOICE_ID, PINPOINT_APP, WISDOM_ASSISTANT, WISDOM_KNOWLEDGE_BASE, WISDOM_QUICK_RESPONSES, Q_MESSAGE_TEMPLATES, CASES_DOMAIN, APPLICATION, FILE_SCANNER, SES_IDENTITY, ANALYTICS_CONNECTOR, CALL_TRANSFER_CONNECTOR, COGNITO_USER_POOL, MESSAGE_PROCESSOR
  integration_arn: "ARN", # required
  source_application_url: "URI",
  source_application_name: "SourceApplicationName",
  source_type: "SALESFORCE", # accepts SALESFORCE, ZENDESK, CASES
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.integration_association_id #=> String
resp.integration_association_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :integration_type (required, String) —

    The type of information to be ingested.

  • :integration_arn (required, String) —

    The Amazon Resource Name (ARN) of the integration.

    When integrating with Amazon Web Services End User Messaging, the Connect Customer and Amazon Web Services End User Messaging instances must be in the same account.

  • :source_application_url (String) —

    The URL for the external application. This field is only required for the EVENT integration type.

  • :source_application_name (String) —

    The name of the external application. This field is only required for the EVENT integration type.

  • :source_type (String) —

    The type of the data source. This field is only required for the EVENT integration type.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

See Also:



4070
4071
4072
4073
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4070

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

#create_metric(params = {}) ⇒ Types::CreateMetricResponse

Creates a new metric definition for the specified Connect Customer instance. You can create custom metrics that use formulas referencing existing Amazon Web Services-managed metrics, optionally with filters applied.

Examples:

Request syntax with placeholder values


resp = client.create_metric({
  instance_id: "InstanceId", # required
  name: "MetricName", # required
  metric_calculation: { # required
    calculation_components: [ # required
      {
        alias: "ComponentAlias", # required
        metric_name: "MetricName",
        metric_id: "MetricId",
        metric_filters: [
          {
            metric_filter_key: "MetricFilterKey", # required
            negate: false,
            number_condition: {
              comparison: "LESSER", # required, accepts LESSER, LESSER_OR_EQUAL, GREATER, GREATER_OR_EQUAL
              values: [1.0], # required
            },
            string_condition: {
              comparison: "MATCHES_ANY", # required, accepts MATCHES_ANY, MATCHES_NONE
              values: ["String"], # required
            },
            boolean_condition: {
              comparison: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
            },
          },
        ],
      },
    ],
    calculation: "CalculationExpression", # required
  },
  unit: "INTEGER", # required, accepts INTEGER, DOUBLE, PERCENT, SECONDS
  status: "PUBLISHED", # accepts PUBLISHED, SAVED
  client_token: "ClientToken",
  description: "MetricDescription",
  positive_trend_indicator: "POSITIVE", # accepts POSITIVE, NEGATIVE, NEUTRAL
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.metric_arn #=> String
resp.metric_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    The name of the metric.

  • :metric_calculation (required, Types::MetricCalculation) —

    The calculation definition for the metric, including the formula expression and the component metrics it references.

  • :unit (required, String) —

    The display unit for the metric's data.

  • :status (String) —

    The publish status of the metric. Set to PUBLISHED to make the metric available for use in dashboards and reports, or SAVED to keep it in draft state.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    The description of the metric.

  • :positive_trend_indicator (String) —

    How an increase in the metric value should be interpreted. Valid values: POSITIVE, NEUTRAL, NEGATIVE.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

See Also:



4184
4185
4186
4187
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4184

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

#create_notification(params = {}) ⇒ Types::CreateNotificationResponse

Creates a new notification to be delivered to specified recipients. Notifications can include localized content with links, and an optional expiration time. Recipients can be specified as individual user ARNs or instance ARNs to target all users in an instance.

Examples:

Request syntax with placeholder values


resp = client.create_notification({
  instance_id: "InstanceId", # required
  expires_at: Time.now,
  recipients: ["ARN"], # required
  priority: "HIGH", # accepts HIGH, LOW
  content: { # required
    "en_US" => "LocalizedString",
  },
  tags: {
    "TagKey" => "TagValue",
  },
  predefined_notification_id: "NotificationId",
  client_token: "ClientToken",
})

Response structure


resp.notification_id #=> String
resp.notification_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :expires_at (Time, DateTime, Date, Integer, String) —

    The timestamp when the notification should expire and no longer be displayed to users. If not specified, defaults to one week from creation.

  • :recipients (required, Array<String>) —

    A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Can include user ARNs or instance ARNs to target all users in an instance. Maximum of 200 recipients.

  • :priority (String) —

    The priority level of the notification. Valid values are HIGH and LOW. High priority notifications are displayed above low priority notifications.

  • :content (required, Hash<String,String>) —

    The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale. Content supports links. Maximum 250 characters per locale.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

  • :predefined_notification_id (String) —

    The unique identifier for a notification.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



4273
4274
4275
4276
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4273

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

#create_participant(params = {}) ⇒ Types::CreateParticipantResponse

Adds a new participant into an on-going chat contact or webRTC call. For more information, see Customize chat flow experiences by integrating custom participants or Enable multi-user web, in-app, and video calling.

Examples:

Request syntax with placeholder values


resp = client.create_participant({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  client_token: "ClientToken",
  participant_details: { # required
    participant_role: "AGENT", # accepts AGENT, CUSTOMER, SYSTEM, CUSTOM_BOT, SUPERVISOR
    display_name: "DisplayName",
    participant_capabilities: {
      video: "SEND", # accepts SEND
      screen_share: "SEND", # accepts SEND
    },
  },
})

Response structure


resp.participant_credentials.participant_token #=> String
resp.participant_credentials.expiry #=> String
resp.participant_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer. Supports contacts in the CHAT channel and VOICE (WebRTC) channels. For WebRTC calls, this should be the initial contact ID that was generated when the contact was first created (from the StartWebRTCContact API) in the VOICE channel

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :participant_details (required, Types::ParticipantDetailsToAdd) —

    Information identifying the participant.

    The only valid value for ParticipantRole is CUSTOM_BOT for chat contact and CUSTOMER for voice contact.

Returns:

See Also:



4353
4354
4355
4356
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4353

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

#create_persistent_contact_association(params = {}) ⇒ Types::CreatePersistentContactAssociationResponse

Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.create_persistent_contact_association({
  instance_id: "InstanceId", # required
  initial_contact_id: "ContactId", # required
  rehydration_type: "ENTIRE_PAST_SESSION", # required, accepts ENTIRE_PAST_SESSION, FROM_SEGMENT
  source_contact_id: "ContactId", # required
  client_token: "ClientToken",
})

Response structure


resp.continued_from_contact_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :initial_contact_id (required, String) —

    This is the contactId of the current contact that the CreatePersistentContactAssociation API is being called from.

  • :rehydration_type (required, String) —

    The contactId chosen for rehydration depends on the type chosen.

    • ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Connect Customer determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat.

    • FROM_SEGMENT: Rehydrates a chat from the specified past chat contact provided in the sourceContactId field.

    The actual contactId used for rehydration is provided in the response of this API.

    To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:

    • Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:

      • Configuration

        • SourceContactId = "C2"

        • RehydrationType = "FROM_SEGMENT"

      • Expected behavior

        • This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.

        ^

    • Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:

      • Configuration

        • SourceContactId = "C1"

        • RehydrationType = "ENTIRE_PAST_SESSION"

      • Expected behavior

        • This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.

        ^

  • :source_contact_id (required, String) —

    The contactId from which a persistent chat session must be started.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Returns:

See Also:



4476
4477
4478
4479
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4476

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

#create_predefined_attribute(params = {}) ⇒ Struct

Creates a new predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value.

For the predefined attributes per instance quota, see Connect Customer quotas.

Use cases

Following are common uses cases for this API:

  • Create an attribute for routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.

  • Create an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see Use contact segment attributes.

Endpoints: See Connect Customer endpoints and quotas.

Examples:

Request syntax with placeholder values


resp = client.create_predefined_attribute({
  instance_id: "InstanceId", # required
  name: "PredefinedAttributeName", # required
  values: {
    string_list: ["PredefinedAttributeStringValue"],
  },
  purposes: ["PredefinedAttributePurposeName"],
  attribute_configuration: {
    enable_value_validation_on_association: false,
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    The name of the predefined attribute.

  • :values (Types::PredefinedAttributeValues) —

    The values of the predefined attribute.

  • :purposes (Array<String>) —

    Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Connect Customer admin website.

  • :attribute_configuration (Types::InputPredefinedAttributeConfiguration) —

    Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Connect Customer admin website.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4551
4552
4553
4554
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4551

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

#create_prompt(params = {}) ⇒ Types::CreatePromptResponse

Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.create_prompt({
  instance_id: "InstanceId", # required
  name: "CommonNameLength127", # required
  description: "PromptDescription",
  s3_uri: "S3Uri", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.prompt_arn #=> String
resp.prompt_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    The name of the prompt.

  • :description (String) —

    The description of the prompt.

  • :s3_uri (required, String) —

    The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

See Also:



4618
4619
4620
4621
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4618

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

#create_push_notification_registration(params = {}) ⇒ Types::CreatePushNotificationRegistrationResponse

Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Connect Customer for mobile chat in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.create_push_notification_registration({
  instance_id: "InstanceId", # required
  client_token: "ClientToken",
  pinpoint_app_arn: "ARN", # required
  device_token: "DeviceToken", # required
  device_type: "GCM", # required, accepts GCM, APNS, APNS_SANDBOX
  contact_configuration: { # required
    contact_id: "ContactId", # required
    participant_role: "AGENT", # accepts AGENT, CUSTOMER, SYSTEM, CUSTOM_BOT, SUPERVISOR
    include_raw_message: false,
  },
})

Response structure


resp.registration_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :pinpoint_app_arn (required, String) —

    The Amazon Resource Name (ARN) of the Pinpoint application.

  • :device_token (required, String) —

    The push notification token issued by the Apple or Google gateways.

  • :device_type (required, String) —

    The device type to use when sending the message.

  • :contact_configuration (required, Types::ContactConfiguration) —

    The contact configuration for push notification registration.

Returns:

See Also:



4692
4693
4694
4695
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4692

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

#create_queue(params = {}) ⇒ Types::CreateQueueResponse

Creates a new queue for the specified Connect Customer instance.

  • If the phone number is claimed to a traffic distribution group that was created in the same Region as the Connect Customer instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

  • Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.

  • If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.

Examples:

Request syntax with placeholder values


resp = client.create_queue({
  instance_id: "InstanceId", # required
  name: "CommonNameLength127", # required
  description: "QueueDescription",
  outbound_caller_config: {
    outbound_caller_id_name: "OutboundCallerIdName",
    outbound_caller_id_number_id: "PhoneNumberId",
    outbound_flow_id: "ContactFlowId",
  },
  outbound_email_config: {
    outbound_email_address_id: "EmailAddressId",
  },
  hours_of_operation_id: "HoursOfOperationId", # required
  max_contacts: 1,
  quick_connect_ids: ["QuickConnectId"],
  email_addresses_config: [
    {
      email_address_id: "EmailAddressId", # required
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.queue_arn #=> String
resp.queue_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    The name of the queue.

  • :description (String) —

    The description of the queue.

  • :outbound_caller_config (Types::OutboundCallerConfig) —

    The outbound caller ID name, number, and outbound whisper flow.

  • :outbound_email_config (Types::OutboundEmailConfig) —

    The outbound email address ID for a specified queue.

  • :hours_of_operation_id (required, String) —

    The identifier for the hours of operation.

  • :max_contacts (Integer) —

    The maximum number of contacts that can be in the queue before it is considered full.

  • :quick_connect_ids (Array<String>) —

    The quick connects available to agents who are working the queue.

  • :email_addresses_config (Array<Types::EmailAddressConfig>) —

    Configuration list containing the email addresses to associate with the queue during creation. Each configuration specifies an email address ID that agents can select when handling email contacts in this queue.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

See Also:



4808
4809
4810
4811
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4808

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

#create_quick_connect(params = {}) ⇒ Types::CreateQuickConnectResponse

Creates a quick connect for the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.create_quick_connect({
  instance_id: "InstanceId", # required
  name: "QuickConnectName", # required
  description: "QuickConnectDescription",
  quick_connect_config: { # required
    quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER, FLOW
    user_config: {
      user_id: "UserId", # required
      contact_flow_id: "ContactFlowId", # required
    },
    queue_config: {
      queue_id: "QueueId", # required
      contact_flow_id: "ContactFlowId", # required
    },
    phone_config: {
      phone_number: "PhoneNumber", # required
    },
    flow_config: {
      contact_flow_id: "ContactFlowId", # required
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.quick_connect_arn #=> String
resp.quick_connect_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    A unique name of the quick connect.

  • :description (String) —

    The description of the quick connect.

  • :quick_connect_config (required, Types::QuickConnectConfig) —

    Configuration settings for the quick connect.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

See Also:



4879
4880
4881
4882
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4879

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

#create_routing_profile(params = {}) ⇒ Types::CreateRoutingProfileResponse

Creates a new routing profile.

Examples:

Request syntax with placeholder values


resp = client.create_routing_profile({
  instance_id: "InstanceId", # required
  name: "RoutingProfileName", # required
  description: "RoutingProfileDescription", # required
  default_outbound_queue_id: "QueueId", # required
  queue_configs: [
    {
      queue_reference: { # required
        queue_id: "QueueId", # required
        channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      },
      priority: 1, # required
      delay: 1, # required
    },
  ],
  manual_assignment_queue_configs: [
    {
      queue_reference: { # required
        queue_id: "QueueId", # required
        channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      },
    },
  ],
  media_concurrencies: [ # required
    {
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      concurrency: 1, # required
      cross_channel_behavior: {
        behavior_type: "ROUTE_CURRENT_CHANNEL_ONLY", # required, accepts ROUTE_CURRENT_CHANNEL_ONLY, ROUTE_ANY_CHANNEL
      },
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
  agent_availability_timer: "TIME_SINCE_LAST_ACTIVITY", # accepts TIME_SINCE_LAST_ACTIVITY, TIME_SINCE_LAST_INBOUND
})

Response structure


resp.routing_profile_arn #=> String
resp.routing_profile_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    The name of the routing profile. Must not be more than 127 characters.

  • :description (required, String) —

    Description of the routing profile. Must not be more than 250 characters.

  • :default_outbound_queue_id (required, String) —

    The default outbound queue for the routing profile.

  • :queue_configs (Array<Types::RoutingProfileQueueConfig>) —

    The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.

    The limit of 10 array members applies to the maximum number of RoutingProfileQueueConfig objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Connect Customer service quotas.

  • :manual_assignment_queue_configs (Array<Types::RoutingProfileManualAssignmentQueueConfig>) —

    The manual assignment queues associated with the routing profile. If no queue is added, agents and supervisors can't pick or assign any contacts from this routing profile. The limit of 10 array members applies to the maximum number of RoutingProfileManualAssignmentQueueConfig objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Connect Customer service quotas.

    For voice contacts, manual assignment supports only agent-first callback contacts. Chat, email, and task contacts are fully supported.

  • :media_concurrencies (required, Array<Types::MediaConcurrency>) —

    The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

  • :agent_availability_timer (String) —

    Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.

Returns:

See Also:



5001
5002
5003
5004
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5001

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

#create_rule(params = {}) ⇒ Types::CreateRuleResponse

Creates a rule for the specified Connect Customer instance.

Use the Rules Function language to code conditions for the rule.

Examples:

Request syntax with placeholder values


resp = client.create_rule({
  instance_id: "InstanceId", # required
  name: "RuleName", # required
  trigger_event_source: { # required
    event_source_name: "OnPostCallAnalysisAvailable", # required, accepts OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnRealTimeChatAnalysisAvailable, OnPostChatAnalysisAvailable, OnEmailAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit, OnMetricDataUpdate, OnCaseCreate, OnCaseUpdate, OnSlaBreach, OnAlertUpdate, OnSchedulePublish, OnScheduleUpdate, OnScheduleTimeOffRequestActivity
    integration_association_id: "IntegrationAssociationId",
  },
  function: "RuleFunction", # required
  actions: [ # required
    {
      action_type: "CREATE_TASK", # required, accepts CREATE_TASK, ASSIGN_CONTACT_CATEGORY, GENERATE_EVENTBRIDGE_EVENT, SEND_NOTIFICATION, CREATE_CASE, UPDATE_CASE, ASSIGN_SLA, END_ASSOCIATED_TASKS, SUBMIT_AUTO_EVALUATION
      task_action: {
        name: "TaskNameExpression", # required
        description: "TaskDescriptionExpression",
        contact_flow_id: "ContactFlowId", # required
        references: {
          "ReferenceKey" => {
            value: "ReferenceValue",
            type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT, EMAIL_MESSAGE_PLAIN_TEXT_REDACTED, EMAIL_MESSAGE_REDACTED
            status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
            arn: "ReferenceArn",
            status_reason: "ReferenceStatusReason",
          },
        },
      },
      event_bridge_action: {
        name: "EventBridgeActionName", # required
      },
      assign_contact_category_action: {
      },
      send_notification_action: {
        delivery_method: "EMAIL", # required, accepts EMAIL
        subject: "Subject",
        content: "Content", # required
        content_type: "PLAIN_TEXT", # required, accepts PLAIN_TEXT
        recipient: { # required
          user_tags: {
            "String" => "String",
          },
          user_ids: ["UserId"],
        },
        exclusion: {
          user_tags: {
            "String" => "String",
          },
          user_ids: ["UserId"],
        },
      },
      create_case_action: {
        fields: [ # required
          {
            id: "FieldValueId", # required
            value: { # required
              boolean_value: false,
              double_value: 1.0,
              empty_value: {
              },
              string_value: "FieldStringValue",
            },
          },
        ],
        template_id: "TemplateId", # required
      },
      update_case_action: {
        fields: [ # required
          {
            id: "FieldValueId", # required
            value: { # required
              boolean_value: false,
              double_value: 1.0,
              empty_value: {
              },
              string_value: "FieldStringValue",
            },
          },
        ],
      },
      assign_sla_action: {
        sla_assignment_type: "CASES", # required, accepts CASES
        case_sla_configuration: {
          name: "SlaName", # required
          type: "CaseField", # required, accepts CaseField
          field_id: "FieldValueId",
          target_field_values: [
            {
              boolean_value: false,
              double_value: 1.0,
              empty_value: {
              },
              string_value: "FieldStringValue",
            },
          ],
          target_sla_minutes: 1, # required
        },
      },
      end_associated_tasks_action: {
      },
      submit_auto_evaluation_action: {
        evaluation_form_id: "EvaluationFormId", # required
      },
    },
  ],
  publish_status: "DRAFT", # required, accepts DRAFT, PUBLISHED
  client_token: "ClientToken",
})

Response structure


resp.rule_arn #=> String
resp.rule_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    A unique name for the rule.

  • :trigger_event_source (required, Types::RuleTriggerEventSource) —

    The event source to trigger the rule.

  • :function (required, String) —

    The conditions of the rule.

  • :actions (required, Array<Types::RuleAction>) —

    A list of actions to be run when the rule is triggered.

  • :publish_status (required, String) —

    The publish status of the rule.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



5172
5173
5174
5175
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5172

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

#create_security_profile(params = {}) ⇒ Types::CreateSecurityProfileResponse

Creates a security profile.

For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

Examples:

Request syntax with placeholder values


resp = client.create_security_profile({
  security_profile_name: "CreateSecurityProfileName", # required
  description: "SecurityProfileDescription",
  permissions: ["SecurityProfilePermission"],
  instance_id: "InstanceId", # required
  tags: {
    "TagKey" => "TagValue",
  },
  allowed_access_control_tags: {
    "SecurityProfilePolicyKey" => "SecurityProfilePolicyValue",
  },
  tag_restricted_resources: ["TagRestrictedResourceName"],
  applications: [
    {
      namespace: "Namespace",
      application_permissions: ["Permission"],
      type: "MCP", # accepts MCP, THIRD_PARTY_APPLICATION
    },
  ],
  hierarchy_restricted_resources: ["HierarchyRestrictedResourceName"],
  allowed_access_control_hierarchy_group_id: "HierarchyGroupId",
  allowed_flow_modules: [
    {
      type: "MCP", # accepts MCP
      flow_module_id: "FlowModuleId",
    },
  ],
  granular_access_control_configuration: {
    data_table_access_control_configuration: {
      primary_attribute_access_control_configuration: {
        primary_attribute_values: [
          {
            access_type: "ALLOW", # accepts ALLOW
            attribute_name: "PrimaryAttributeContextKeyName",
            values: ["IAMRestrictedPrimaryValue"],
          },
        ],
      },
    },
  },
})

Response structure


resp.security_profile_id #=> String
resp.security_profile_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :security_profile_name (required, String) —

    The name of the security profile.

  • :description (String) —

    The description of the security profile.

  • :permissions (Array<String>) —

    Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

  • :allowed_access_control_tags (Hash<String,String>) —

    The list of tags that a security profile uses to restrict access to resources in Connect Customer.

  • :tag_restricted_resources (Array<String>) —

    The list of resources that a security profile applies tag restrictions to in Connect Customer. For a list of Connect Customer resources that you can tag, see Add tags to resources in Connect Customer in the Connect Customer Administrator Guide.

  • :applications (Array<Types::Application>) —

    A list of third-party applications or MCP Servers that the security profile will give access to.

  • :hierarchy_restricted_resources (Array<String>) —

    The list of resources that a security profile applies hierarchy restrictions to in Connect Customer. Following are acceptable ResourceNames: User.

  • :allowed_access_control_hierarchy_group_id (String) —

    The identifier of the hierarchy group that a security profile uses to restrict access to resources in Connect Customer.

  • :allowed_flow_modules (Array<Types::FlowModule>) —

    A list of Flow Modules an AI Agent can invoke as a tool.

  • :granular_access_control_configuration (Types::GranularAccessControlConfiguration) —

    The granular access control configuration for the security profile, including data table permissions.

Returns:

See Also:



5308
5309
5310
5311
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5308

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

#create_task_template(params = {}) ⇒ Types::CreateTaskTemplateResponse

Creates a new task template in the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.create_task_template({
  instance_id: "InstanceId", # required
  name: "TaskTemplateName", # required
  description: "TaskTemplateDescription",
  contact_flow_id: "ContactFlowId",
  self_assign_flow_id: "ContactFlowId",
  constraints: {
    required_fields: [
      {
        id: {
          name: "TaskTemplateFieldName",
        },
      },
    ],
    read_only_fields: [
      {
        id: {
          name: "TaskTemplateFieldName",
        },
      },
    ],
    invisible_fields: [
      {
        id: {
          name: "TaskTemplateFieldName",
        },
      },
    ],
  },
  defaults: {
    default_field_values: [
      {
        id: {
          name: "TaskTemplateFieldName",
        },
        default_value: "TaskTemplateFieldValue",
      },
    ],
  },
  status: "ACTIVE", # accepts ACTIVE, INACTIVE
  fields: [ # required
    {
      id: { # required
        name: "TaskTemplateFieldName",
      },
      description: "TaskTemplateFieldDescription",
      type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL, SELF_ASSIGN, EXPIRY_DURATION
      single_select_options: ["TaskTemplateSingleSelectOption"],
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.id #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    The name of the task template.

  • :description (String) —

    The description of the task template.

  • :contact_flow_id (String) —

    The identifier of the flow that runs by default when a task is created by referencing this template.

    Although this parameter is marked as optional, the request must contain either a ContactFlowId or a field of type QUICK_CONNECT.

  • :self_assign_flow_id (String) —

    The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.

  • :constraints (Types::TaskTemplateConstraints) —

    Constraints that are applicable to the fields listed. Although this parameter is marked as optional in the API model, the service requires it when calling CreateTaskTemplate or UpdateTaskTemplate. The RequiredFields array must contain at least one element, and the field of type NAME must be included in RequiredFields.

  • :defaults (Types::TaskTemplateDefaults) —

    The default values for fields when a task is created by referencing this template.

  • :status (String) —

    Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

  • :fields (required, Array<Types::TaskTemplateField>) —

    Fields that are part of the template.

    The request must contain exactly one field of type NAME. This field must also be listed in the RequiredFields array within the Constraints parameter.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



5447
5448
5449
5450
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5447

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

#create_test_case(params = {}) ⇒ Types::CreateTestCaseResponse

Creates a test case with its content and metadata for the specified Amazon Connect instance.

Examples:

Request syntax with placeholder values


resp = client.create_test_case({
  instance_id: "InstanceIdOrArn", # required
  name: "TestCaseName", # required
  description: "TestCaseDescription",
  content: "TestCaseContent", # required
  entry_point: {
    type: "VOICE_CALL", # accepts VOICE_CALL, CHAT
    voice_call_entry_point_parameters: {
      source_phone_number: "PhoneNumber",
      destination_phone_number: "PhoneNumber",
      flow_id: "ContactFlowId",
    },
    chat_entry_point_parameters: {
      flow_id: "ContactFlowId",
    },
  },
  initialization_data: "TestCaseInitializationData",
  status: "PUBLISHED", # accepts PUBLISHED, SAVED
  test_case_id: "TestCaseId",
  tags: {
    "TagKey" => "TagValue",
  },
  last_modified_time: Time.now,
  last_modified_region: "RegionName",
})

Response structure


resp.test_case_id #=> String
resp.test_case_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance.

  • :name (required, String) —

    The name of the test.

  • :description (String) —

    The description of the test.

  • :content (required, String) —

    The JSON string that represents the content of the test.

  • :entry_point (Types::TestCaseEntryPoint) —

    Defines the starting point for your test.

  • :initialization_data (String) —

    Defines the initial custom attributes for your test.

  • :status (String) —

    Indicates the test status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. The SAVED status does not initiate validation of the content.

  • :test_case_id (String) —

    Id of the test case if you want to create it in a replica region using Amazon Connect Global Resiliency

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource.

  • :last_modified_time (Time, DateTime, Date, Integer, String) —

    The time at which the resource was last modified.

  • :last_modified_region (String) —

    The region in which the resource was last modified

Returns:

See Also:



5533
5534
5535
5536
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5533

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

#create_traffic_distribution_group(params = {}) ⇒ Types::CreateTrafficDistributionGroupResponse

Creates a traffic distribution group given an Connect Customer instance that has been replicated.

The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.create_traffic_distribution_group({
  name: "Name128", # required
  description: "Description250",
  instance_id: "InstanceIdOrArn", # required
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.id #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name for the traffic distribution group.

  • :description (String) —

    A description for the traffic distribution group.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance that has been replicated. You can find the instanceId in the ARN of the instance.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

See Also:



5613
5614
5615
5616
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5613

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

#create_use_case(params = {}) ⇒ Types::CreateUseCaseResponse

Creates a use case for an integration association.

Examples:

Request syntax with placeholder values


resp = client.create_use_case({
  instance_id: "InstanceId", # required
  integration_association_id: "IntegrationAssociationId", # required
  use_case_type: "RULES_EVALUATION", # required, accepts RULES_EVALUATION, CONNECT_CAMPAIGNS
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.use_case_id #=> String
resp.use_case_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :integration_association_id (required, String) —

    The identifier for the integration association.

  • :use_case_type (required, String) —

    The type of use case to associate to the integration association. Each integration association can have only one of each use case type.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

See Also:



5665
5666
5667
5668
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5665

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

#create_user(params = {}) ⇒ Types::CreateUserResponse

Creates a user account for the specified Connect Customer instance.

Certain UserIdentityInfo parameters are required in some situations. For example, Email, FirstName and LastName are required if you are using Connect Customer or SAML for identity management.

Fields in PhoneConfig cannot be set simultaneously with their corresponding channel-specific configuration parameters. Specifically:

  • PhoneConfig.AutoAccept conflicts with AutoAcceptConfigs

  • PhoneConfig.AfterContactWorkTimeLimit conflicts with AfterContactWorkConfigs

  • PhoneConfig.PhoneType and PhoneConfig.PhoneNumber conflict with PhoneNumberConfigs

  • PhoneConfig.PersistentConnection conflicts with PersistentConnectionConfigs

We recommend using channel-specific parameters such as AutoAcceptConfigs, AfterContactWorkConfigs, PhoneNumberConfigs, PersistentConnectionConfigs, and VoiceEnhancementConfigs for per-channel configuration.

For information about how to create users using the Connect Customer admin website, see Add Users in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.create_user({
  username: "AgentUsername", # required
  password: "Password",
  identity_info: {
    first_name: "AgentFirstName",
    last_name: "AgentLastName",
    email: "Email",
    secondary_email: "Email",
    mobile: "PhoneNumber",
  },
  phone_config: {
    phone_type: "SOFT_PHONE", # accepts SOFT_PHONE, DESK_PHONE
    auto_accept: false,
    after_contact_work_time_limit: 1,
    desk_phone_number: "SensitivePhoneNumber",
    persistent_connection: false,
  },
  directory_user_id: "DirectoryUserId",
  security_profile_ids: ["SecurityProfileId"], # required
  routing_profile_id: "RoutingProfileId", # required
  hierarchy_group_id: "HierarchyGroupId",
  instance_id: "InstanceId", # required
  auto_accept_configs: [
    {
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      auto_accept: false, # required
      agent_first_callback_auto_accept: false,
    },
  ],
  after_contact_work_configs: [
    {
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      after_contact_work_config: { # required
        after_contact_work_time_limit: 1,
      },
      agent_first_callback_after_contact_work_config: {
        after_contact_work_time_limit: 1,
      },
    },
  ],
  phone_number_configs: [
    {
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
      phone_number: "SensitivePhoneNumber",
    },
  ],
  persistent_connection_configs: [
    {
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      persistent_connection: false, # required
    },
  ],
  voice_enhancement_configs: [
    {
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      voice_enhancement_mode: "VOICE_ISOLATION", # required, accepts VOICE_ISOLATION, NOISE_SUPPRESSION, NONE
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.user_id #=> String
resp.user_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :username (required, String) —

    The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

    Username can include @ only if used in an email format. For example:

  • :password (String) —

    The password for the user account. A password is required if you are using Connect Customer for identity management. Otherwise, it is an error to include a password.

  • :identity_info (Types::UserIdentityInfo) —

    The information about the identity of the user.

  • :phone_config (Types::UserPhoneConfig) —

    The phone settings for the user. This parameter is optional. If not provided, the user can be configured using channel-specific parameters such as AutoAcceptConfigs, AfterContactWorkConfigs, PhoneNumberConfigs, PersistentConnectionConfigs, and VoiceEnhancementConfigs.

  • :directory_user_id (String) —

    The identifier of the user account in the directory used for identity management. If Connect Customer cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Connect Customer cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

    This parameter is required if you are using an existing directory for identity management in Connect Customer when Connect Customer cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

  • :security_profile_ids (required, Array<String>) —

    The identifier of the security profile for the user.

  • :routing_profile_id (required, String) —

    The identifier of the routing profile for the user.

  • :hierarchy_group_id (String) —

    The identifier of the hierarchy group for the user.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :auto_accept_configs (Array<Types::AutoAcceptConfig>) —

    The list of auto-accept configuration settings for each channel.

  • :after_contact_work_configs (Array<Types::AfterContactWorkConfigPerChannel>) —

    The list of after contact work (ACW) timeout configuration settings for each channel.

  • :phone_number_configs (Array<Types::PhoneNumberConfig>) —

    The list of phone number configuration settings for each channel.

  • :persistent_connection_configs (Array<Types::PersistentConnectionConfig>) —

    The list of persistent connection configuration settings for each channel.

  • :voice_enhancement_configs (Array<Types::VoiceEnhancementConfig>) —

    The list of voice enhancement configuration settings for each channel.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

See Also:



5868
5869
5870
5871
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5868

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

#create_user_hierarchy_group(params = {}) ⇒ Types::CreateUserHierarchyGroupResponse

Creates a new user hierarchy group.

Examples:

Request syntax with placeholder values


resp = client.create_user_hierarchy_group({
  name: "HierarchyGroupName", # required
  parent_group_id: "HierarchyGroupId",
  instance_id: "InstanceId", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.hierarchy_group_id #=> String
resp.hierarchy_group_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the user hierarchy group. Must not be more than 100 characters.

  • :parent_group_id (String) —

    The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

See Also:



5921
5922
5923
5924
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5921

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

#create_view(params = {}) ⇒ Types::CreateViewResponse

Creates a new view with the possible status of SAVED or PUBLISHED.

The views will have a unique name for each connect instance.

It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.

Examples:

Request syntax with placeholder values


resp = client.create_view({
  instance_id: "ViewsInstanceId", # required
  client_token: "ViewsClientToken",
  status: "PUBLISHED", # required, accepts PUBLISHED, SAVED
  content: { # required
    template: "ViewTemplate",
    actions: ["ViewAction"],
  },
  description: "ViewDescription",
  name: "ViewName", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.view.id #=> String
resp.view.arn #=> String
resp.view.name #=> String
resp.view.status #=> String, one of "PUBLISHED", "SAVED"
resp.view.type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
resp.view.description #=> String
resp.view.version #=> Integer
resp.view.version_description #=> String
resp.view.content.input_schema #=> String
resp.view.content.template #=> String
resp.view.content.actions #=> Array
resp.view.content.actions[0] #=> String
resp.view.tags #=> Hash
resp.view.tags["TagKey"] #=> String
resp.view.created_time #=> Time
resp.view.last_modified_time #=> Time
resp.view.view_content_sha_256 #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

  • :client_token (String) —

    A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent ClientToken is provided.

  • :status (required, String) —

    Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

  • :content (required, Types::ViewInputContent) —

    View content containing all content necessary to render a view except for runtime input data.

    The total uncompressed content has a maximum file size of 400kB.

  • :description (String) —

    The description of the view.

  • :name (required, String) —

    The name of the view.

  • :tags (Hash<String,String>) —

    The tags associated with the view resource (not specific to view version).These tags can be used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

Returns:

See Also:



6012
6013
6014
6015
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6012

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

#create_view_version(params = {}) ⇒ Types::CreateViewVersionResponse

Publishes a new version of the view identifier.

Versions are immutable and monotonically increasing.

It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.

Examples:

Request syntax with placeholder values


resp = client.create_view_version({
  instance_id: "ViewsInstanceId", # required
  view_id: "ViewId", # required
  version_description: "ViewDescription",
  view_content_sha_256: "ViewContentSha256",
})

Response structure


resp.view.id #=> String
resp.view.arn #=> String
resp.view.name #=> String
resp.view.status #=> String, one of "PUBLISHED", "SAVED"
resp.view.type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
resp.view.description #=> String
resp.view.version #=> Integer
resp.view.version_description #=> String
resp.view.content.input_schema #=> String
resp.view.content.template #=> String
resp.view.content.actions #=> Array
resp.view.content.actions[0] #=> String
resp.view.tags #=> Hash
resp.view.tags["TagKey"] #=> String
resp.view.created_time #=> Time
resp.view.last_modified_time #=> Time
resp.view.view_content_sha_256 #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

  • :view_id (required, String) —

    The identifier of the view. Both ViewArn and ViewId can be used.

  • :version_description (String) —

    The description for the version being published.

  • :view_content_sha_256 (String) —

    Indicates the checksum value of the latest published view content.

Returns:

See Also:



6076
6077
6078
6079
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6076

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

#create_vocabulary(params = {}) ⇒ Types::CreateVocabularyResponse

Creates a custom vocabulary associated with your Connect Customer instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Connect Customer uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

Examples:

Request syntax with placeholder values


resp = client.create_vocabulary({
  client_token: "ClientToken",
  instance_id: "InstanceId", # required
  vocabulary_name: "VocabularyName", # required
  language_code: "ar-AE", # required, accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA, ca-ES, da-DK, fi-FI, id-ID, ms-MY, nl-NL, no-NO, pl-PL, sv-SE, tl-PH
  content: "VocabularyContent", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.vocabulary_arn #=> String
resp.vocabulary_id #=> String
resp.state #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "DELETE_IN_PROGRESS"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :vocabulary_name (required, String) —

    A unique name of the custom vocabulary.

  • :language_code (required, String) —

    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

  • :content (required, String) —

    The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

See Also:



6167
6168
6169
6170
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6167

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

#create_workspace(params = {}) ⇒ Types::CreateWorkspaceResponse

Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.

Examples:

Request syntax with placeholder values


resp = client.create_workspace({
  instance_id: "InstanceId", # required
  name: "WorkspaceName", # required
  description: "WorkspaceDescription",
  theme: {
    light: {
      palette: {
        header: {
          background: "ThemeString",
          text: "ThemeString",
          text_hover: "ThemeString",
          invert_actions_colors: false,
        },
        navigation: {
          background: "ThemeString",
          text_background_hover: "ThemeString",
          text_background_active: "ThemeString",
          text: "ThemeString",
          text_hover: "ThemeString",
          text_active: "ThemeString",
          invert_actions_colors: false,
        },
        canvas: {
          container_background: "ThemeString",
          page_background: "ThemeString",
          active_background: "ThemeString",
        },
        primary: {
          default: "ThemeString",
          active: "ThemeString",
          contrast_text: "ThemeString",
        },
      },
      images: {
        logo: {
          default: "ThemeImageLink",
          favicon: "ThemeImageLink",
        },
      },
      typography: {
        font_family: {
          default: "Arial", # accepts Arial, Courier New, Georgia, Times New Roman, Trebuchet, Verdana
        },
      },
    },
    dark: {
      palette: {
        header: {
          background: "ThemeString",
          text: "ThemeString",
          text_hover: "ThemeString",
          invert_actions_colors: false,
        },
        navigation: {
          background: "ThemeString",
          text_background_hover: "ThemeString",
          text_background_active: "ThemeString",
          text: "ThemeString",
          text_hover: "ThemeString",
          text_active: "ThemeString",
          invert_actions_colors: false,
        },
        canvas: {
          container_background: "ThemeString",
          page_background: "ThemeString",
          active_background: "ThemeString",
        },
        primary: {
          default: "ThemeString",
          active: "ThemeString",
          contrast_text: "ThemeString",
        },
      },
      images: {
        logo: {
          default: "ThemeImageLink",
          favicon: "ThemeImageLink",
        },
      },
      typography: {
        font_family: {
          default: "Arial", # accepts Arial, Courier New, Georgia, Times New Roman, Trebuchet, Verdana
        },
      },
    },
  },
  title: "WorkspaceTitle",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.workspace_id #=> String
resp.workspace_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    The name of the workspace. Must be unique within the instance and can contain 1-127 characters.

  • :description (String) —

    The description of the workspace. Maximum length is 250 characters.

  • :theme (Types::WorkspaceTheme) —

    The theme configuration for the workspace, including colors and styling.

  • :title (String) —

    The title displayed for the workspace.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Returns:

See Also:



6309
6310
6311
6312
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6309

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

#create_workspace_page(params = {}) ⇒ Struct

Associates a view with a page in a workspace, defining what users see when they navigate to that page.

Examples:

Request syntax with placeholder values


resp = client.create_workspace_page({
  instance_id: "InstanceId", # required
  workspace_id: "WorkspaceId", # required
  resource_arn: "ARN", # required
  page: "Page", # required
  slug: "Slug",
  input_data: "InputData",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :workspace_id (required, String) —

    The identifier of the workspace.

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the view to associate with the page.

  • :page (required, String) —

    The page identifier. Valid system pages include HOME and AGENT_EXPERIENCE. Custom pages cannot use the aws: or connect: prefixes.

  • :slug (String) —

    The URL-friendly identifier for the page.

  • :input_data (String) —

    A JSON string containing input parameters for the view, validated against the view's input schema.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6360
6361
6362
6363
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6360

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

#deactivate_evaluation_form(params = {}) ⇒ Types::DeactivateEvaluationFormResponse

Deactivates an evaluation form in the specified Connect Customer instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.

Examples:

Request syntax with placeholder values


resp = client.deactivate_evaluation_form({
  instance_id: "InstanceId", # required
  evaluation_form_id: "ResourceId", # required
  evaluation_form_version: 1, # required
})

Response structure


resp.evaluation_form_id #=> String
resp.evaluation_form_arn #=> String
resp.evaluation_form_version #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :evaluation_form_id (required, String) —

    The unique identifier for the evaluation form.

  • :evaluation_form_version (required, Integer) —

    A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is deactivated.

Returns:

See Also:



6408
6409
6410
6411
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6408

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

#delete_attached_file(params = {}) ⇒ Struct

Deletes an attached file along with the underlying S3 Object.

The attached file is permanently deleted if S3 bucket versioning is not enabled.

Examples:

Request syntax with placeholder values


resp = client.delete_attached_file({
  instance_id: "InstanceId", # required
  file_id: "FileId", # required
  associated_resource_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier of the Connect instance.

  • :file_id (required, String) —

    The unique identifier of the attached file resource.

  • :associated_resource_arn (required, String) —

    The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task.

    This value must be a valid ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6452
6453
6454
6455
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6452

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

#delete_contact_data(params = {}) ⇒ Struct

Deletes the specified fields containing personally identifiable information (PII) from a contact in the specified Connect Customer instance. We redact PII (such as customer endpoints, additional email recipients, and the email subject) from the contact and its associated contact trace record (CTR). The contact must be in a terminated state.

This deletion is permanent and cannot be undone. Performing this operation permanently deletes the specified PII. There is no retention period; you cannot recover the data after deletion. We remove only the fields that Connect Customer identifies and stores as PII. Any PII that you place in fields outside the scope of this operation remains your responsibility to remove.

Examples:

Request syntax with placeholder values


resp = client.delete_contact_data({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  contact_fields: ["CUSTOMER_ENDPOINT"], # required, accepts CUSTOMER_ENDPOINT, ADDITIONAL_EMAIL_RECIPIENTS, EMAIL_SUBJECT
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact. You can delete PII only from a contact that has been disconnected (is in a terminated state).

  • :contact_fields (required, Array<String>) —

    The categories of PII to redact from the contact. Specify one or more of the following values:

    • CUSTOMER_ENDPOINT – The customer's contact endpoint.

    • ADDITIONAL_EMAIL_RECIPIENTS – Additional recipients on an email contact (email channel only).

    • EMAIL_SUBJECT – The subject line of an email contact (email channel only).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6508
6509
6510
6511
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6508

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

#delete_contact_evaluation(params = {}) ⇒ Struct

Deletes a contact evaluation in the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.delete_contact_evaluation({
  instance_id: "InstanceId", # required
  evaluation_id: "ResourceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :evaluation_id (required, String) —

    A unique identifier for the contact evaluation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6540
6541
6542
6543
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6540

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

#delete_contact_flow(params = {}) ⇒ Struct

Deletes a flow for the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.delete_contact_flow({
  instance_id: "InstanceId", # required
  contact_flow_id: "ContactFlowId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_id (required, String) —

    The identifier of the flow.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6571
6572
6573
6574
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6571

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

#delete_contact_flow_module(params = {}) ⇒ Struct

Deletes the specified flow module.

Examples:

Request syntax with placeholder values


resp = client.delete_contact_flow_module({
  instance_id: "InstanceId", # required
  contact_flow_module_id: "ContactFlowModuleId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_module_id (required, String) —

    The identifier of the flow module.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6602
6603
6604
6605
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6602

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

#delete_contact_flow_module_alias(params = {}) ⇒ Struct

Removes an alias reference, breaking the named connection to the underlying module version without affecting the version itself.

Examples:

Request syntax with placeholder values


resp = client.delete_contact_flow_module_alias({
  instance_id: "InstanceIdOrArn", # required
  contact_flow_module_id: "ResourceId", # required
  alias_id: "ResourceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_module_id (required, String) —

    The identifier of the flow module.

  • :alias_id (required, String) —

    The identifier of the alias.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6638
6639
6640
6641
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6638

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

#delete_contact_flow_module_version(params = {}) ⇒ Struct

Removes a specific version of a contact flow module.

Examples:

Request syntax with placeholder values


resp = client.delete_contact_flow_module_version({
  instance_id: "InstanceId", # required
  contact_flow_module_id: "ARN", # required
  contact_flow_module_version: 1, # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_module_id (required, String) —

    The identifier of the flow module.

  • :contact_flow_module_version (required, Integer) —

    The version of the flow module to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6673
6674
6675
6676
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6673

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

#delete_contact_flow_version(params = {}) ⇒ Struct

Deletes the particular version specified in flow version identifier.

Examples:

Request syntax with placeholder values


resp = client.delete_contact_flow_version({
  instance_id: "InstanceId", # required
  contact_flow_id: "ARN", # required
  contact_flow_version: 1, # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_id (required, String) —

    The identifier of the flow.

  • :contact_flow_version (required, Integer) —

    The identifier of the flow version.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6708
6709
6710
6711
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6708

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

#delete_data_table(params = {}) ⇒ Struct

Deletes a data table and all associated attributes, versions, audits, and values. Does not update any references to the data table, even from other data tables. This includes dynamic values and conditional validations. System managed data tables are not deletable by customers. API users may delete the table at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the table and its values were accessed.

Examples:

Request syntax with placeholder values


resp = client.delete_data_table({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table to delete. Must also accept the table ARN. Fails with an error if the version is provided and is not $LATEST.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6742
6743
6744
6745
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6742

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

#delete_data_table_attribute(params = {}) ⇒ Types::DeleteDataTableAttributeResponse

Deletes an attribute and all its values from a data table.

Examples:

Request syntax with placeholder values


resp = client.delete_data_table_attribute({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
  attribute_name: "DataTableName", # required
})

Response structure


resp.lock_version.data_table #=> String
resp.lock_version.attribute #=> String
resp.lock_version.primary_values #=> String
resp.lock_version.value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table.

  • :attribute_name (required, String) —

    The name of the attribute to delete.

Returns:

See Also:



6781
6782
6783
6784
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6781

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

#delete_email_address(params = {}) ⇒ Struct

Deletes email address from the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.delete_email_address({
  instance_id: "InstanceId", # required
  email_address_id: "EmailAddressId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :email_address_id (required, String) —

    The identifier of the email address.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6812
6813
6814
6815
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6812

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

#delete_evaluation_form(params = {}) ⇒ Struct

Deletes an evaluation form in the specified Connect Customer instance.

  • If the version property is provided, only the specified version of the evaluation form is deleted.

  • If no version is provided, then the full form (all versions) is deleted.

Examples:

Request syntax with placeholder values


resp = client.delete_evaluation_form({
  instance_id: "InstanceId", # required
  evaluation_form_id: "ResourceId", # required
  evaluation_form_version: 1,
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :evaluation_form_id (required, String) —

    The unique identifier for the evaluation form.

  • :evaluation_form_version (Integer) —

    The unique identifier for the evaluation form.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6853
6854
6855
6856
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6853

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

#delete_hours_of_operation(params = {}) ⇒ Struct

Deletes an hours of operation.

Examples:

Request syntax with placeholder values


resp = client.delete_hours_of_operation({
  instance_id: "InstanceId", # required
  hours_of_operation_id: "HoursOfOperationId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :hours_of_operation_id (required, String) —

    The identifier for the hours of operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6884
6885
6886
6887
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6884

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

#delete_hours_of_operation_override(params = {}) ⇒ Struct

Deletes an hours of operation override in an Connect Customer hours of operation resource.

Examples:

Request syntax with placeholder values


resp = client.delete_hours_of_operation_override({
  instance_id: "InstanceId", # required
  hours_of_operation_id: "HoursOfOperationId", # required
  hours_of_operation_override_id: "HoursOfOperationOverrideId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance.

  • :hours_of_operation_id (required, String) —

    The identifier for the hours of operation.

  • :hours_of_operation_override_id (required, String) —

    The identifier for the hours of operation override.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6915
6916
6917
6918
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6915

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

#delete_instance(params = {}) ⇒ Struct

This API is in preview release for Connect Customer and is subject to change.

Deletes the Connect Customer instance. For more information, see Delete your Connect Customer instance in the Connect Customer Administrator Guide.

Connect Customer enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

Examples:

Request syntax with placeholder values


resp = client.delete_instance({
  instance_id: "InstanceId", # required
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6972
6973
6974
6975
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6972

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

#delete_integration_association(params = {}) ⇒ Struct

Deletes an Amazon Web Services resource association from an Connect Customer instance. The association must not have any use cases associated with it.

Examples:

Request syntax with placeholder values


resp = client.delete_integration_association({
  instance_id: "InstanceId", # required
  integration_association_id: "IntegrationAssociationId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :integration_association_id (required, String) —

    The identifier for the integration association.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7005
7006
7007
7008
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7005

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

#delete_metric(params = {}) ⇒ Struct

Deletes an existing metric from the specified Connect Customer instance. This operation fails with ResourceConflictException if the metric is currently in use in a dashboard.

Examples:

Request syntax with placeholder values


resp = client.delete_metric({
  instance_id: "InstanceId", # required
  metric_id: "MetricId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :metric_id (required, String) —

    The identifier of the metric to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7038
7039
7040
7041
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7038

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

#delete_notification(params = {}) ⇒ Struct

Deletes a notification. Once deleted, the notification is no longer visible to all users and cannot be managed through the Admin Website or APIs.

Examples:

Request syntax with placeholder values


resp = client.delete_notification({
  instance_id: "InstanceId", # required
  notification_id: "NotificationId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :notification_id (required, String) —

    The unique identifier for the notification to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7071
7072
7073
7074
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7071

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

#delete_predefined_attribute(params = {}) ⇒ Struct

Deletes a predefined attribute from the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.delete_predefined_attribute({
  instance_id: "InstanceId", # required
  name: "PredefinedAttributeName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    The name of the predefined attribute.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7099
7100
7101
7102
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7099

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

#delete_prompt(params = {}) ⇒ Struct

Deletes a prompt.

Examples:

Request syntax with placeholder values


resp = client.delete_prompt({
  instance_id: "InstanceId", # required
  prompt_id: "PromptId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :prompt_id (required, String) —

    A unique identifier for the prompt.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7130
7131
7132
7133
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7130

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

#delete_push_notification_registration(params = {}) ⇒ Struct

Deletes registration for a device token and a chat contact.

Examples:

Request syntax with placeholder values


resp = client.delete_push_notification_registration({
  instance_id: "InstanceId", # required
  registration_id: "RegistrationId", # required
  contact_id: "ContactId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :registration_id (required, String) —

    The identifier for the registration.

  • :contact_id (required, String) —

    The identifier of the contact within the Connect Customer instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7165
7166
7167
7168
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7165

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

#delete_queue(params = {}) ⇒ Struct

Deletes a queue.

Examples:

Request syntax with placeholder values


resp = client.delete_queue({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :queue_id (required, String) —

    The identifier for the queue.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7196
7197
7198
7199
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7196

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

#delete_quick_connect(params = {}) ⇒ Struct

Deletes a quick connect.

After calling DeleteUser, it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

  • Avoid dangling resources that impact your service quotas.

  • Remove deleted users so they don't appear to agents as transfer options.

  • Avoid the disruption of other Connect Customer processes, such as instance replication and syncing if you're using Connect Customer Global Resiliency.

Examples:

Request syntax with placeholder values


resp = client.delete_quick_connect({
  instance_id: "InstanceId", # required
  quick_connect_id: "QuickConnectId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :quick_connect_id (required, String) —

    The identifier for the quick connect.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7245
7246
7247
7248
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7245

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

#delete_routing_profile(params = {}) ⇒ Struct

Deletes a routing profile.

Examples:

Request syntax with placeholder values


resp = client.delete_routing_profile({
  instance_id: "InstanceId", # required
  routing_profile_id: "RoutingProfileId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :routing_profile_id (required, String) —

    The identifier of the routing profile.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7276
7277
7278
7279
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7276

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

#delete_rule(params = {}) ⇒ Struct

Deletes a rule for the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.delete_rule({
  instance_id: "InstanceId", # required
  rule_id: "RuleId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :rule_id (required, String) —

    A unique identifier for the rule.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7307
7308
7309
7310
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7307

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

#delete_security_profile(params = {}) ⇒ Struct

Deletes a security profile.

Examples:

Request syntax with placeholder values


resp = client.delete_security_profile({
  instance_id: "InstanceId", # required
  security_profile_id: "SecurityProfileId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :security_profile_id (required, String) —

    The identifier for the security profle.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7338
7339
7340
7341
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7338

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

#delete_session(params = {}) ⇒ Struct

Deletes a session for the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.delete_session({
  instance_id: "InstanceId", # required
  session_id: "SessionId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :session_id (required, String) —

    The identifier of the session to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7369
7370
7371
7372
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7369

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

#delete_task_template(params = {}) ⇒ Struct

Deletes the task template.

Examples:

Request syntax with placeholder values


resp = client.delete_task_template({
  instance_id: "InstanceId", # required
  task_template_id: "TaskTemplateId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :task_template_id (required, String) —

    A unique identifier for the task template.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7400
7401
7402
7403
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7400

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

#delete_test_case(params = {}) ⇒ Struct

Deletes the test case that has already been created for the specified Amazon Connect instance.

Examples:

Request syntax with placeholder values


resp = client.delete_test_case({
  instance_id: "InstanceIdOrArn", # required
  test_case_id: "TestCaseId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance.

  • :test_case_id (required, String) —

    The identifier of the test case to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7427
7428
7429
7430
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7427

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

#delete_traffic_distribution_group(params = {}) ⇒ Struct

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_traffic_distribution_group({
  traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :traffic_distribution_group_id (required, String) —

    The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7459
7460
7461
7462
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7459

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

#delete_use_case(params = {}) ⇒ Struct

Deletes a use case from an integration association.

Examples:

Request syntax with placeholder values


resp = client.delete_use_case({
  instance_id: "InstanceId", # required
  integration_association_id: "IntegrationAssociationId", # required
  use_case_id: "UseCaseId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :integration_association_id (required, String) —

    The identifier for the integration association.

  • :use_case_id (required, String) —

    The identifier for the use case.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7494
7495
7496
7497
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7494

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

#delete_user(params = {}) ⇒ Struct

Deletes a user account from the specified Connect Customer instance.

For information about what happens to a user's data when their account is deleted, see Delete Users from Your Connect Customer Instance in the Connect Customer Administrator Guide.

After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

  • Avoid dangling resources that impact your service quotas.

  • Remove deleted users so they don't appear to agents as transfer options.

  • Avoid the disruption of other Connect Customer processes, such as instance replication and syncing if you're using Connect Customer Global Resiliency.

Examples:

Request syntax with placeholder values


resp = client.delete_user({
  instance_id: "InstanceId", # required
  user_id: "UserId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :user_id (required, String) —

    The identifier of the user.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7547
7548
7549
7550
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7547

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

#delete_user_hierarchy_group(params = {}) ⇒ Struct

Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.

Examples:

Request syntax with placeholder values


resp = client.delete_user_hierarchy_group({
  hierarchy_group_id: "HierarchyGroupId", # required
  instance_id: "InstanceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :hierarchy_group_id (required, String) —

    The identifier of the hierarchy group.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7579
7580
7581
7582
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7579

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

#delete_view(params = {}) ⇒ Struct

Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).

Examples:

Request syntax with placeholder values


resp = client.delete_view({
  instance_id: "ViewsInstanceId", # required
  view_id: "ViewId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

  • :view_id (required, String) —

    The identifier of the view. Both ViewArn and ViewId can be used.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7607
7608
7609
7610
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7607

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

#delete_view_version(params = {}) ⇒ Struct

Deletes the particular version specified in ViewVersion identifier.

Examples:

Request syntax with placeholder values


resp = client.delete_view_version({
  instance_id: "ViewsInstanceId", # required
  view_id: "ViewId", # required
  view_version: 1, # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

  • :view_id (required, String) —

    The identifier of the view. Both ViewArn and ViewId can be used.

  • :view_version (required, Integer) —

    The version number of the view.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7638
7639
7640
7641
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7638

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

#delete_vocabulary(params = {}) ⇒ Types::DeleteVocabularyResponse

Deletes the vocabulary that has the given identifier.

Examples:

Request syntax with placeholder values


resp = client.delete_vocabulary({
  instance_id: "InstanceId", # required
  vocabulary_id: "VocabularyId", # required
})

Response structure


resp.vocabulary_arn #=> String
resp.vocabulary_id #=> String
resp.state #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "DELETE_IN_PROGRESS"

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :vocabulary_id (required, String) —

    The identifier of the custom vocabulary.

Returns:

See Also:



7679
7680
7681
7682
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7679

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

#delete_workspace(params = {}) ⇒ Struct

Deletes a workspace and removes all associated view and resource assignments.

Examples:

Request syntax with placeholder values


resp = client.delete_workspace({
  instance_id: "InstanceId", # required
  workspace_id: "WorkspaceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :workspace_id (required, String) —

    The identifier of the workspace.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7711
7712
7713
7714
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7711

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

#delete_workspace_media(params = {}) ⇒ Struct

Deletes a media asset (such as a logo) from a workspace.

Examples:

Request syntax with placeholder values


resp = client.delete_workspace_media({
  instance_id: "InstanceId", # required
  workspace_id: "WorkspaceId", # required
  media_type: "IMAGE_LOGO_LIGHT_FAVICON", # required, accepts IMAGE_LOGO_LIGHT_FAVICON, IMAGE_LOGO_DARK_FAVICON, IMAGE_LOGO_LIGHT_HORIZONTAL, IMAGE_LOGO_DARK_HORIZONTAL
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :workspace_id (required, String) —

    The identifier of the workspace.

  • :media_type (required, String) —

    The type of media to delete. Valid values are: IMAGE_LOGO_FAVICON and IMAGE_LOGO_HORIZONTAL.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7747
7748
7749
7750
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7747

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

#delete_workspace_page(params = {}) ⇒ Struct

Removes the association between a view and a page in a workspace. The page will display the default view after deletion.

Examples:

Request syntax with placeholder values


resp = client.delete_workspace_page({
  instance_id: "InstanceId", # required
  workspace_id: "WorkspaceId", # required
  page: "Page", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :workspace_id (required, String) —

    The identifier of the workspace.

  • :page (required, String) —

    The page identifier.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7783
7784
7785
7786
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7783

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

#describe_agent_status(params = {}) ⇒ Types::DescribeAgentStatusResponse

Describes an agent status.

Examples:

Request syntax with placeholder values


resp = client.describe_agent_status({
  instance_id: "InstanceId", # required
  agent_status_id: "AgentStatusId", # required
})

Response structure


resp.agent_status.agent_status_arn #=> String
resp.agent_status.agent_status_id #=> String
resp.agent_status.name #=> String
resp.agent_status.description #=> String
resp.agent_status.type #=> String, one of "ROUTABLE", "CUSTOM", "OFFLINE"
resp.agent_status.display_order #=> Integer
resp.agent_status.state #=> String, one of "ENABLED", "DISABLED"
resp.agent_status.tags #=> Hash
resp.agent_status.tags["TagKey"] #=> String
resp.agent_status.last_modified_time #=> Time
resp.agent_status.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :agent_status_id (required, String) —

    The identifier for the agent status.

Returns:

See Also:



7830
7831
7832
7833
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7830

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

#describe_attached_files_configuration(params = {}) ⇒ Types::DescribeAttachedFilesConfigurationResponse

Describes the attached files configuration for the specified Connect Customer instance and attachment scope.

If a custom configuration exists for the specified attachment scope, the custom configuration is returned. If no custom configuration exists, the default configuration values for that attachment scope are returned.

Examples:

Request syntax with placeholder values


resp = client.describe_attached_files_configuration({
  instance_id: "InstanceId", # required
  attachment_scope: "EMAIL", # required, accepts EMAIL, CHAT, CASE, TASK
})

Response structure


resp.attached_files_configuration.instance_id #=> String
resp.attached_files_configuration.attachment_scope #=> String, one of "EMAIL", "CHAT", "CASE", "TASK"
resp.attached_files_configuration.maximum_size_limit_in_bytes #=> Integer
resp.attached_files_configuration.extension_configuration.allowed_extensions #=> Array
resp.attached_files_configuration.extension_configuration.allowed_extensions[0].extension #=> String
resp.attached_files_configuration.last_modified_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :attachment_scope (required, String) —

    The scope of the attachment. Valid values are EMAIL, CHAT, CASE, and TASK.

Returns:

See Also:



7879
7880
7881
7882
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7879

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

#describe_authentication_profile(params = {}) ⇒ Types::DescribeAuthenticationProfileResponse

This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support.

Describes the target authentication profile.

Examples:

Request syntax with placeholder values


resp = client.describe_authentication_profile({
  authentication_profile_id: "AuthenticationProfileId", # required
  instance_id: "InstanceId", # required
})

Response structure


resp.authentication_profile.id #=> String
resp.authentication_profile.arn #=> String
resp.authentication_profile.name #=> String
resp.authentication_profile.description #=> String
resp.authentication_profile.allowed_ips #=> Array
resp.authentication_profile.allowed_ips[0] #=> String
resp.authentication_profile.blocked_ips #=> Array
resp.authentication_profile.blocked_ips[0] #=> String
resp.authentication_profile.is_default #=> Boolean
resp.authentication_profile.created_time #=> Time
resp.authentication_profile.last_modified_time #=> Time
resp.authentication_profile.last_modified_region #=> String
resp.authentication_profile.periodic_session_duration #=> Integer
resp.authentication_profile.max_session_duration #=> Integer
resp.authentication_profile.session_inactivity_duration #=> Integer
resp.authentication_profile.session_inactivity_handling_enabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :authentication_profile_id (required, String) —

    A unique identifier for the authentication profile.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



7935
7936
7937
7938
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7935

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

#describe_contact(params = {}) ⇒ Types::DescribeContactResponse

This API is in preview release for Connect Customer and is subject to change.

Describes the specified contact.

Use cases

Following are common uses cases for this API:

  • Retrieve contact information such as the caller's phone number and the specific number the caller dialed to integrate into custom monitoring or custom agent experience solutions.

  • Detect when a customer chat session disconnects due to a network issue on the agent's end. Use the DisconnectReason field in the ContactTraceRecord to detect this event and then re-queue the chat for followup.

  • Identify after contact work (ACW) duration and call recordings information when a COMPLETED event is received by using the contact event stream.

Important things to know

  • SystemEndpoint is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK

  • Contact information remains available in Connect Customer for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Connect Customer is returned by this API.

Endpoints: See Connect Customer endpoints and quotas.

Examples:

Request syntax with placeholder values


resp = client.describe_contact({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
})

Response structure


resp.contact.arn #=> String
resp.contact.id #=> String
resp.contact.initial_contact_id #=> String
resp.contact.previous_contact_id #=> String
resp.contact.contact_association_id #=> String
resp.contact.initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR", "EXTERNAL_OUTBOUND", "WEBRTC_API", "AGENT_REPLY", "FLOW"
resp.contact.name #=> String
resp.contact.description #=> String
resp.contact.channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.contact.queue_info.id #=> String
resp.contact.queue_info.enqueue_timestamp #=> Time
resp.contact.agent_info.id #=> String
resp.contact.agent_info.accepted_by_agent_timestamp #=> Time
resp.contact.agent_info.preview_end_timestamp #=> Time
resp.contact.agent_info.connected_to_agent_timestamp #=> Time
resp.contact.agent_info.agent_pause_duration_in_seconds #=> Integer
resp.contact.agent_info.hierarchy_groups.level_1.arn #=> String
resp.contact.agent_info.hierarchy_groups.level_2.arn #=> String
resp.contact.agent_info.hierarchy_groups.level_3.arn #=> String
resp.contact.agent_info.hierarchy_groups.level_4.arn #=> String
resp.contact.agent_info.hierarchy_groups.level_5.arn #=> String
resp.contact.agent_info.device_info.platform_name #=> String
resp.contact.agent_info.device_info.platform_version #=> String
resp.contact.agent_info.device_info.operating_system #=> String
resp.contact.agent_info.capabilities.video #=> String, one of "SEND"
resp.contact.agent_info.capabilities.screen_share #=> String, one of "SEND"
resp.contact.agent_info.after_contact_work_duration #=> Integer
resp.contact.agent_info.after_contact_work_start_timestamp #=> Time
resp.contact.agent_info.after_contact_work_end_timestamp #=> Time
resp.contact.agent_info.agent_initiated_hold_duration #=> Integer
resp.contact.agent_info.state_transitions #=> Array
resp.contact.agent_info.state_transitions[0].state #=> String, one of "INITIAL", "CONNECTED", "DISCONNECTED", "MISSED"
resp.contact.agent_info.state_transitions[0].state_start_timestamp #=> Time
resp.contact.agent_info.state_transitions[0].state_end_timestamp #=> Time
resp.contact.agent_info.voice_enhancement_mode #=> String, one of "VOICE_ISOLATION", "NOISE_SUPPRESSION", "NONE"
resp.contact.initiation_timestamp #=> Time
resp.contact.disconnect_timestamp #=> Time
resp.contact.last_update_timestamp #=> Time
resp.contact.last_paused_timestamp #=> Time
resp.contact.last_resumed_timestamp #=> Time
resp.contact.ring_start_timestamp #=> Time
resp.contact.total_pause_count #=> Integer
resp.contact.total_pause_duration_in_seconds #=> Integer
resp.contact.scheduled_timestamp #=> Time
resp.contact.related_contact_id #=> String
resp.contact.wisdom_info.session_arn #=> String
resp.contact.wisdom_info.ai_agents #=> Array
resp.contact.wisdom_info.ai_agents[0].ai_use_case #=> String, one of "AgentAssistance", "SelfService"
resp.contact.wisdom_info.ai_agents[0].ai_agent_version_id #=> String
resp.contact.wisdom_info.ai_agents[0].ai_agent_escalated #=> Boolean
resp.contact.customer_id #=> String
resp.contact.customer_endpoint.type #=> String, one of "TELEPHONE_NUMBER", "VOIP", "CONTACT_FLOW", "CONNECT_PHONENUMBER_ARN", "EMAIL_ADDRESS"
resp.contact.customer_endpoint.address #=> String
resp.contact.customer_endpoint.display_name #=> String
resp.contact.system_endpoint.type #=> String, one of "TELEPHONE_NUMBER", "VOIP", "CONTACT_FLOW", "CONNECT_PHONENUMBER_ARN", "EMAIL_ADDRESS"
resp.contact.system_endpoint.address #=> String
resp.contact.system_endpoint.display_name #=> String
resp.contact.queue_time_adjustment_seconds #=> Integer
resp.contact.queue_priority #=> Integer
resp.contact.tags #=> Hash
resp.contact.tags["ContactTagKey"] #=> String
resp.contact.connected_to_system_timestamp #=> Time
resp.contact.routing_criteria.steps #=> Array
resp.contact.routing_criteria.steps[0].expiry.duration_in_seconds #=> Integer
resp.contact.routing_criteria.steps[0].expiry.expiry_timestamp #=> Time
resp.contact.routing_criteria.steps[0].expression.attribute_condition.name #=> String
resp.contact.routing_criteria.steps[0].expression.attribute_condition.value #=> String
resp.contact.routing_criteria.steps[0].expression.attribute_condition.proficiency_level #=> Float
resp.contact.routing_criteria.steps[0].expression.attribute_condition.range.min_proficiency_level #=> Float
resp.contact.routing_criteria.steps[0].expression.attribute_condition.range.max_proficiency_level #=> Float
resp.contact.routing_criteria.steps[0].expression.attribute_condition.match_criteria.agents_criteria.agent_ids #=> Array
resp.contact.routing_criteria.steps[0].expression.attribute_condition.match_criteria.agents_criteria.agent_ids[0] #=> String
resp.contact.routing_criteria.steps[0].expression.attribute_condition.comparison_operator #=> String
resp.contact.routing_criteria.steps[0].expression.and_expression #=> Array
resp.contact.routing_criteria.steps[0].expression.and_expression[0] #=> Types::Expression
resp.contact.routing_criteria.steps[0].expression.or_expression #=> Array
resp.contact.routing_criteria.steps[0].expression.or_expression[0] #=> Types::Expression
resp.contact.routing_criteria.steps[0].expression.not_attribute_condition.name #=> String
resp.contact.routing_criteria.steps[0].expression.not_attribute_condition.value #=> String
resp.contact.routing_criteria.steps[0].expression.not_attribute_condition.proficiency_level #=> Float
resp.contact.routing_criteria.steps[0].expression.not_attribute_condition.range.min_proficiency_level #=> Float
resp.contact.routing_criteria.steps[0].expression.not_attribute_condition.range.max_proficiency_level #=> Float
resp.contact.routing_criteria.steps[0].expression.not_attribute_condition.match_criteria.agents_criteria.agent_ids #=> Array
resp.contact.routing_criteria.steps[0].expression.not_attribute_condition.match_criteria.agents_criteria.agent_ids[0] #=> String
resp.contact.routing_criteria.steps[0].expression.not_attribute_condition.comparison_operator #=> String
resp.contact.routing_criteria.steps[0].status #=> String, one of "ACTIVE", "INACTIVE", "JOINED", "EXPIRED"
resp.contact.routing_criteria.activation_timestamp #=> Time
resp.contact.routing_criteria.index #=> Integer
resp.contact.customer.device_info.platform_name #=> String
resp.contact.customer.device_info.platform_version #=> String
resp.contact.customer.device_info.operating_system #=> String
resp.contact.customer.capabilities.video #=> String, one of "SEND"
resp.contact.customer.capabilities.screen_share #=> String, one of "SEND"
resp.contact.campaign.campaign_id #=> String
resp.contact.answering_machine_detection_status #=> String, one of "ANSWERED", "UNDETECTED", "ERROR", "HUMAN_ANSWERED", "SIT_TONE_DETECTED", "SIT_TONE_BUSY", "SIT_TONE_INVALID_NUMBER", "FAX_MACHINE_DETECTED", "VOICEMAIL_BEEP", "VOICEMAIL_NO_BEEP", "AMD_UNRESOLVED", "AMD_UNANSWERED", "AMD_ERROR", "AMD_NOT_APPLICABLE"
resp.contact.customer_voice_activity.greeting_start_timestamp #=> Time
resp.contact.customer_voice_activity.greeting_end_timestamp #=> Time
resp.contact.quality_metrics.agent.audio.quality_score #=> Float
resp.contact.quality_metrics.agent.audio.potential_quality_issues #=> Array
resp.contact.quality_metrics.agent.audio.potential_quality_issues[0] #=> String
resp.contact.quality_metrics.customer.audio.quality_score #=> Float
resp.contact.quality_metrics.customer.audio.potential_quality_issues #=> Array
resp.contact.quality_metrics.customer.audio.potential_quality_issues[0] #=> String
resp.contact.chat_metrics.chat_contact_metrics.multi_party #=> Boolean
resp.contact.chat_metrics.chat_contact_metrics.total_messages #=> Integer
resp.contact.chat_metrics.chat_contact_metrics.total_bot_messages #=> Integer
resp.contact.chat_metrics.chat_contact_metrics.total_bot_message_length_in_chars #=> Integer
resp.contact.chat_metrics.chat_contact_metrics.conversation_close_time_in_millis #=> Integer
resp.contact.chat_metrics.chat_contact_metrics.conversation_turn_count #=> Integer
resp.contact.chat_metrics.chat_contact_metrics.agent_first_response_timestamp #=> Time
resp.contact.chat_metrics.chat_contact_metrics.agent_first_response_time_in_millis #=> Integer
resp.contact.chat_metrics.agent_metrics.participant_id #=> String
resp.contact.chat_metrics.agent_metrics.participant_type #=> String, one of "ALL", "MANAGER", "AGENT", "CUSTOMER", "THIRDPARTY"
resp.contact.chat_metrics.agent_metrics.conversation_abandon #=> Boolean
resp.contact.chat_metrics.agent_metrics.messages_sent #=> Integer
resp.contact.chat_metrics.agent_metrics.num_responses #=> Integer
resp.contact.chat_metrics.agent_metrics.message_length_in_chars #=> Integer
resp.contact.chat_metrics.agent_metrics.total_response_time_in_millis #=> Integer
resp.contact.chat_metrics.agent_metrics.max_response_time_in_millis #=> Integer
resp.contact.chat_metrics.agent_metrics.last_message_timestamp #=> Time
resp.contact.chat_metrics.customer_metrics.participant_id #=> String
resp.contact.chat_metrics.customer_metrics.participant_type #=> String, one of "ALL", "MANAGER", "AGENT", "CUSTOMER", "THIRDPARTY"
resp.contact.chat_metrics.customer_metrics.conversation_abandon #=> Boolean
resp.contact.chat_metrics.customer_metrics.messages_sent #=> Integer
resp.contact.chat_metrics.customer_metrics.num_responses #=> Integer
resp.contact.chat_metrics.customer_metrics.message_length_in_chars #=> Integer
resp.contact.chat_metrics.customer_metrics.total_response_time_in_millis #=> Integer
resp.contact.chat_metrics.customer_metrics.max_response_time_in_millis #=> Integer
resp.contact.chat_metrics.customer_metrics.last_message_timestamp #=> Time
resp.contact.disconnect_details.potential_disconnect_issue #=> String
resp.contact.additional_email_recipients.to_list #=> Array
resp.contact.additional_email_recipients.to_list[0].address #=> String
resp.contact.additional_email_recipients.to_list[0].display_name #=> String
resp.contact.additional_email_recipients.cc_list #=> Array
resp.contact.additional_email_recipients.cc_list[0].address #=> String
resp.contact.additional_email_recipients.cc_list[0].display_name #=> String
resp.contact.segment_attributes #=> Hash
resp.contact.segment_attributes["SegmentAttributeName"].value_string #=> String
resp.contact.segment_attributes["SegmentAttributeName"].value_map #=> Hash
resp.contact.segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"] #=> Types::SegmentAttributeValue
resp.contact.segment_attributes["SegmentAttributeName"].value_integer #=> Integer
resp.contact.segment_attributes["SegmentAttributeName"].value_list #=> Array
resp.contact.segment_attributes["SegmentAttributeName"].value_list[0] #=> Types::SegmentAttributeValue
resp.contact.segment_attributes["SegmentAttributeName"].value_arn #=> String
resp.contact.recordings #=> Array
resp.contact.recordings[0].storage_type #=> String, one of "S3", "KINESIS_VIDEO_STREAM", "KINESIS_STREAM", "KINESIS_FIREHOSE"
resp.contact.recordings[0].location #=> String
resp.contact.recordings[0].media_stream_type #=> String, one of "AUDIO", "VIDEO"
resp.contact.recordings[0].participant_type #=> String, one of "ALL", "MANAGER", "AGENT", "CUSTOMER", "THIRDPARTY"
resp.contact.recordings[0].fragment_start_number #=> String
resp.contact.recordings[0].fragment_stop_number #=> String
resp.contact.recordings[0].start_timestamp #=> Time
resp.contact.recordings[0].stop_timestamp #=> Time
resp.contact.recordings[0].status #=> String, one of "AVAILABLE", "DELETED"
resp.contact.recordings[0].deletion_reason #=> String
resp.contact.recordings[0].unprocessed_transcript_location #=> String
resp.contact.disconnect_reason #=> String
resp.contact.contact_evaluations #=> Hash
resp.contact.contact_evaluations["EvaluationId"].form_id #=> String
resp.contact.contact_evaluations["EvaluationId"].evaluation_arn #=> String
resp.contact.contact_evaluations["EvaluationId"].status #=> String, one of "COMPLETE", "IN_PROGRESS", "DELETED"
resp.contact.contact_evaluations["EvaluationId"].start_timestamp #=> Time
resp.contact.contact_evaluations["EvaluationId"].end_timestamp #=> Time
resp.contact.contact_evaluations["EvaluationId"].delete_timestamp #=> Time
resp.contact.contact_evaluations["EvaluationId"].export_location #=> String
resp.contact.task_template_info.arn #=> String
resp.contact.task_template_info.name #=> String
resp.contact.contact_details.name #=> String
resp.contact.contact_details.description #=> String
resp.contact.outbound_strategy.type #=> String, one of "AGENT_FIRST"
resp.contact.outbound_strategy.config.agent_first.preview.post_accept_timeout_config.duration_in_seconds #=> Integer
resp.contact.outbound_strategy.config.agent_first.preview. #=> Array
resp.contact.outbound_strategy.config.agent_first.preview.[0] #=> String, one of "CALL", "DISCARD"
resp.contact.attributes #=> Hash
resp.contact.attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.contact.next_contacts #=> Array
resp.contact.next_contacts[0].type #=> String, one of "QUICK_CONNECT"
resp.contact.next_contacts[0].next_contact_metadata.quick_connect_contact_data.contact_id #=> String
resp.contact.next_contacts[0].next_contact_metadata.quick_connect_contact_data.initiation_timestamp #=> Time
resp.contact.next_contacts[0].next_contact_metadata.quick_connect_contact_data.quick_connect_id #=> String
resp.contact.next_contacts[0].next_contact_metadata.quick_connect_contact_data.quick_connect_name #=> String
resp.contact.next_contacts[0].next_contact_metadata.quick_connect_contact_data.quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER", "FLOW"
resp.contact.global_resiliency_metadata.active_region #=> String
resp.contact.global_resiliency_metadata.origin_region #=> String
resp.contact.global_resiliency_metadata.traffic_distribution_group_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact.

Returns:

See Also:



8194
8195
8196
8197
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8194

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

#describe_contact_evaluation(params = {}) ⇒ Types::DescribeContactEvaluationResponse

Describes a contact evaluation in the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.describe_contact_evaluation({
  instance_id: "InstanceId", # required
  evaluation_id: "ResourceId", # required
})

Response structure


resp.evaluation.evaluation_id #=> String
resp.evaluation.evaluation_arn #=> String
resp.evaluation.metadata.contact_id #=> String
resp.evaluation.metadata.evaluator_arn #=> String
resp.evaluation.metadata.contact_agent_id #=> String
resp.evaluation.metadata.calibration_session_id #=> String
resp.evaluation.metadata.score.percentage #=> Float
resp.evaluation.metadata.score.not_applicable #=> Boolean
resp.evaluation.metadata.score.automatic_fail #=> Boolean
resp.evaluation.metadata.score.applied_weight #=> Float
resp.evaluation.metadata.score.earned_points #=> Integer
resp.evaluation.metadata.score.max_base_point #=> Integer
resp.evaluation.metadata.score.performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
resp.evaluation.metadata.auto_evaluation.auto_evaluation_enabled #=> Boolean
resp.evaluation.metadata.auto_evaluation.auto_evaluation_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED"
resp.evaluation.metadata.acknowledgement.acknowledged_time #=> Time
resp.evaluation.metadata.acknowledgement.acknowledged_by #=> String
resp.evaluation.metadata.acknowledgement.acknowledger_comment #=> String
resp.evaluation.metadata.review.review_id #=> String
resp.evaluation.metadata.review.requested_time #=> Time
resp.evaluation.metadata.review.requested_by #=> String
resp.evaluation.metadata.review.created_time #=> Time
resp.evaluation.metadata.review.created_by #=> String
resp.evaluation.metadata.review.review_request_comments #=> Array
resp.evaluation.metadata.review.review_request_comments[0].comment #=> String
resp.evaluation.metadata.review.review_request_comments[0].created_time #=> Time
resp.evaluation.metadata.review.review_request_comments[0].created_by #=> String
resp.evaluation.metadata.contact_participant.contact_participant_role #=> String, one of "AGENT", "SYSTEM", "CUSTOM_BOT", "CUSTOMER"
resp.evaluation.metadata.contact_participant.contact_participant_id #=> String
resp.evaluation.metadata.sampling_job_id #=> String
resp.evaluation.answers #=> Hash
resp.evaluation.answers["ResourceId"].value.string_value #=> String
resp.evaluation.answers["ResourceId"].value.numeric_value #=> Float
resp.evaluation.answers["ResourceId"].value.string_values #=> Array
resp.evaluation.answers["ResourceId"].value.string_values[0] #=> String
resp.evaluation.answers["ResourceId"].value.date_time_value #=> String
resp.evaluation.answers["ResourceId"].value.not_applicable #=> Boolean
resp.evaluation.answers["ResourceId"].system_suggested_value.string_value #=> String
resp.evaluation.answers["ResourceId"].system_suggested_value.numeric_value #=> Float
resp.evaluation.answers["ResourceId"].system_suggested_value.string_values #=> Array
resp.evaluation.answers["ResourceId"].system_suggested_value.string_values[0] #=> String
resp.evaluation.answers["ResourceId"].system_suggested_value.date_time_value #=> String
resp.evaluation.answers["ResourceId"].system_suggested_value.not_applicable #=> Boolean
resp.evaluation.answers["ResourceId"].suggested_answers #=> Array
resp.evaluation.answers["ResourceId"].suggested_answers[0].value.string_value #=> String
resp.evaluation.answers["ResourceId"].suggested_answers[0].value.numeric_value #=> Float
resp.evaluation.answers["ResourceId"].suggested_answers[0].value.string_values #=> Array
resp.evaluation.answers["ResourceId"].suggested_answers[0].value.string_values[0] #=> String
resp.evaluation.answers["ResourceId"].suggested_answers[0].value.date_time_value #=> String
resp.evaluation.answers["ResourceId"].suggested_answers[0].value.not_applicable #=> Boolean
resp.evaluation.answers["ResourceId"].suggested_answers[0].status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED"
resp.evaluation.answers["ResourceId"].suggested_answers[0].input.transcript_type #=> String, one of "RAW", "REDACTED"
resp.evaluation.answers["ResourceId"].suggested_answers[0].analysis_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
resp.evaluation.answers["ResourceId"].suggested_answers[0].analysis_details.gen_ai.justification #=> String
resp.evaluation.answers["ResourceId"].suggested_answers[0].analysis_details.gen_ai.points_of_interest #=> Array
resp.evaluation.answers["ResourceId"].suggested_answers[0].analysis_details.gen_ai.points_of_interest[0].millisecond_offsets.begin_offset_millis #=> Integer
resp.evaluation.answers["ResourceId"].suggested_answers[0].analysis_details.gen_ai.points_of_interest[0].transcript_segment #=> String
resp.evaluation.answers["ResourceId"].suggested_answers[0].analysis_details.contact_lens.matched_rule_categories #=> Array
resp.evaluation.answers["ResourceId"].suggested_answers[0].analysis_details.contact_lens.matched_rule_categories[0].category #=> String
resp.evaluation.answers["ResourceId"].suggested_answers[0].analysis_details.contact_lens.matched_rule_categories[0].condition #=> String, one of "PRESENT", "NOT_PRESENT"
resp.evaluation.answers["ResourceId"].suggested_answers[0].analysis_details.contact_lens.matched_rule_categories[0].points_of_interest #=> Array
resp.evaluation.answers["ResourceId"].suggested_answers[0].analysis_details.contact_lens.matched_rule_categories[0].points_of_interest[0].millisecond_offsets.begin_offset_millis #=> Integer
resp.evaluation.answers["ResourceId"].suggested_answers[0].analysis_details.contact_lens.matched_rule_categories[0].points_of_interest[0].transcript_segment #=> String
resp.evaluation.notes #=> Hash
resp.evaluation.notes["ResourceId"].value #=> String
resp.evaluation.status #=> String, one of "DRAFT", "SUBMITTED", "REVIEW_REQUESTED", "UNDER_REVIEW"
resp.evaluation.scores #=> Hash
resp.evaluation.scores["ResourceId"].percentage #=> Float
resp.evaluation.scores["ResourceId"].not_applicable #=> Boolean
resp.evaluation.scores["ResourceId"].automatic_fail #=> Boolean
resp.evaluation.scores["ResourceId"].applied_weight #=> Float
resp.evaluation.scores["ResourceId"].earned_points #=> Integer
resp.evaluation.scores["ResourceId"].max_base_point #=> Integer
resp.evaluation.scores["ResourceId"].performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
resp.evaluation.created_time #=> Time
resp.evaluation.last_modified_time #=> Time
resp.evaluation.evaluation_type #=> String, one of "STANDARD", "CALIBRATION"
resp.evaluation.tags #=> Hash
resp.evaluation.tags["TagKey"] #=> String
resp.evaluation_form.evaluation_form_version #=> Integer
resp.evaluation_form.evaluation_form_id #=> String
resp.evaluation_form.evaluation_form_arn #=> String
resp.evaluation_form.title #=> String
resp.evaluation_form.description #=> String
resp.evaluation_form.items #=> Array
resp.evaluation_form.items[0].section.title #=> String
resp.evaluation_form.items[0].section.ref_id #=> String
resp.evaluation_form.items[0].section.instructions #=> String
resp.evaluation_form.items[0].section.items #=> Types::EvaluationFormItemsList
resp.evaluation_form.items[0].section.weight #=> Float
resp.evaluation_form.items[0].section.is_excluded_from_scoring #=> Boolean
resp.evaluation_form.items[0].section.score_thresholds #=> Array
resp.evaluation_form.items[0].section.score_thresholds[0].performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
resp.evaluation_form.items[0].section.score_thresholds[0].min_score_percentage #=> Float
resp.evaluation_form.items[0].section.score_thresholds[0].max_score_percentage #=> Float
resp.evaluation_form.items[0].question.title #=> String
resp.evaluation_form.items[0].question.instructions #=> String
resp.evaluation_form.items[0].question.ref_id #=> String
resp.evaluation_form.items[0].question.not_applicable_enabled #=> Boolean
resp.evaluation_form.items[0].question.question_type #=> String, one of "TEXT", "SINGLESELECT", "NUMERIC", "MULTISELECT", "DATETIME"
resp.evaluation_form.items[0].question.question_type_properties.numeric.min_value #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.numeric.max_value #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.numeric.options #=> Array
resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].min_value #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].max_value #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].score #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].automatic_fail #=> Boolean
resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].automatic_fail_configuration.target_section #=> String
resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].points_configuration.point_value #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].points_configuration.is_bonus #=> Boolean
resp.evaluation_form.items[0].question.question_type_properties.numeric.automation.property_value.label #=> String, one of "OVERALL_CUSTOMER_SENTIMENT_SCORE", "OVERALL_AGENT_SENTIMENT_SCORE", "CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT", "CUSTOMER_SENTIMENT_SCORE_WITH_AGENT", "NON_TALK_TIME", "NON_TALK_TIME_PERCENTAGE", "NUMBER_OF_INTERRUPTIONS", "CONTACT_DURATION", "AGENT_INTERACTION_DURATION", "CUSTOMER_HOLD_TIME", "LONGEST_HOLD_DURATION", "NUMBER_OF_HOLDS", "AGENT_INTERACTION_AND_HOLD_DURATION"
resp.evaluation_form.items[0].question.question_type_properties.numeric.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
resp.evaluation_form.items[0].question.question_type_properties.single_select.options #=> Array
resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].ref_id #=> String
resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].text #=> String
resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].score #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].automatic_fail #=> Boolean
resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].automatic_fail_configuration.target_section #=> String
resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].points_configuration.point_value #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].points_configuration.is_bonus #=> Boolean
resp.evaluation_form.items[0].question.question_type_properties.single_select.display_as #=> String, one of "DROPDOWN", "RADIO"
resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options #=> Array
resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options[0].rule_category.category #=> String
resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options[0].rule_category.condition #=> String, one of "PRESENT", "NOT_PRESENT"
resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options[0].rule_category.option_ref_id #=> String
resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.default_option_ref_id #=> String
resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
resp.evaluation_form.items[0].question.question_type_properties.text.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options #=> Array
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].ref_id #=> String
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].text #=> String
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].score #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].automatic_fail #=> Boolean
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].automatic_fail_configuration.target_section #=> String
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].points_configuration.point_value #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].points_configuration.is_bonus #=> Boolean
resp.evaluation_form.items[0].question.question_type_properties.multi_select.display_as #=> String, one of "DROPDOWN", "CHECKBOX"
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options #=> Array
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.category #=> String
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.condition #=> String, one of "PRESENT", "NOT_PRESENT"
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.option_ref_ids #=> Array
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.option_ref_ids[0] #=> String
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.default_option_ref_ids #=> Array
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.default_option_ref_ids[0] #=> String
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
resp.evaluation_form.items[0].question.enablement.condition.operands #=> Array
resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.source.type #=> String, one of "QUESTION_REF_ID"
resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.source.ref_id #=> String
resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.values #=> Array
resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.values[0].type #=> String, one of "OPTION_REF_ID"
resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.values[0].ref_id #=> String
resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.comparator #=> String, one of "IN", "NOT_IN", "ALL_IN", "EXACT"
resp.evaluation_form.items[0].question.enablement.condition.operands[0].condition #=> Types::EvaluationFormItemEnablementCondition
resp.evaluation_form.items[0].question.enablement.condition.operator #=> String, one of "OR", "AND"
resp.evaluation_form.items[0].question.enablement.action #=> String, one of "DISABLE", "ENABLE"
resp.evaluation_form.items[0].question.enablement.default_action #=> String, one of "DISABLE", "ENABLE"
resp.evaluation_form.items[0].question.weight #=> Float
resp.evaluation_form.items[0].question.scoring_configuration.points_configuration.max_point_value #=> Integer
resp.evaluation_form.items[0].question.scoring_configuration.points_configuration.min_point_value #=> Integer
resp.evaluation_form.items[0].question.scoring_configuration.points_configuration.is_bonus #=> Boolean
resp.evaluation_form.items[0].question.scoring_configuration.is_excluded_from_scoring #=> Boolean
resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds #=> Array
resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds[0].performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds[0].min_score_percentage #=> Float
resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds[0].max_score_percentage #=> Float
resp.evaluation_form.scoring_strategy.mode #=> String, one of "QUESTION_ONLY", "SECTION_ONLY", "POINTS_BASED"
resp.evaluation_form.scoring_strategy.status #=> String, one of "ENABLED", "DISABLED"
resp.evaluation_form.scoring_strategy.score_thresholds #=> Array
resp.evaluation_form.scoring_strategy.score_thresholds[0].performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
resp.evaluation_form.scoring_strategy.score_thresholds[0].min_score_percentage #=> Float
resp.evaluation_form.scoring_strategy.score_thresholds[0].max_score_percentage #=> Float
resp.evaluation_form.auto_evaluation_configuration.enabled #=> Boolean
resp.evaluation_form.target_configuration.contact_interaction_type #=> String, one of "AGENT", "AUTOMATED", "CUSTOMER"
resp.evaluation_form.language_configuration.form_language #=> String, one of "de-DE", "en-US", "es-ES", "fr-FR", "it-IT", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "ms-MY"
resp.evaluation_form.review_configuration.review_notification_recipients #=> Array
resp.evaluation_form.review_configuration.review_notification_recipients[0].type #=> String, one of "USER_ID"
resp.evaluation_form.review_configuration.review_notification_recipients[0].value.user_id #=> String
resp.evaluation_form.review_configuration.eligibility_days #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :evaluation_id (required, String) —

    A unique identifier for the contact evaluation.

Returns:

See Also:



8410
8411
8412
8413
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8410

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

#describe_contact_flow(params = {}) ⇒ Types::DescribeContactFlowResponse

Describes the specified flow.

You can also create and update flows using the Connect Customer Flow language.

Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.

Use arn:aws:.../contact-flow/{id}:{version} to retrieve the content of a specific flow version.

In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED

Examples:

Request syntax with placeholder values


resp = client.describe_contact_flow({
  instance_id: "InstanceId", # required
  contact_flow_id: "ContactFlowId", # required
})

Response structure


resp.contact_flow.arn #=> String
resp.contact_flow.id #=> String
resp.contact_flow.name #=> String
resp.contact_flow.type #=> String, one of "CONTACT_FLOW", "CUSTOMER_QUEUE", "CUSTOMER_HOLD", "CUSTOMER_WHISPER", "AGENT_HOLD", "AGENT_WHISPER", "OUTBOUND_WHISPER", "AGENT_TRANSFER", "QUEUE_TRANSFER", "CAMPAIGN"
resp.contact_flow.state #=> String, one of "ACTIVE", "ARCHIVED"
resp.contact_flow.status #=> String, one of "PUBLISHED", "SAVED"
resp.contact_flow.description #=> String
resp.contact_flow.content #=> String
resp.contact_flow.tags #=> Hash
resp.contact_flow.tags["TagKey"] #=> String
resp.contact_flow.flow_content_sha_256 #=> String
resp.contact_flow.version #=> Integer
resp.contact_flow.version_description #=> String
resp.contact_flow.last_modified_time #=> Time
resp.contact_flow.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance.

  • :contact_flow_id (required, String) —

    The identifier of the flow.

Returns:

See Also:



8476
8477
8478
8479
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8476

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

#describe_contact_flow_module(params = {}) ⇒ Types::DescribeContactFlowModuleResponse

Describes the specified flow module.

Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.

Examples:

Request syntax with placeholder values


resp = client.describe_contact_flow_module({
  instance_id: "InstanceId", # required
  contact_flow_module_id: "ContactFlowModuleId", # required
})

Response structure


resp.contact_flow_module.arn #=> String
resp.contact_flow_module.id #=> String
resp.contact_flow_module.name #=> String
resp.contact_flow_module.content #=> String
resp.contact_flow_module.description #=> String
resp.contact_flow_module.state #=> String, one of "ACTIVE", "ARCHIVED"
resp.contact_flow_module.status #=> String, one of "PUBLISHED", "SAVED"
resp.contact_flow_module.tags #=> Hash
resp.contact_flow_module.tags["TagKey"] #=> String
resp.contact_flow_module.flow_module_content_sha_256 #=> String
resp.contact_flow_module.version #=> Integer
resp.contact_flow_module.version_description #=> String
resp.contact_flow_module.settings #=> String
resp.contact_flow_module.external_invocation_configuration.enabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_module_id (required, String) —

    The identifier of the flow module.

Returns:

See Also:



8531
8532
8533
8534
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8531

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

#describe_contact_flow_module_alias(params = {}) ⇒ Types::DescribeContactFlowModuleAliasResponse

Retrieves detailed information about a specific alias, including which version it currently points to and its metadata.

Examples:

Request syntax with placeholder values


resp = client.describe_contact_flow_module_alias({
  instance_id: "InstanceIdOrArn", # required
  contact_flow_module_id: "ContactFlowModuleId", # required
  alias_id: "ResourceId", # required
})

Response structure


resp.contact_flow_module_alias.contact_flow_module_id #=> String
resp.contact_flow_module_alias.contact_flow_module_arn #=> String
resp.contact_flow_module_alias.alias_id #=> String
resp.contact_flow_module_alias.version #=> Integer
resp.contact_flow_module_alias.name #=> String
resp.contact_flow_module_alias.description #=> String
resp.contact_flow_module_alias.last_modified_region #=> String
resp.contact_flow_module_alias.last_modified_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_module_id (required, String) —

    The identifier of the flow module.

  • :alias_id (required, String) —

    The identifier of the alias.

Returns:

See Also:



8580
8581
8582
8583
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8580

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

#describe_data_table(params = {}) ⇒ Types::DescribeDataTableResponse

Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

Examples:

Request syntax with placeholder values


resp = client.describe_data_table({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
})

Response structure


resp.data_table.name #=> String
resp.data_table.id #=> String
resp.data_table.arn #=> String
resp.data_table.time_zone #=> String
resp.data_table.description #=> String
resp.data_table.value_lock_level #=> String, one of "NONE", "DATA_TABLE", "PRIMARY_VALUE", "ATTRIBUTE", "VALUE"
resp.data_table.lock_version.data_table #=> String
resp.data_table.lock_version.attribute #=> String
resp.data_table.lock_version.primary_values #=> String
resp.data_table.lock_version.value #=> String
resp.data_table.version #=> String
resp.data_table.version_description #=> String
resp.data_table.status #=> String, one of "PUBLISHED"
resp.data_table.created_time #=> Time
resp.data_table.last_modified_time #=> Time
resp.data_table.last_modified_region #=> String
resp.data_table.tags #=> Hash
resp.data_table.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If no alias is provided, the default behavior is identical to providing the $LATEST alias.

Returns:

See Also:



8635
8636
8637
8638
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8635

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

#describe_data_table_attribute(params = {}) ⇒ Types::DescribeDataTableAttributeResponse

Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

Examples:

Request syntax with placeholder values


resp = client.describe_data_table_attribute({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
  attribute_name: "DataTableName", # required
})

Response structure


resp.attribute.attribute_id #=> String
resp.attribute.name #=> String
resp.attribute.value_type #=> String, one of "TEXT", "NUMBER", "BOOLEAN", "TEXT_LIST", "NUMBER_LIST"
resp.attribute.description #=> String
resp.attribute.data_table_id #=> String
resp.attribute.data_table_arn #=> String
resp.attribute.primary #=> Boolean
resp.attribute.version #=> String
resp.attribute.lock_version.data_table #=> String
resp.attribute.lock_version.attribute #=> String
resp.attribute.lock_version.primary_values #=> String
resp.attribute.lock_version.value #=> String
resp.attribute.last_modified_time #=> Time
resp.attribute.last_modified_region #=> String
resp.attribute.validation.min_length #=> Integer
resp.attribute.validation.max_length #=> Integer
resp.attribute.validation.min_values #=> Integer
resp.attribute.validation.max_values #=> Integer
resp.attribute.validation.ignore_case #=> Boolean
resp.attribute.validation.minimum #=> Float
resp.attribute.validation.maximum #=> Float
resp.attribute.validation.exclusive_minimum #=> Float
resp.attribute.validation.exclusive_maximum #=> Float
resp.attribute.validation.multiple_of #=> Float
resp.attribute.validation.enum.strict #=> Boolean
resp.attribute.validation.enum.values #=> Array
resp.attribute.validation.enum.values[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table. Must also accept the table ARN with or without a version alias.

  • :attribute_name (required, String) —

    The name of the attribute to retrieve detailed information for.

Returns:

See Also:



8701
8702
8703
8704
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8701

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

#describe_email_address(params = {}) ⇒ Types::DescribeEmailAddressResponse

Describe email address form the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.describe_email_address({
  instance_id: "InstanceId", # required
  email_address_id: "EmailAddressId", # required
})

Response structure


resp.email_address_id #=> String
resp.email_address_arn #=> String
resp.email_address #=> String
resp.display_name #=> String
resp.description #=> String
resp.create_timestamp #=> String
resp.modified_timestamp #=> String
resp.alias_configurations #=> Array
resp.alias_configurations[0].email_address_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :email_address_id (required, String) —

    The identifier of the email address.

Returns:

See Also:



8756
8757
8758
8759
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8756

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

#describe_evaluation_form(params = {}) ⇒ Types::DescribeEvaluationFormResponse

Describes an evaluation form in the specified Connect Customer instance. If the version property is not provided, the latest version of the evaluation form is described.

Examples:

Request syntax with placeholder values


resp = client.describe_evaluation_form({
  instance_id: "InstanceId", # required
  evaluation_form_id: "ResourceId", # required
  evaluation_form_version: 1,
})

Response structure


resp.evaluation_form.evaluation_form_id #=> String
resp.evaluation_form.evaluation_form_version #=> Integer
resp.evaluation_form.locked #=> Boolean
resp.evaluation_form.evaluation_form_arn #=> String
resp.evaluation_form.title #=> String
resp.evaluation_form.description #=> String
resp.evaluation_form.status #=> String, one of "DRAFT", "ACTIVE"
resp.evaluation_form.items #=> Array
resp.evaluation_form.items[0].section.title #=> String
resp.evaluation_form.items[0].section.ref_id #=> String
resp.evaluation_form.items[0].section.instructions #=> String
resp.evaluation_form.items[0].section.items #=> Types::EvaluationFormItemsList
resp.evaluation_form.items[0].section.weight #=> Float
resp.evaluation_form.items[0].section.is_excluded_from_scoring #=> Boolean
resp.evaluation_form.items[0].section.score_thresholds #=> Array
resp.evaluation_form.items[0].section.score_thresholds[0].performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
resp.evaluation_form.items[0].section.score_thresholds[0].min_score_percentage #=> Float
resp.evaluation_form.items[0].section.score_thresholds[0].max_score_percentage #=> Float
resp.evaluation_form.items[0].question.title #=> String
resp.evaluation_form.items[0].question.instructions #=> String
resp.evaluation_form.items[0].question.ref_id #=> String
resp.evaluation_form.items[0].question.not_applicable_enabled #=> Boolean
resp.evaluation_form.items[0].question.question_type #=> String, one of "TEXT", "SINGLESELECT", "NUMERIC", "MULTISELECT", "DATETIME"
resp.evaluation_form.items[0].question.question_type_properties.numeric.min_value #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.numeric.max_value #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.numeric.options #=> Array
resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].min_value #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].max_value #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].score #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].automatic_fail #=> Boolean
resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].automatic_fail_configuration.target_section #=> String
resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].points_configuration.point_value #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].points_configuration.is_bonus #=> Boolean
resp.evaluation_form.items[0].question.question_type_properties.numeric.automation.property_value.label #=> String, one of "OVERALL_CUSTOMER_SENTIMENT_SCORE", "OVERALL_AGENT_SENTIMENT_SCORE", "CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT", "CUSTOMER_SENTIMENT_SCORE_WITH_AGENT", "NON_TALK_TIME", "NON_TALK_TIME_PERCENTAGE", "NUMBER_OF_INTERRUPTIONS", "CONTACT_DURATION", "AGENT_INTERACTION_DURATION", "CUSTOMER_HOLD_TIME", "LONGEST_HOLD_DURATION", "NUMBER_OF_HOLDS", "AGENT_INTERACTION_AND_HOLD_DURATION"
resp.evaluation_form.items[0].question.question_type_properties.numeric.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
resp.evaluation_form.items[0].question.question_type_properties.single_select.options #=> Array
resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].ref_id #=> String
resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].text #=> String
resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].score #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].automatic_fail #=> Boolean
resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].automatic_fail_configuration.target_section #=> String
resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].points_configuration.point_value #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].points_configuration.is_bonus #=> Boolean
resp.evaluation_form.items[0].question.question_type_properties.single_select.display_as #=> String, one of "DROPDOWN", "RADIO"
resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options #=> Array
resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options[0].rule_category.category #=> String
resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options[0].rule_category.condition #=> String, one of "PRESENT", "NOT_PRESENT"
resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options[0].rule_category.option_ref_id #=> String
resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.default_option_ref_id #=> String
resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
resp.evaluation_form.items[0].question.question_type_properties.text.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options #=> Array
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].ref_id #=> String
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].text #=> String
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].score #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].automatic_fail #=> Boolean
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].automatic_fail_configuration.target_section #=> String
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].points_configuration.point_value #=> Integer
resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].points_configuration.is_bonus #=> Boolean
resp.evaluation_form.items[0].question.question_type_properties.multi_select.display_as #=> String, one of "DROPDOWN", "CHECKBOX"
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options #=> Array
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.category #=> String
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.condition #=> String, one of "PRESENT", "NOT_PRESENT"
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.option_ref_ids #=> Array
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.option_ref_ids[0] #=> String
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.default_option_ref_ids #=> Array
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.default_option_ref_ids[0] #=> String
resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
resp.evaluation_form.items[0].question.enablement.condition.operands #=> Array
resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.source.type #=> String, one of "QUESTION_REF_ID"
resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.source.ref_id #=> String
resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.values #=> Array
resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.values[0].type #=> String, one of "OPTION_REF_ID"
resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.values[0].ref_id #=> String
resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.comparator #=> String, one of "IN", "NOT_IN", "ALL_IN", "EXACT"
resp.evaluation_form.items[0].question.enablement.condition.operands[0].condition #=> Types::EvaluationFormItemEnablementCondition
resp.evaluation_form.items[0].question.enablement.condition.operator #=> String, one of "OR", "AND"
resp.evaluation_form.items[0].question.enablement.action #=> String, one of "DISABLE", "ENABLE"
resp.evaluation_form.items[0].question.enablement.default_action #=> String, one of "DISABLE", "ENABLE"
resp.evaluation_form.items[0].question.weight #=> Float
resp.evaluation_form.items[0].question.scoring_configuration.points_configuration.max_point_value #=> Integer
resp.evaluation_form.items[0].question.scoring_configuration.points_configuration.min_point_value #=> Integer
resp.evaluation_form.items[0].question.scoring_configuration.points_configuration.is_bonus #=> Boolean
resp.evaluation_form.items[0].question.scoring_configuration.is_excluded_from_scoring #=> Boolean
resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds #=> Array
resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds[0].performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds[0].min_score_percentage #=> Float
resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds[0].max_score_percentage #=> Float
resp.evaluation_form.scoring_strategy.mode #=> String, one of "QUESTION_ONLY", "SECTION_ONLY", "POINTS_BASED"
resp.evaluation_form.scoring_strategy.status #=> String, one of "ENABLED", "DISABLED"
resp.evaluation_form.scoring_strategy.score_thresholds #=> Array
resp.evaluation_form.scoring_strategy.score_thresholds[0].performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
resp.evaluation_form.scoring_strategy.score_thresholds[0].min_score_percentage #=> Float
resp.evaluation_form.scoring_strategy.score_thresholds[0].max_score_percentage #=> Float
resp.evaluation_form.created_time #=> Time
resp.evaluation_form.created_by #=> String
resp.evaluation_form.last_modified_time #=> Time
resp.evaluation_form.last_modified_by #=> String
resp.evaluation_form.auto_evaluation_configuration.enabled #=> Boolean
resp.evaluation_form.review_configuration.review_notification_recipients #=> Array
resp.evaluation_form.review_configuration.review_notification_recipients[0].type #=> String, one of "USER_ID"
resp.evaluation_form.review_configuration.review_notification_recipients[0].value.user_id #=> String
resp.evaluation_form.review_configuration.eligibility_days #=> Integer
resp.evaluation_form.tags #=> Hash
resp.evaluation_form.tags["TagKey"] #=> String
resp.evaluation_form.target_configuration.contact_interaction_type #=> String, one of "AGENT", "AUTOMATED", "CUSTOMER"
resp.evaluation_form.language_configuration.form_language #=> String, one of "de-DE", "en-US", "es-ES", "fr-FR", "it-IT", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "ms-MY"
resp.evaluation_form.latest_validation_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.evaluation_form.last_validation_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :evaluation_form_id (required, String) —

    A unique identifier for the contact evaluation.

  • :evaluation_form_version (Integer) —

    A version of the evaluation form.

Returns:

See Also:



8907
8908
8909
8910
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8907

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

#describe_hours_of_operation(params = {}) ⇒ Types::DescribeHoursOfOperationResponse

Describes the hours of operation.

Examples:

Request syntax with placeholder values


resp = client.describe_hours_of_operation({
  instance_id: "InstanceId", # required
  hours_of_operation_id: "HoursOfOperationId", # required
})

Response structure


resp.hours_of_operation.hours_of_operation_id #=> String
resp.hours_of_operation.hours_of_operation_arn #=> String
resp.hours_of_operation.name #=> String
resp.hours_of_operation.description #=> String
resp.hours_of_operation.time_zone #=> String
resp.hours_of_operation.config #=> Array
resp.hours_of_operation.config[0].day #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
resp.hours_of_operation.config[0].start_time.hours #=> Integer
resp.hours_of_operation.config[0].start_time.minutes #=> Integer
resp.hours_of_operation.config[0].end_time.hours #=> Integer
resp.hours_of_operation.config[0].end_time.minutes #=> Integer
resp.hours_of_operation.parent_hours_of_operations #=> Array
resp.hours_of_operation.parent_hours_of_operations[0].name #=> String
resp.hours_of_operation.parent_hours_of_operations[0].id #=> String
resp.hours_of_operation.parent_hours_of_operations[0].arn #=> String
resp.hours_of_operation.tags #=> Hash
resp.hours_of_operation.tags["TagKey"] #=> String
resp.hours_of_operation.last_modified_time #=> Time
resp.hours_of_operation.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :hours_of_operation_id (required, String) —

    The identifier for the hours of operation.

Returns:

See Also:



8962
8963
8964
8965
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8962

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

#describe_hours_of_operation_override(params = {}) ⇒ Types::DescribeHoursOfOperationOverrideResponse

Describes the hours of operation override.

Examples:

Request syntax with placeholder values


resp = client.describe_hours_of_operation_override({
  instance_id: "InstanceId", # required
  hours_of_operation_id: "HoursOfOperationId", # required
  hours_of_operation_override_id: "HoursOfOperationOverrideId", # required
})

Response structure


resp.hours_of_operation_override.hours_of_operation_override_id #=> String
resp.hours_of_operation_override.hours_of_operation_id #=> String
resp.hours_of_operation_override.hours_of_operation_arn #=> String
resp.hours_of_operation_override.name #=> String
resp.hours_of_operation_override.description #=> String
resp.hours_of_operation_override.config #=> Array
resp.hours_of_operation_override.config[0].day #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
resp.hours_of_operation_override.config[0].start_time.hours #=> Integer
resp.hours_of_operation_override.config[0].start_time.minutes #=> Integer
resp.hours_of_operation_override.config[0].end_time.hours #=> Integer
resp.hours_of_operation_override.config[0].end_time.minutes #=> Integer
resp.hours_of_operation_override.effective_from #=> String
resp.hours_of_operation_override.effective_till #=> String
resp.hours_of_operation_override.recurrence_config.recurrence_pattern.frequency #=> String, one of "WEEKLY", "MONTHLY", "YEARLY"
resp.hours_of_operation_override.recurrence_config.recurrence_pattern.interval #=> Integer
resp.hours_of_operation_override.recurrence_config.recurrence_pattern.by_month #=> Array
resp.hours_of_operation_override.recurrence_config.recurrence_pattern.by_month[0] #=> Integer
resp.hours_of_operation_override.recurrence_config.recurrence_pattern.by_month_day #=> Array
resp.hours_of_operation_override.recurrence_config.recurrence_pattern.by_month_day[0] #=> Integer
resp.hours_of_operation_override.recurrence_config.recurrence_pattern.by_weekday_occurrence #=> Array
resp.hours_of_operation_override.recurrence_config.recurrence_pattern.by_weekday_occurrence[0] #=> Integer
resp.hours_of_operation_override.override_type #=> String, one of "STANDARD", "OPEN", "CLOSED"

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance.

  • :hours_of_operation_id (required, String) —

    The identifier for the hours of operation.

  • :hours_of_operation_override_id (required, String) —

    The identifier for the hours of operation override.

Returns:

See Also:



9019
9020
9021
9022
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9019

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

#describe_instance(params = {}) ⇒ Types::DescribeInstanceResponse

This API is in preview release for Connect Customer and is subject to change.

Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.

If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

Examples:

Request syntax with placeholder values


resp = client.describe_instance({
  instance_id: "InstanceId", # required
})

Response structure


resp.instance.id #=> String
resp.instance.arn #=> String
resp.instance.identity_management_type #=> String, one of "SAML", "CONNECT_MANAGED", "EXISTING_DIRECTORY"
resp.instance.instance_alias #=> String
resp.instance.created_time #=> Time
resp.instance.service_role #=> String
resp.instance.instance_status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED"
resp.instance.status_reason.message #=> String
resp.instance.inbound_calls_enabled #=> Boolean
resp.instance.outbound_calls_enabled #=> Boolean
resp.instance.instance_access_url #=> String
resp.instance.tags #=> Hash
resp.instance.tags["TagKey"] #=> String
resp.replication_configuration.replication_status_summary_list #=> Array
resp.replication_configuration.replication_status_summary_list[0].region #=> String
resp.replication_configuration.replication_status_summary_list[0].replication_status #=> String, one of "INSTANCE_REPLICATION_COMPLETE", "INSTANCE_REPLICATION_IN_PROGRESS", "INSTANCE_REPLICATION_FAILED", "INSTANCE_REPLICA_DELETING", "INSTANCE_REPLICATION_DELETION_FAILED", "RESOURCE_REPLICATION_NOT_STARTED"
resp.replication_configuration.replication_status_summary_list[0].replication_status_reason #=> String
resp.replication_configuration.source_region #=> String
resp.replication_configuration. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



9081
9082
9083
9084
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9081

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

#describe_instance_attribute(params = {}) ⇒ Types::DescribeInstanceAttributeResponse

This API is in preview release for Connect Customer and is subject to change.

Describes the specified instance attribute.

Examples:

Request syntax with placeholder values


resp = client.describe_instance_attribute({
  instance_id: "InstanceId", # required
  attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA, MULTI_PARTY_CONFERENCE, HIGH_VOLUME_OUTBOUND, ENHANCED_CONTACT_MONITORING, ENHANCED_CHAT_MONITORING, MULTI_PARTY_CHAT_CONFERENCE, MESSAGE_STREAMING
})

Response structure


resp.attribute.attribute_type #=> String, one of "INBOUND_CALLS", "OUTBOUND_CALLS", "CONTACTFLOW_LOGS", "CONTACT_LENS", "AUTO_RESOLVE_BEST_VOICES", "USE_CUSTOM_TTS_VOICES", "EARLY_MEDIA", "MULTI_PARTY_CONFERENCE", "HIGH_VOLUME_OUTBOUND", "ENHANCED_CONTACT_MONITORING", "ENHANCED_CHAT_MONITORING", "MULTI_PARTY_CHAT_CONFERENCE", "MESSAGE_STREAMING"
resp.attribute.value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :attribute_type (required, String) —

    The type of attribute.

Returns:

See Also:



9122
9123
9124
9125
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9122

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

#describe_instance_storage_config(params = {}) ⇒ Types::DescribeInstanceStorageConfigResponse

This API is in preview release for Connect Customer and is subject to change.

Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.

Examples:

Request syntax with placeholder values


resp = client.describe_instance_storage_config({
  instance_id: "InstanceId", # required
  association_id: "AssociationId", # required
  resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, ATTACHMENTS, CONTACT_EVALUATIONS, SCREEN_RECORDINGS, REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS, REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS, EMAIL_MESSAGES
})

Response structure


resp.storage_config.association_id #=> String
resp.storage_config.storage_type #=> String, one of "S3", "KINESIS_VIDEO_STREAM", "KINESIS_STREAM", "KINESIS_FIREHOSE"
resp.storage_config.s3_config.bucket_name #=> String
resp.storage_config.s3_config.bucket_prefix #=> String
resp.storage_config.s3_config.encryption_config.encryption_type #=> String, one of "KMS"
resp.storage_config.s3_config.encryption_config.key_id #=> String
resp.storage_config.kinesis_video_stream_config.prefix #=> String
resp.storage_config.kinesis_video_stream_config.retention_period_hours #=> Integer
resp.storage_config.kinesis_video_stream_config.encryption_config.encryption_type #=> String, one of "KMS"
resp.storage_config.kinesis_video_stream_config.encryption_config.key_id #=> String
resp.storage_config.kinesis_stream_config.stream_arn #=> String
resp.storage_config.kinesis_firehose_config.firehose_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :association_id (required, String) —

    The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

  • :resource_type (required, String) —

    A valid resource type.

Returns:

See Also:



9179
9180
9181
9182
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9179

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

#describe_metric(params = {}) ⇒ Types::DescribeMetricResponse

Retrieves the full definition of an existing metric from the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.describe_metric({
  instance_id: "InstanceId", # required
  metric_id: "MetricId", # required
})

Response structure


resp.metric.arn #=> String
resp.metric.id #=> String
resp.metric.name #=> String
resp.metric.description #=> String
resp.metric.metric_calculation.calculation_components #=> Array
resp.metric.metric_calculation.calculation_components[0].alias #=> String
resp.metric.metric_calculation.calculation_components[0].metric_name #=> String
resp.metric.metric_calculation.calculation_components[0].metric_id #=> String
resp.metric.metric_calculation.calculation_components[0].metric_filters #=> Array
resp.metric.metric_calculation.calculation_components[0].metric_filters[0].metric_filter_key #=> String
resp.metric.metric_calculation.calculation_components[0].metric_filters[0].negate #=> Boolean
resp.metric.metric_calculation.calculation_components[0].metric_filters[0].number_condition.comparison #=> String, one of "LESSER", "LESSER_OR_EQUAL", "GREATER", "GREATER_OR_EQUAL"
resp.metric.metric_calculation.calculation_components[0].metric_filters[0].number_condition.values #=> Array
resp.metric.metric_calculation.calculation_components[0].metric_filters[0].number_condition.values[0] #=> Float
resp.metric.metric_calculation.calculation_components[0].metric_filters[0].string_condition.comparison #=> String, one of "MATCHES_ANY", "MATCHES_NONE"
resp.metric.metric_calculation.calculation_components[0].metric_filters[0].string_condition.values #=> Array
resp.metric.metric_calculation.calculation_components[0].metric_filters[0].string_condition.values[0] #=> String
resp.metric.metric_calculation.calculation_components[0].metric_filters[0].boolean_condition.comparison #=> String, one of "IS_TRUE", "IS_FALSE"
resp.metric.metric_calculation.calculation #=> String
resp.metric.creation_method #=> String, one of "SERVICE_LEVEL_BUILDER", "METRIC_BUILDER"
resp.metric.status #=> String, one of "PUBLISHED", "SAVED"
resp.metric.type #=> String, one of "AWS_MANAGED", "CUSTOMER_MANAGED"
resp.metric.unit #=> String, one of "INTEGER", "DOUBLE", "PERCENT", "SECONDS"
resp.metric.positive_trend_indicator #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL"
resp.metric.groupings #=> Array
resp.metric.groupings[0] #=> String
resp.metric.filters #=> Array
resp.metric.filters[0].id #=> String
resp.metric.filters[0].type #=> String, one of "METRIC_LEVEL", "RESOURCE_LEVEL"
resp.metric.effective_time #=> Time
resp.metric.refresh_rate #=> Integer
resp.metric.category #=> String
resp.metric.supported_stats #=> Array
resp.metric.supported_stats[0] #=> String
resp.metric.default_stat #=> String
resp.metric.supports_preaggregate_calculation #=> Boolean
resp.metric.supports_custom_calculation #=> Boolean
resp.metric.primary_event_source #=> String
resp.metric.primary_event_source_effective_timestamp_type #=> String
resp.metric.created_time #=> Time
resp.metric.created_user.connect_user_arn #=> String
resp.metric.created_user.aws_identity_arn #=> String
resp.metric.last_modified_region #=> String
resp.metric.last_modified_time #=> Time
resp.metric.last_modified_user.connect_user_arn #=> String
resp.metric.last_modified_user.aws_identity_arn #=> String
resp.metric.tags #=> Hash
resp.metric.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :metric_id (required, String) —

    The identifier of the metric to describe. Adding the $SAVED qualifier will describe the saved version of the metric. Adding $LATEST or omitting a qualifier will describe the published version.

Returns:

See Also:



9266
9267
9268
9269
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9266

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

#describe_notification(params = {}) ⇒ Types::DescribeNotificationResponse

Retrieves detailed information about a specific notification, including its content, priority, recipients, and metadata.

Examples:

Request syntax with placeholder values


resp = client.describe_notification({
  instance_id: "InstanceId", # required
  notification_id: "NotificationId", # required
})

Response structure


resp.notification.content #=> Hash
resp.notification.content["LocaleCode"] #=> String
resp.notification.id #=> String
resp.notification.arn #=> String
resp.notification.priority #=> String, one of "URGENT", "HIGH", "LOW"
resp.notification.recipients #=> Array
resp.notification.recipients[0] #=> String
resp.notification.last_modified_time #=> Time
resp.notification.created_at #=> Time
resp.notification.expires_at #=> Time
resp.notification.last_modified_region #=> String
resp.notification.tags #=> Hash
resp.notification.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :notification_id (required, String) —

    The unique identifier for the notification.

Returns:

See Also:



9316
9317
9318
9319
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9316

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

#describe_phone_number(params = {}) ⇒ Types::DescribePhoneNumberResponse

Gets details and status of a phone number that’s claimed to your Connect Customer instance or traffic distribution group.

If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you receive a ResourceNotFoundException.

Examples:

Request syntax with placeholder values


resp = client.describe_phone_number({
  phone_number_id: "PhoneNumberId", # required
})

Response structure


resp.claimed_phone_number_summary.phone_number_id #=> String
resp.claimed_phone_number_summary.phone_number_arn #=> String
resp.claimed_phone_number_summary.phone_number #=> String
resp.claimed_phone_number_summary.phone_number_country_code #=> String, one of "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BR", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CK", "CR", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "TL", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "PF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "KP", "MP", "NO", "OM", "PK", "PW", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "CG", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "KR", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "VI", "UG", "UA", "AE", "GB", "US", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW"
resp.claimed_phone_number_summary.phone_number_type #=> String, one of "TOLL_FREE", "DID", "UIFN", "SHARED", "THIRD_PARTY_TF", "THIRD_PARTY_DID", "SHORT_CODE"
resp.claimed_phone_number_summary.phone_number_description #=> String
resp.claimed_phone_number_summary.target_arn #=> String
resp.claimed_phone_number_summary.instance_id #=> String
resp.claimed_phone_number_summary.tags #=> Hash
resp.claimed_phone_number_summary.tags["TagKey"] #=> String
resp.claimed_phone_number_summary.phone_number_status.status #=> String, one of "CLAIMED", "IN_PROGRESS", "FAILED"
resp.claimed_phone_number_summary.phone_number_status.message #=> String
resp.claimed_phone_number_summary.source_phone_number_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    A unique identifier for the phone number.

Returns:

See Also:



9367
9368
9369
9370
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9367

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

#describe_predefined_attribute(params = {}) ⇒ Types::DescribePredefinedAttributeResponse

Describes a predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for:

For the predefined attributes per instance quota, see Connect Customer quotas.

Endpoints: See Connect Customer endpoints and quotas.

Examples:

Request syntax with placeholder values


resp = client.describe_predefined_attribute({
  instance_id: "InstanceId", # required
  name: "PredefinedAttributeName", # required
})

Response structure


resp.predefined_attribute.name #=> String
resp.predefined_attribute.values.string_list #=> Array
resp.predefined_attribute.values.string_list[0] #=> String
resp.predefined_attribute.purposes #=> Array
resp.predefined_attribute.purposes[0] #=> String
resp.predefined_attribute.attribute_configuration.enable_value_validation_on_association #=> Boolean
resp.predefined_attribute.attribute_configuration.is_read_only #=> Boolean
resp.predefined_attribute.last_modified_time #=> Time
resp.predefined_attribute.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    The name of the predefined attribute.

Returns:

See Also:



9431
9432
9433
9434
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9431

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

#describe_prompt(params = {}) ⇒ Types::DescribePromptResponse

Describes the prompt.

Examples:

Request syntax with placeholder values


resp = client.describe_prompt({
  instance_id: "InstanceId", # required
  prompt_id: "PromptId", # required
})

Response structure


resp.prompt.prompt_arn #=> String
resp.prompt.prompt_id #=> String
resp.prompt.name #=> String
resp.prompt.description #=> String
resp.prompt.tags #=> Hash
resp.prompt.tags["TagKey"] #=> String
resp.prompt.last_modified_time #=> Time
resp.prompt.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :prompt_id (required, String) —

    A unique identifier for the prompt.

Returns:

See Also:



9475
9476
9477
9478
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9475

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

#describe_queue(params = {}) ⇒ Types::DescribeQueueResponse

Describes the specified queue.

Examples:

Request syntax with placeholder values


resp = client.describe_queue({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
})

Response structure


resp.queue.name #=> String
resp.queue.queue_arn #=> String
resp.queue.queue_id #=> String
resp.queue.description #=> String
resp.queue.outbound_caller_config.outbound_caller_id_name #=> String
resp.queue.outbound_caller_config.outbound_caller_id_number_id #=> String
resp.queue.outbound_caller_config.outbound_flow_id #=> String
resp.queue.outbound_email_config.outbound_email_address_id #=> String
resp.queue.hours_of_operation_id #=> String
resp.queue.max_contacts #=> Integer
resp.queue.status #=> String, one of "ENABLED", "DISABLED"
resp.queue.tags #=> Hash
resp.queue.tags["TagKey"] #=> String
resp.queue.last_modified_time #=> Time
resp.queue.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :queue_id (required, String) —

    The identifier for the queue.

Returns:

See Also:



9526
9527
9528
9529
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9526

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

#describe_quick_connect(params = {}) ⇒ Types::DescribeQuickConnectResponse

Describes the quick connect.

Examples:

Request syntax with placeholder values


resp = client.describe_quick_connect({
  instance_id: "InstanceId", # required
  quick_connect_id: "QuickConnectId", # required
})

Response structure


resp.quick_connect.quick_connect_arn #=> String
resp.quick_connect.quick_connect_id #=> String
resp.quick_connect.name #=> String
resp.quick_connect.description #=> String
resp.quick_connect.quick_connect_config.quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER", "FLOW"
resp.quick_connect.quick_connect_config.user_config.user_id #=> String
resp.quick_connect.quick_connect_config.user_config.contact_flow_id #=> String
resp.quick_connect.quick_connect_config.queue_config.queue_id #=> String
resp.quick_connect.quick_connect_config.queue_config.contact_flow_id #=> String
resp.quick_connect.quick_connect_config.phone_config.phone_number #=> String
resp.quick_connect.quick_connect_config.flow_config.contact_flow_id #=> String
resp.quick_connect.tags #=> Hash
resp.quick_connect.tags["TagKey"] #=> String
resp.quick_connect.last_modified_time #=> Time
resp.quick_connect.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :quick_connect_id (required, String) —

    The identifier for the quick connect.

Returns:

See Also:



9577
9578
9579
9580
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9577

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

#describe_routing_profile(params = {}) ⇒ Types::DescribeRoutingProfileResponse

Describes the specified routing profile.

DescribeRoutingProfile does not populate AssociatedQueueIds in its response. The example Response Syntax shown on this page is incorrect; we are working to update it. SearchRoutingProfiles does include AssociatedQueueIds.

Examples:

Request syntax with placeholder values


resp = client.describe_routing_profile({
  instance_id: "InstanceId", # required
  routing_profile_id: "RoutingProfileId", # required
})

Response structure


resp.routing_profile.instance_id #=> String
resp.routing_profile.name #=> String
resp.routing_profile.routing_profile_arn #=> String
resp.routing_profile.routing_profile_id #=> String
resp.routing_profile.description #=> String
resp.routing_profile.media_concurrencies #=> Array
resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.routing_profile.media_concurrencies[0].concurrency #=> Integer
resp.routing_profile.media_concurrencies[0].cross_channel_behavior.behavior_type #=> String, one of "ROUTE_CURRENT_CHANNEL_ONLY", "ROUTE_ANY_CHANNEL"
resp.routing_profile.default_outbound_queue_id #=> String
resp.routing_profile.tags #=> Hash
resp.routing_profile.tags["TagKey"] #=> String
resp.routing_profile.number_of_associated_queues #=> Integer
resp.routing_profile.number_of_associated_manual_assignment_queues #=> Integer
resp.routing_profile.number_of_associated_users #=> Integer
resp.routing_profile.agent_availability_timer #=> String, one of "TIME_SINCE_LAST_ACTIVITY", "TIME_SINCE_LAST_INBOUND"
resp.routing_profile.last_modified_time #=> Time
resp.routing_profile.last_modified_region #=> String
resp.routing_profile.is_default #=> Boolean
resp.routing_profile.associated_queue_ids #=> Array
resp.routing_profile.associated_queue_ids[0] #=> String
resp.routing_profile.associated_manual_assignment_queue_ids #=> Array
resp.routing_profile.associated_manual_assignment_queue_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :routing_profile_id (required, String) —

    The identifier of the routing profile.

Returns:

See Also:



9647
9648
9649
9650
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9647

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

#describe_rule(params = {}) ⇒ Types::DescribeRuleResponse

Describes a rule for the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.describe_rule({
  instance_id: "InstanceId", # required
  rule_id: "RuleId", # required
})

Response structure


resp.rule.name #=> String
resp.rule.rule_id #=> String
resp.rule.rule_arn #=> String
resp.rule.trigger_event_source.event_source_name #=> String, one of "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", "OnRealTimeChatAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnEmailAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate", "OnContactEvaluationSubmit", "OnMetricDataUpdate", "OnCaseCreate", "OnCaseUpdate", "OnSlaBreach", "OnAlertUpdate", "OnSchedulePublish", "OnScheduleUpdate", "OnScheduleTimeOffRequestActivity"
resp.rule.trigger_event_source.integration_association_id #=> String
resp.rule.rule_capability_tiers #=> Array
resp.rule.rule_capability_tiers[0] #=> String, one of "GenerativeAI"
resp.rule.function #=> String
resp.rule.actions #=> Array
resp.rule.actions[0].action_type #=> String, one of "CREATE_TASK", "ASSIGN_CONTACT_CATEGORY", "GENERATE_EVENTBRIDGE_EVENT", "SEND_NOTIFICATION", "CREATE_CASE", "UPDATE_CASE", "ASSIGN_SLA", "END_ASSOCIATED_TASKS", "SUBMIT_AUTO_EVALUATION"
resp.rule.actions[0].task_action.name #=> String
resp.rule.actions[0].task_action.description #=> String
resp.rule.actions[0].task_action.contact_flow_id #=> String
resp.rule.actions[0].task_action.references #=> Hash
resp.rule.actions[0].task_action.references["ReferenceKey"].value #=> String
resp.rule.actions[0].task_action.references["ReferenceKey"].type #=> String, one of "URL", "ATTACHMENT", "CONTACT_ANALYSIS", "NUMBER", "STRING", "DATE", "EMAIL", "EMAIL_MESSAGE", "EMAIL_MESSAGE_PLAIN_TEXT", "EMAIL_MESSAGE_PLAIN_TEXT_REDACTED", "EMAIL_MESSAGE_REDACTED"
resp.rule.actions[0].task_action.references["ReferenceKey"].status #=> String, one of "AVAILABLE", "DELETED", "APPROVED", "REJECTED", "PROCESSING", "FAILED"
resp.rule.actions[0].task_action.references["ReferenceKey"].arn #=> String
resp.rule.actions[0].task_action.references["ReferenceKey"].status_reason #=> String
resp.rule.actions[0].event_bridge_action.name #=> String
resp.rule.actions[0].send_notification_action.delivery_method #=> String, one of "EMAIL"
resp.rule.actions[0].send_notification_action.subject #=> String
resp.rule.actions[0].send_notification_action.content #=> String
resp.rule.actions[0].send_notification_action.content_type #=> String, one of "PLAIN_TEXT"
resp.rule.actions[0].send_notification_action.recipient.user_tags #=> Hash
resp.rule.actions[0].send_notification_action.recipient.user_tags["String"] #=> String
resp.rule.actions[0].send_notification_action.recipient.user_ids #=> Array
resp.rule.actions[0].send_notification_action.recipient.user_ids[0] #=> String
resp.rule.actions[0].send_notification_action.exclusion.user_tags #=> Hash
resp.rule.actions[0].send_notification_action.exclusion.user_tags["String"] #=> String
resp.rule.actions[0].send_notification_action.exclusion.user_ids #=> Array
resp.rule.actions[0].send_notification_action.exclusion.user_ids[0] #=> String
resp.rule.actions[0].create_case_action.fields #=> Array
resp.rule.actions[0].create_case_action.fields[0].id #=> String
resp.rule.actions[0].create_case_action.fields[0].value.boolean_value #=> Boolean
resp.rule.actions[0].create_case_action.fields[0].value.double_value #=> Float
resp.rule.actions[0].create_case_action.fields[0].value.string_value #=> String
resp.rule.actions[0].create_case_action.template_id #=> String
resp.rule.actions[0].update_case_action.fields #=> Array
resp.rule.actions[0].update_case_action.fields[0].id #=> String
resp.rule.actions[0].update_case_action.fields[0].value.boolean_value #=> Boolean
resp.rule.actions[0].update_case_action.fields[0].value.double_value #=> Float
resp.rule.actions[0].update_case_action.fields[0].value.string_value #=> String
resp.rule.actions[0].assign_sla_action.sla_assignment_type #=> String, one of "CASES"
resp.rule.actions[0].assign_sla_action.case_sla_configuration.name #=> String
resp.rule.actions[0].assign_sla_action.case_sla_configuration.type #=> String, one of "CaseField"
resp.rule.actions[0].assign_sla_action.case_sla_configuration.field_id #=> String
resp.rule.actions[0].assign_sla_action.case_sla_configuration.target_field_values #=> Array
resp.rule.actions[0].assign_sla_action.case_sla_configuration.target_field_values[0].boolean_value #=> Boolean
resp.rule.actions[0].assign_sla_action.case_sla_configuration.target_field_values[0].double_value #=> Float
resp.rule.actions[0].assign_sla_action.case_sla_configuration.target_field_values[0].string_value #=> String
resp.rule.actions[0].assign_sla_action.case_sla_configuration.target_sla_minutes #=> Integer
resp.rule.actions[0].submit_auto_evaluation_action.evaluation_form_id #=> String
resp.rule.publish_status #=> String, one of "DRAFT", "PUBLISHED"
resp.rule.created_time #=> Time
resp.rule.last_updated_time #=> Time
resp.rule.last_updated_by #=> String
resp.rule.tags #=> Hash
resp.rule.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :rule_id (required, String) —

    A unique identifier for the rule.

Returns:

See Also:



9742
9743
9744
9745
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9742

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

#describe_security_profile(params = {}) ⇒ Types::DescribeSecurityProfileResponse

Gets basic information about the security profile.

For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

Examples:

Request syntax with placeholder values


resp = client.describe_security_profile({
  security_profile_id: "SecurityProfileId", # required
  instance_id: "InstanceId", # required
})

Response structure


resp.security_profile.id #=> String
resp.security_profile.organization_resource_id #=> String
resp.security_profile.arn #=> String
resp.security_profile.security_profile_name #=> String
resp.security_profile.description #=> String
resp.security_profile.tags #=> Hash
resp.security_profile.tags["TagKey"] #=> String
resp.security_profile.allowed_access_control_tags #=> Hash
resp.security_profile.allowed_access_control_tags["SecurityProfilePolicyKey"] #=> String
resp.security_profile.tag_restricted_resources #=> Array
resp.security_profile.tag_restricted_resources[0] #=> String
resp.security_profile.last_modified_time #=> Time
resp.security_profile.last_modified_region #=> String
resp.security_profile.hierarchy_restricted_resources #=> Array
resp.security_profile.hierarchy_restricted_resources[0] #=> String
resp.security_profile.allowed_access_control_hierarchy_group_id #=> String
resp.security_profile.granular_access_control_configuration.data_table_access_control_configuration.primary_attribute_access_control_configuration.primary_attribute_values #=> Array
resp.security_profile.granular_access_control_configuration.data_table_access_control_configuration.primary_attribute_access_control_configuration.primary_attribute_values[0].access_type #=> String, one of "ALLOW"
resp.security_profile.granular_access_control_configuration.data_table_access_control_configuration.primary_attribute_access_control_configuration.primary_attribute_values[0].attribute_name #=> String
resp.security_profile.granular_access_control_configuration.data_table_access_control_configuration.primary_attribute_access_control_configuration.primary_attribute_values[0].values #=> Array
resp.security_profile.granular_access_control_configuration.data_table_access_control_configuration.primary_attribute_access_control_configuration.primary_attribute_values[0].values[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :security_profile_id (required, String) —

    The identifier for the security profle.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



9809
9810
9811
9812
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9809

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

#describe_test_case(params = {}) ⇒ Types::DescribeTestCaseResponse

Describes the specified test case and allows you to get the content and metadata of the test case for the specified Amazon Connect instance.

Examples:

Request syntax with placeholder values


resp = client.describe_test_case({
  instance_id: "InstanceIdOrArn", # required
  test_case_id: "TestCaseId", # required
  status: "PUBLISHED", # accepts PUBLISHED, SAVED
})

Response structure


resp.test_case.arn #=> String
resp.test_case.id #=> String
resp.test_case.name #=> String
resp.test_case.content #=> String
resp.test_case.entry_point.type #=> String, one of "VOICE_CALL", "CHAT"
resp.test_case.entry_point.voice_call_entry_point_parameters.source_phone_number #=> String
resp.test_case.entry_point.voice_call_entry_point_parameters.destination_phone_number #=> String
resp.test_case.entry_point.voice_call_entry_point_parameters.flow_id #=> String
resp.test_case.entry_point.chat_entry_point_parameters.flow_id #=> String
resp.test_case.initialization_data #=> String
resp.test_case.description #=> String
resp.test_case.status #=> String, one of "PUBLISHED", "SAVED"
resp.test_case.last_modified_time #=> Time
resp.test_case.last_modified_region #=> String
resp.test_case.tags #=> Hash
resp.test_case.tags["TagKey"] #=> String
resp.test_case.test_case_sha_256 #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance.

  • :test_case_id (required, String) —

    The identifier of the test case.

  • :status (String) —

    The status of the test case version to retrieve. If not specified, returns the published version if available, otherwise returns the saved version.

Returns:

See Also:



9865
9866
9867
9868
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9865

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

#describe_traffic_distribution_group(params = {}) ⇒ Types::DescribeTrafficDistributionGroupResponse

Gets details and status of a traffic distribution group.

Examples:

Request syntax with placeholder values


resp = client.describe_traffic_distribution_group({
  traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
})

Response structure


resp.traffic_distribution_group.id #=> String
resp.traffic_distribution_group.arn #=> String
resp.traffic_distribution_group.name #=> String
resp.traffic_distribution_group.description #=> String
resp.traffic_distribution_group.instance_arn #=> String
resp.traffic_distribution_group.status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "PENDING_DELETION", "DELETION_FAILED", "UPDATE_IN_PROGRESS"
resp.traffic_distribution_group.tags #=> Hash
resp.traffic_distribution_group.tags["TagKey"] #=> String
resp.traffic_distribution_group.is_default #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :traffic_distribution_group_id (required, String) —

    The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

Returns:

See Also:



9904
9905
9906
9907
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9904

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

#describe_user(params = {}) ⇒ Types::DescribeUserResponse

Describes the specified user. You can find the instance ID in the Connect Customer console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

Examples:

Request syntax with placeholder values


resp = client.describe_user({
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
})

Response structure


resp.user.id #=> String
resp.user.arn #=> String
resp.user.username #=> String
resp.user.identity_info.first_name #=> String
resp.user.identity_info.last_name #=> String
resp.user.identity_info.email #=> String
resp.user.identity_info.secondary_email #=> String
resp.user.identity_info.mobile #=> String
resp.user.phone_config.phone_type #=> String, one of "SOFT_PHONE", "DESK_PHONE"
resp.user.phone_config.auto_accept #=> Boolean
resp.user.phone_config.after_contact_work_time_limit #=> Integer
resp.user.phone_config.desk_phone_number #=> String
resp.user.phone_config.persistent_connection #=> Boolean
resp.user.directory_user_id #=> String
resp.user.security_profile_ids #=> Array
resp.user.security_profile_ids[0] #=> String
resp.user.routing_profile_id #=> String
resp.user.hierarchy_group_id #=> String
resp.user.tags #=> Hash
resp.user.tags["TagKey"] #=> String
resp.user.auto_accept_configs #=> Array
resp.user.auto_accept_configs[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.user.auto_accept_configs[0].auto_accept #=> Boolean
resp.user.auto_accept_configs[0].agent_first_callback_auto_accept #=> Boolean
resp.user.after_contact_work_configs #=> Array
resp.user.after_contact_work_configs[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.user.after_contact_work_configs[0].after_contact_work_config.after_contact_work_time_limit #=> Integer
resp.user.after_contact_work_configs[0].agent_first_callback_after_contact_work_config.after_contact_work_time_limit #=> Integer
resp.user.phone_number_configs #=> Array
resp.user.phone_number_configs[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.user.phone_number_configs[0].phone_type #=> String, one of "SOFT_PHONE", "DESK_PHONE"
resp.user.phone_number_configs[0].phone_number #=> String
resp.user.persistent_connection_configs #=> Array
resp.user.persistent_connection_configs[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.user.persistent_connection_configs[0].persistent_connection #=> Boolean
resp.user.voice_enhancement_configs #=> Array
resp.user.voice_enhancement_configs[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.user.voice_enhancement_configs[0].voice_enhancement_mode #=> String, one of "VOICE_ISOLATION", "NOISE_SUPPRESSION", "NONE"
resp.user.last_modified_time #=> Time
resp.user.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :user_id (required, String) —

    The identifier of the user account.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



9987
9988
9989
9990
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9987

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

#describe_user_hierarchy_group(params = {}) ⇒ Types::DescribeUserHierarchyGroupResponse

Describes the specified hierarchy group.

Examples:

Request syntax with placeholder values


resp = client.describe_user_hierarchy_group({
  hierarchy_group_id: "HierarchyGroupId", # required
  instance_id: "InstanceId", # required
})

Response structure


resp.hierarchy_group.id #=> String
resp.hierarchy_group.arn #=> String
resp.hierarchy_group.name #=> String
resp.hierarchy_group.level_id #=> String
resp.hierarchy_group.hierarchy_path.level_one.id #=> String
resp.hierarchy_group.hierarchy_path.level_one.arn #=> String
resp.hierarchy_group.hierarchy_path.level_one.name #=> String
resp.hierarchy_group.hierarchy_path.level_one.last_modified_time #=> Time
resp.hierarchy_group.hierarchy_path.level_one.last_modified_region #=> String
resp.hierarchy_group.hierarchy_path.level_two.id #=> String
resp.hierarchy_group.hierarchy_path.level_two.arn #=> String
resp.hierarchy_group.hierarchy_path.level_two.name #=> String
resp.hierarchy_group.hierarchy_path.level_two.last_modified_time #=> Time
resp.hierarchy_group.hierarchy_path.level_two.last_modified_region #=> String
resp.hierarchy_group.hierarchy_path.level_three.id #=> String
resp.hierarchy_group.hierarchy_path.level_three.arn #=> String
resp.hierarchy_group.hierarchy_path.level_three.name #=> String
resp.hierarchy_group.hierarchy_path.level_three.last_modified_time #=> Time
resp.hierarchy_group.hierarchy_path.level_three.last_modified_region #=> String
resp.hierarchy_group.hierarchy_path.level_four.id #=> String
resp.hierarchy_group.hierarchy_path.level_four.arn #=> String
resp.hierarchy_group.hierarchy_path.level_four.name #=> String
resp.hierarchy_group.hierarchy_path.level_four.last_modified_time #=> Time
resp.hierarchy_group.hierarchy_path.level_four.last_modified_region #=> String
resp.hierarchy_group.hierarchy_path.level_five.id #=> String
resp.hierarchy_group.hierarchy_path.level_five.arn #=> String
resp.hierarchy_group.hierarchy_path.level_five.name #=> String
resp.hierarchy_group.hierarchy_path.level_five.last_modified_time #=> Time
resp.hierarchy_group.hierarchy_path.level_five.last_modified_region #=> String
resp.hierarchy_group.tags #=> Hash
resp.hierarchy_group.tags["TagKey"] #=> String
resp.hierarchy_group.last_modified_time #=> Time
resp.hierarchy_group.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :hierarchy_group_id (required, String) —

    The identifier of the hierarchy group.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



10056
10057
10058
10059
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10056

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

#describe_user_hierarchy_structure(params = {}) ⇒ Types::DescribeUserHierarchyStructureResponse

Describes the hierarchy structure of the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.describe_user_hierarchy_structure({
  instance_id: "InstanceId", # required
})

Response structure


resp.hierarchy_structure.level_one.id #=> String
resp.hierarchy_structure.level_one.arn #=> String
resp.hierarchy_structure.level_one.name #=> String
resp.hierarchy_structure.level_one.last_modified_time #=> Time
resp.hierarchy_structure.level_one.last_modified_region #=> String
resp.hierarchy_structure.level_two.id #=> String
resp.hierarchy_structure.level_two.arn #=> String
resp.hierarchy_structure.level_two.name #=> String
resp.hierarchy_structure.level_two.last_modified_time #=> Time
resp.hierarchy_structure.level_two.last_modified_region #=> String
resp.hierarchy_structure.level_three.id #=> String
resp.hierarchy_structure.level_three.arn #=> String
resp.hierarchy_structure.level_three.name #=> String
resp.hierarchy_structure.level_three.last_modified_time #=> Time
resp.hierarchy_structure.level_three.last_modified_region #=> String
resp.hierarchy_structure.level_four.id #=> String
resp.hierarchy_structure.level_four.arn #=> String
resp.hierarchy_structure.level_four.name #=> String
resp.hierarchy_structure.level_four.last_modified_time #=> Time
resp.hierarchy_structure.level_four.last_modified_region #=> String
resp.hierarchy_structure.level_five.id #=> String
resp.hierarchy_structure.level_five.arn #=> String
resp.hierarchy_structure.level_five.name #=> String
resp.hierarchy_structure.level_five.last_modified_time #=> Time
resp.hierarchy_structure.level_five.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



10114
10115
10116
10117
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10114

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

#describe_view(params = {}) ⇒ Types::DescribeViewResponse

Retrieves the view for the specified Connect Customer instance and view identifier.

The view identifier can be supplied as a ViewId or ARN.

$SAVED needs to be supplied if a view is unpublished.

The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED, which is either an actual version number or an Connect Customer managed qualifier $SAVED | $LATEST. If it is not supplied, then $LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.

Examples:

Request syntax with placeholder values


resp = client.describe_view({
  instance_id: "ViewsInstanceId", # required
  view_id: "ViewId", # required
})

Response structure


resp.view.id #=> String
resp.view.arn #=> String
resp.view.name #=> String
resp.view.status #=> String, one of "PUBLISHED", "SAVED"
resp.view.type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
resp.view.description #=> String
resp.view.version #=> Integer
resp.view.version_description #=> String
resp.view.content.input_schema #=> String
resp.view.content.template #=> String
resp.view.content.actions #=> Array
resp.view.content.actions[0] #=> String
resp.view.tags #=> Hash
resp.view.tags["TagKey"] #=> String
resp.view.created_time #=> Time
resp.view.last_modified_time #=> Time
resp.view.view_content_sha_256 #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

  • :view_id (required, String) —

    The ViewId of the view. This must be an ARN for Amazon Web Services managed views.

Returns:

See Also:



10176
10177
10178
10179
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10176

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

#describe_vocabulary(params = {}) ⇒ Types::DescribeVocabularyResponse

Describes the specified vocabulary.

Examples:

Request syntax with placeholder values


resp = client.describe_vocabulary({
  instance_id: "InstanceId", # required
  vocabulary_id: "VocabularyId", # required
})

Response structure


resp.vocabulary.name #=> String
resp.vocabulary.id #=> String
resp.vocabulary.arn #=> String
resp.vocabulary.language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN", "en-NZ", "en-ZA", "ca-ES", "da-DK", "fi-FI", "id-ID", "ms-MY", "nl-NL", "no-NO", "pl-PL", "sv-SE", "tl-PH"
resp.vocabulary.state #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "DELETE_IN_PROGRESS"
resp.vocabulary.last_modified_time #=> Time
resp.vocabulary.failure_reason #=> String
resp.vocabulary.content #=> String
resp.vocabulary.tags #=> Hash
resp.vocabulary.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :vocabulary_id (required, String) —

    The identifier of the custom vocabulary.

Returns:

See Also:



10222
10223
10224
10225
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10222

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

#describe_workspace(params = {}) ⇒ Types::DescribeWorkspaceResponse

Retrieves details about a workspace, including its configuration and metadata.

Examples:

Request syntax with placeholder values


resp = client.describe_workspace({
  instance_id: "InstanceId", # required
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.workspace.visibility #=> String, one of "ALL", "ASSIGNED", "NONE"
resp.workspace.id #=> String
resp.workspace.name #=> String
resp.workspace.arn #=> String
resp.workspace.description #=> String
resp.workspace.theme.light.palette.header.background #=> String
resp.workspace.theme.light.palette.header.text #=> String
resp.workspace.theme.light.palette.header.text_hover #=> String
resp.workspace.theme.light.palette.header.invert_actions_colors #=> Boolean
resp.workspace.theme.light.palette.navigation.background #=> String
resp.workspace.theme.light.palette.navigation.text_background_hover #=> String
resp.workspace.theme.light.palette.navigation.text_background_active #=> String
resp.workspace.theme.light.palette.navigation.text #=> String
resp.workspace.theme.light.palette.navigation.text_hover #=> String
resp.workspace.theme.light.palette.navigation.text_active #=> String
resp.workspace.theme.light.palette.navigation.invert_actions_colors #=> Boolean
resp.workspace.theme.light.palette.canvas.container_background #=> String
resp.workspace.theme.light.palette.canvas.page_background #=> String
resp.workspace.theme.light.palette.canvas.active_background #=> String
resp.workspace.theme.light.palette.primary.default #=> String
resp.workspace.theme.light.palette.primary.active #=> String
resp.workspace.theme.light.palette.primary.contrast_text #=> String
resp.workspace.theme.light.images..default #=> String
resp.workspace.theme.light.images..favicon #=> String
resp.workspace.theme.light.typography.font_family.default #=> String, one of "Arial", "Courier New", "Georgia", "Times New Roman", "Trebuchet", "Verdana"
resp.workspace.theme.dark.palette.header.background #=> String
resp.workspace.theme.dark.palette.header.text #=> String
resp.workspace.theme.dark.palette.header.text_hover #=> String
resp.workspace.theme.dark.palette.header.invert_actions_colors #=> Boolean
resp.workspace.theme.dark.palette.navigation.background #=> String
resp.workspace.theme.dark.palette.navigation.text_background_hover #=> String
resp.workspace.theme.dark.palette.navigation.text_background_active #=> String
resp.workspace.theme.dark.palette.navigation.text #=> String
resp.workspace.theme.dark.palette.navigation.text_hover #=> String
resp.workspace.theme.dark.palette.navigation.text_active #=> String
resp.workspace.theme.dark.palette.navigation.invert_actions_colors #=> Boolean
resp.workspace.theme.dark.palette.canvas.container_background #=> String
resp.workspace.theme.dark.palette.canvas.page_background #=> String
resp.workspace.theme.dark.palette.canvas.active_background #=> String
resp.workspace.theme.dark.palette.primary.default #=> String
resp.workspace.theme.dark.palette.primary.active #=> String
resp.workspace.theme.dark.palette.primary.contrast_text #=> String
resp.workspace.theme.dark.images..default #=> String
resp.workspace.theme.dark.images..favicon #=> String
resp.workspace.theme.dark.typography.font_family.default #=> String, one of "Arial", "Courier New", "Georgia", "Times New Roman", "Trebuchet", "Verdana"
resp.workspace.title #=> String
resp.workspace.last_modified_time #=> Time
resp.workspace.last_modified_region #=> String
resp.workspace.tags #=> Hash
resp.workspace.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :workspace_id (required, String) —

    The identifier of the workspace.

Returns:

See Also:



10309
10310
10311
10312
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10309

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

#disassociate_analytics_data_set(params = {}) ⇒ Struct

Removes the dataset ID associated with a given Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.disassociate_analytics_data_set({
  instance_id: "InstanceId", # required
  data_set_id: "DataSetId", # required
  target_account_id: "AWSAccountId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :data_set_id (required, String) —

    The identifier of the dataset to remove.

  • :target_account_id (String) —

    The identifier of the target account. Use to associate a dataset to a different account than the one containing the Connect Customer instance. If not specified, by default this value is the Amazon Web Services account that has the Connect Customer instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10348
10349
10350
10351
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10348

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

#disassociate_approved_origin(params = {}) ⇒ Struct

This API is in preview release for Connect Customer and is subject to change.

Revokes access to integrated applications from Connect Customer.

Examples:

Request syntax with placeholder values


resp = client.disassociate_approved_origin({
  instance_id: "InstanceId", # required
  origin: "Origin", # required
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :origin (required, String) —

    The domain URL of the integrated application.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10396
10397
10398
10399
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10396

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

#disassociate_bot(params = {}) ⇒ Struct

This API is in preview release for Connect Customer and is subject to change.

Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.

Examples:

Request syntax with placeholder values


resp = client.disassociate_bot({
  instance_id: "InstanceId", # required
  lex_bot: {
    name: "BotName", # required
    lex_region: "LexRegion", # required
  },
  lex_v2_bot: {
    alias_arn: "AliasArn",
  },
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :lex_bot (Types::LexBot) —

    Configuration information of an Amazon Lex bot.

  • :lex_v2_bot (Types::LexV2Bot) —

    The Amazon Lex V2 bot to disassociate from the instance.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10454
10455
10456
10457
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10454

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

#disassociate_email_address_alias(params = {}) ⇒ Struct

Removes the alias association between two email addresses in an Connect Customer instance. After disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address. Both email addresses continue to exist independently and can receive emails directly.

Use cases

Following are common uses cases for this API:

  • Department separation: Remove alias relationships when splitting a consolidated support queue back into separate department-specific queues.

  • Email address retirement: Cleanly remove forwarding relationships before decommissioning old email addresses.

  • Organizational restructuring: Reconfigure email routing when business processes change and aliases are no longer needed.

Important things to know

  • Concurrent operations: This API uses distributed locking, so concurrent operations on the same email addresses may be temporarily blocked.

  • Emails sent to the former alias address are still delivered directly to that address if it exists.

  • You do not need to delete the email addresses after disassociation. Both addresses remain active independently.

  • After a successful disassociation, you can immediately create a new alias relationship with the same addresses.

  • 200 status means alias was successfully disassociated.

DisassociateEmailAddressAlias does not return the following information:

  • Details in the response about the email that was disassociated. The response returns an empty body.

  • The timestamp of when the disassociation occurred.

Endpoints: See Connect Customer endpoints and quotas.

Related operations

Examples:

Request syntax with placeholder values


resp = client.disassociate_email_address_alias({
  email_address_id: "EmailAddressId", # required
  instance_id: "InstanceId", # required
  alias_configuration: { # required
    email_address_id: "EmailAddressId", # required
  },
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :email_address_id (required, String) —

    The identifier of the email address.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :alias_configuration (required, Types::AliasConfiguration) —

    Configuration object that specifies which alias relationship to remove. The alias association must currently exist between the primary email address and the specified alias email address.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10582
10583
10584
10585
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10582

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

#disassociate_flow(params = {}) ⇒ Struct

Disassociates a connect resource from a flow.

Examples:

Request syntax with placeholder values


resp = client.disassociate_flow({
  instance_id: "InstanceId", # required
  resource_id: "ARN", # required
  resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL, ANALYTICS_CONNECTOR, WHATSAPP_MESSAGING_PHONE_NUMBER
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :resource_id (required, String) —

    The identifier of the resource.

    • Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER

    • Amazon Web Services End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER

  • :resource_type (required, String) —

    A valid resource type.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10623
10624
10625
10626
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10623

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

#disassociate_hours_of_operations(params = {}) ⇒ Struct

Disassociates a set of hours of operations with another hours of operation. For more information about inheriting overrides from parent hours of operation, see Hours of operation overrides in the Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.disassociate_hours_of_operations({
  instance_id: "InstanceId", # required
  hours_of_operation_id: "HoursOfOperationId", # required
  parent_hours_of_operation_ids: ["HoursOfOperationId"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :hours_of_operation_id (required, String) —

    The identifier of the child hours of operation.

  • :parent_hours_of_operation_ids (required, Array<String>) —

    The Amazon Resource Names (ARNs) of the parent hours of operation resources to disassociate with the child hours of operation resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10666
10667
10668
10669
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10666

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

#disassociate_instance_storage_config(params = {}) ⇒ Struct

This API is in preview release for Connect Customer and is subject to change.

Removes the storage type configurations for the specified resource type and association ID.

Examples:

Request syntax with placeholder values


resp = client.disassociate_instance_storage_config({
  instance_id: "InstanceId", # required
  association_id: "AssociationId", # required
  resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, ATTACHMENTS, CONTACT_EVALUATIONS, SCREEN_RECORDINGS, REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS, REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS, EMAIL_MESSAGES
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :association_id (required, String) —

    The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

  • :resource_type (required, String) —

    A valid resource type.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10720
10721
10722
10723
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10720

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

#disassociate_lambda_function(params = {}) ⇒ Struct

This API is in preview release for Connect Customer and is subject to change.

Remove the Lambda function from the dropdown options available in the relevant flow blocks.

Examples:

Request syntax with placeholder values


resp = client.disassociate_lambda_function({
  instance_id: "InstanceId", # required
  function_arn: "FunctionArn", # required
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance..

  • :function_arn (required, String) —

    The Amazon Resource Name (ARN) of the Lambda function being disassociated.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10770
10771
10772
10773
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10770

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

#disassociate_lex_bot(params = {}) ⇒ Struct

This API is in preview release for Connect Customer and is subject to change.

Revokes authorization from the specified instance to access the specified Amazon Lex bot.

Examples:

Request syntax with placeholder values


resp = client.disassociate_lex_bot({
  instance_id: "InstanceId", # required
  bot_name: "BotName", # required
  lex_region: "LexRegion", # required
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :bot_name (required, String) —

    The name of the Amazon Lex bot. Maximum character limit of 50.

  • :lex_region (required, String) —

    The Amazon Web Services Region in which the Amazon Lex bot has been created.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10824
10825
10826
10827
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10824

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

#disassociate_phone_number_contact_flow(params = {}) ⇒ Struct

Removes the flow association from a phone number claimed to your Connect Customer instance.

If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Examples:

Request syntax with placeholder values


resp = client.disassociate_phone_number_contact_flow({
  phone_number_id: "PhoneNumberId", # required
  instance_id: "InstanceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    A unique identifier for the phone number.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10867
10868
10869
10870
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10867

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

#disassociate_queue_email_addresses(params = {}) ⇒ Struct

Removes the association between a set of email addresses and a queue. After disassociation, agents will no longer be able to select these email addresses as "From" addresses when replying to inbound email contacts or initiating outbound email contacts in this queue.

Important things to know

  • Agents will no longer see these email addresses in their "From" address selection options for this queue.

  • The email addresses themselves are not deleted from the instance, only their availability for agent selection in this queue is removed.

  • Changes take effect immediately and will affect the agent experience in the Contact Control Panel (CCP).

Examples:

Request syntax with placeholder values


resp = client.disassociate_queue_email_addresses({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  email_addresses_id: ["EmailAddressId"], # required
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :queue_id (required, String) —

    The identifier for the queue.

  • :email_addresses_id (required, Array<String>) —

    List of email address identifiers to disassociate from the queue. These are the unique identifiers of email addresses that should no longer be routed to this queue.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10933
10934
10935
10936
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10933

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

#disassociate_queue_quick_connects(params = {}) ⇒ Struct

Disassociates a set of quick connects from a queue.

Examples:

Request syntax with placeholder values


resp = client.disassociate_queue_quick_connects({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  quick_connect_ids: ["QuickConnectId"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :queue_id (required, String) —

    The identifier for the queue.

  • :quick_connect_ids (required, Array<String>) —

    The quick connects to disassociate from the queue.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10968
10969
10970
10971
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10968

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

#disassociate_routing_profile_queues(params = {}) ⇒ Struct

Disassociates a set of queues from a routing profile.

Up to 10 queue references can be disassociated in a single API call. More than 10 queue references results in a single call results in an InvalidParameterException.

Examples:

Request syntax with placeholder values


resp = client.disassociate_routing_profile_queues({
  instance_id: "InstanceId", # required
  routing_profile_id: "RoutingProfileId", # required
  queue_references: [
    {
      queue_id: "QueueId", # required
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
    },
  ],
  manual_assignment_queue_references: [
    {
      queue_id: "QueueId", # required
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :routing_profile_id (required, String) —

    The identifier of the routing profile.

  • :queue_references (Array<Types::RoutingProfileQueueReference>) —

    The queues to disassociate from this routing profile.

  • :manual_assignment_queue_references (Array<Types::RoutingProfileQueueReference>) —

    The manual assignment queues to disassociate with this routing profile.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



11022
11023
11024
11025
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11022

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

#disassociate_security_key(params = {}) ⇒ Struct

This API is in preview release for Connect Customer and is subject to change.

Deletes the specified security key.

Examples:

Request syntax with placeholder values


resp = client.disassociate_security_key({
  instance_id: "InstanceId", # required
  association_id: "AssociationId", # required
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :association_id (required, String) —

    The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



11071
11072
11073
11074
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11071

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

#disassociate_security_profiles(params = {}) ⇒ Struct

Disassociates a security profile attached to a Q in Connect AI Agent Entity in an Amazon Connect instance.

Examples:

Request syntax with placeholder values


resp = client.disassociate_security_profiles({
  instance_id: "InstanceId", # required
  security_profiles: [ # required
    {
      id: "SecurityProfileId",
    },
  ],
  entity_type: "USER", # required, accepts USER, AI_AGENT
  entity_arn: "EntityArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :security_profiles (required, Array<Types::SecurityProfileItem>) —

    List of Security Profile Object.

  • :entity_type (required, String) —

    Only supported type is AI_AGENT.

  • :entity_arn (required, String) —

    ARN of a Q in Connect AI Agent.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



11111
11112
11113
11114
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11111

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

#disassociate_traffic_distribution_group_user(params = {}) ⇒ Struct

Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

Examples:

Request syntax with placeholder values


resp = client.disassociate_traffic_distribution_group_user({
  traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :traffic_distribution_group_id (required, String) —

    The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.

  • :user_id (required, String) —

    The identifier for the user. This can be the ID or the ARN of the user.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



11150
11151
11152
11153
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11150

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

#disassociate_user_proficiencies(params = {}) ⇒ Struct

Disassociates a set of proficiencies from a user.

Examples:

Request syntax with placeholder values


resp = client.disassociate_user_proficiencies({
  instance_id: "InstanceId", # required
  user_id: "UserId", # required
  user_proficiencies: [ # required
    {
      attribute_name: "PredefinedAttributeName", # required
      attribute_value: "PredefinedAttributeStringValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :user_id (required, String) —

    The identifier of the user account.

  • :user_proficiencies (required, Array<Types::UserProficiencyDisassociate>) —

    The proficiencies to disassociate from the user.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



11186
11187
11188
11189
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11186

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

#disassociate_workspace(params = {}) ⇒ Types::DisassociateWorkspaceResponse

Removes the association between a workspace and one or more users or routing profiles.

Examples:

Request syntax with placeholder values


resp = client.disassociate_workspace({
  instance_id: "InstanceId", # required
  workspace_id: "WorkspaceId", # required
  resource_arns: ["ARN"], # required
})

Response structure


resp.successful_list #=> Array
resp.successful_list[0].resource_arn #=> String
resp.failed_list #=> Array
resp.failed_list[0].resource_arn #=> String
resp.failed_list[0].error_code #=> String
resp.failed_list[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :workspace_id (required, String) —

    The identifier of the workspace.

  • :resource_arns (required, Array<String>) —

    The Amazon Resource Names (ARNs) of the resources to disassociate from the workspace.

Returns:

See Also:



11235
11236
11237
11238
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11235

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

#dismiss_user_contact(params = {}) ⇒ Struct

Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.

Examples:

Request syntax with placeholder values


resp = client.dismiss_user_contact({
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :user_id (required, String) —

    The identifier of the user account.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

  • :contact_id (required, String) —

    The identifier of the contact.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



11273
11274
11275
11276
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11273

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

#evaluate_data_table_values(params = {}) ⇒ Types::EvaluateDataTableValuesResponse

Evaluates values at the time of the request and returns them. It considers the request's timezone or the table's timezone, in that order, when accessing time based tables. When a value is accessed, the accessor's identity and the time of access are saved alongside the value to help identify values that are actively in use. The term "Batch" is not included in the operation name since it does not meet all the criteria for a batch operation as specified in Batch Operations: Amazon Web Services API Standards.

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

Examples:

Request syntax with placeholder values


resp = client.evaluate_data_table_values({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
  values: [ # required
    {
      primary_values: [
        {
          attribute_name: "DataTableName", # required
          value: "String", # required
        },
      ],
      attribute_names: ["DataTableName"], # required
    },
  ],
  time_zone: "TimeZone",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.values #=> Array
resp.values[0].record_id #=> String
resp.values[0].primary_values #=> Array
resp.values[0].primary_values[0].attribute_name #=> String
resp.values[0].primary_values[0].value #=> String
resp.values[0].attribute_name #=> String
resp.values[0].value_type #=> String, one of "TEXT", "NUMBER", "BOOLEAN", "TEXT_LIST", "NUMBER_LIST"
resp.values[0].found #=> Boolean
resp.values[0].error #=> Boolean
resp.values[0].evaluated_value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table. Must also accept the table ARN with or without a version alias.

  • :values (required, Array<Types::DataTableValueEvaluationSet>) —

    A list of value evaluation sets specifying which primary values and attributes to evaluate.

  • :time_zone (String) —

    Optional IANA timezone identifier to use when resolving time based dynamic values. Defaults to the data table time zone if not provided.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of data table values to return in one page of results.

Returns:

See Also:



11356
11357
11358
11359
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11356

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

#get_attached_file(params = {}) ⇒ Types::GetAttachedFileResponse

Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.

Examples:

Request syntax with placeholder values


resp = client.get_attached_file({
  instance_id: "InstanceId", # required
  file_id: "FileId", # required
  url_expiry_in_seconds: 1,
  associated_resource_arn: "ARN", # required
})

Response structure


resp.file_arn #=> String
resp.file_id #=> String
resp.creation_time #=> String
resp.file_status #=> String, one of "APPROVED", "REJECTED", "PROCESSING", "FAILED"
resp.file_name #=> String
resp.file_size_in_bytes #=> Integer
resp.associated_resource_arn #=> String
resp.file_use_case_type #=> String, one of "CONTACT_ANALYSIS", "EMAIL_MESSAGE", "EMAIL_MESSAGE_PLAIN_TEXT", "EMAIL_MESSAGE_REDACTED", "EMAIL_MESSAGE_PLAIN_TEXT_REDACTED", "ATTACHMENT", "VOICE_RECORDING"
resp.created_by.connect_user_arn #=> String
resp.created_by.aws_identity_arn #=> String
resp.download_url_metadata.url #=> String
resp.download_url_metadata.url_expiry #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier of the Connect Customer instance.

  • :file_id (required, String) —

    The unique identifier of the attached file resource.

  • :url_expiry_in_seconds (Integer) —

    Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.

  • :associated_resource_arn (required, String) —

    The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task.

    This value must be a valid ARN.

Returns:

See Also:



11433
11434
11435
11436
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11433

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

#get_contact_attributes(params = {}) ⇒ Types::GetContactAttributesResponse

Retrieves the contact attributes for the specified contact.

Examples:

Request syntax with placeholder values


resp = client.get_contact_attributes({
  instance_id: "InstanceId", # required
  initial_contact_id: "ContactId", # required
})

Response structure


resp.attributes #=> Hash
resp.attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance.

  • :initial_contact_id (required, String) —

    The identifier of the initial contact.

Returns:

See Also:



11466
11467
11468
11469
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11466

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

#get_contact_metrics(params = {}) ⇒ Types::GetContactMetricsResponse

Retrieves contact metric data for a specified contact.

Use cases

Following are common use cases for position in queue and estimated wait time:

  • Customer-Facing Wait Time Announcements - Display or announce the estimated wait time and position in queue to customers before or during their queue experience.

  • Callback Offerings - Offer customers a callback option when the estimated wait time or position in queue exceeds a defined threshold.

  • Queue Routing Decisions - Route incoming contacts to less congested queues by comparing estimated wait time and position in queue across multiple queues.

  • Self-Service Deflection - Redirect customers to self-service options like chatbots or FAQs when estimated wait time is high or position in queue is unfavorable.

Important things to know

  • Metrics are only available while the contact is actively in queue.

  • For more information, see the Position in queue metric in the Connect Customer Administrator Guide.

Endpoints: See Connect Customer endpoints and quotas.

Examples:

Request syntax with placeholder values


resp = client.get_contact_metrics({
  instance_id: "InstanceIdOrArn", # required
  contact_id: "InstanceIdOrArn", # required
  metrics: [ # required
    {
      name: "ESTIMATED_WAIT_TIME", # required, accepts ESTIMATED_WAIT_TIME, POSITION_IN_QUEUE
    },
  ],
})

Response structure


resp.metric_results #=> Array
resp.metric_results[0].name #=> String, one of "ESTIMATED_WAIT_TIME", "POSITION_IN_QUEUE"
resp.metric_results[0].value.number #=> Float
resp.id #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer.

  • :metrics (required, Array<Types::ContactMetricInfo>) —

    A list of contact level metrics to retrieve.Supported metrics include POSITION_IN_QUEUE (the contact's current position in the queue) and ESTIMATED_WAIT_TIME (the predicted time in seconds until the contact is connected to an agent)

Returns:

See Also:



11555
11556
11557
11558
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11555

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

#get_current_metric_data(params = {}) ⇒ Types::GetCurrentMetricDataResponse

Gets the real-time metric data from the specified Connect Customer instance.

For a description of each metric, see Metrics definitions in the Connect Customer Administrator Guide.

When you make a successful API request, you can expect the following metric values in the response:

  1. Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data

  2. Metric value is a number (including 0) of defined type: The number provided is the calculation result

  3. MetricResult list is empty: The request cannot find any data in the system

The following guidelines can help you work with the API:

  • Each dimension in the metric response must contain a value

  • Each item in MetricResult must include all requested metrics

  • If the response is slow due to large result sets, try these approaches:

    • Add filters to reduce the amount of data returned

    ^

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

Examples:

Request syntax with placeholder values


resp = client.get_current_metric_data({
  instance_id: "InstanceId", # required
  filters: { # required
    queues: ["QueueId"],
    channels: ["VOICE"], # accepts VOICE, CHAT, TASK, EMAIL
    routing_profiles: ["RoutingProfileId"],
    routing_step_expressions: ["RoutingExpression"],
    agent_statuses: ["AgentStatusId"],
    subtypes: ["Subtype"],
    validation_test_types: ["ValidationTestType"],
  },
  groupings: ["QUEUE"], # accepts QUEUE, CHANNEL, ROUTING_PROFILE, ROUTING_STEP_EXPRESSION, AGENT_STATUS, SUBTYPE, VALIDATION_TEST_TYPE
  current_metrics: [ # required
    {
      name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE, ESTIMATED_WAIT_TIME
      metric_id: "CurrentMetricId",
      unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
    },
  ],
  next_token: "NextToken",
  max_results: 1,
  sort_criteria: [
    {
      sort_by_metric: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE, ESTIMATED_WAIT_TIME
      sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
    },
  ],
})

Response structure


resp.next_token #=> String
resp.metric_results #=> Array
resp.metric_results[0].dimensions.queue.id #=> String
resp.metric_results[0].dimensions.queue.arn #=> String
resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.metric_results[0].dimensions.routing_profile.id #=> String
resp.metric_results[0].dimensions.routing_profile.arn #=> String
resp.metric_results[0].dimensions.routing_step_expression #=> String
resp.metric_results[0].dimensions.agent_status.arn #=> String
resp.metric_results[0].dimensions.agent_status.id #=> String
resp.metric_results[0].dimensions.subtype #=> String
resp.metric_results[0].dimensions.validation_test_type #=> String
resp.metric_results[0].collections #=> Array
resp.metric_results[0].collections[0].metric.name #=> String, one of "AGENTS_ONLINE", "AGENTS_AVAILABLE", "AGENTS_ON_CALL", "AGENTS_NON_PRODUCTIVE", "AGENTS_AFTER_CONTACT_WORK", "AGENTS_ERROR", "AGENTS_STAFFED", "CONTACTS_IN_QUEUE", "OLDEST_CONTACT_AGE", "CONTACTS_SCHEDULED", "AGENTS_ON_CONTACT", "SLOTS_ACTIVE", "SLOTS_AVAILABLE", "ESTIMATED_WAIT_TIME"
resp.metric_results[0].collections[0].metric.metric_id #=> String
resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
resp.metric_results[0].collections[0].value #=> Float
resp.data_snapshot_time #=> Time
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :filters (required, Types::Filters) —

    The filters to apply to returned metrics. You can filter up to the following limits:

    • Queues: 100

    • Routing profiles: 100

    • Channels: 3 (VOICE, CHAT, and TASK channels are supported.)

    • RoutingStepExpressions: 50

    • AgentStatuses: 50

    • Subtypes: 10

    • ValidationTestTypes: 10

    Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.

    When using AgentStatuses as filter make sure Queues is added as primary filter.

    When using Subtypes as filter make sure Queues is added as primary filter.

    When using ValidationTestTypes as filter make sure Queues is added as primary filter.

    When using the RoutingStepExpression filter, you need to pass exactly one QueueId. The filter is also case sensitive so when using the RoutingStepExpression filter, grouping by ROUTING_STEP_EXPRESSION is required.

    Currently tagging is only supported on the resources that are passed in the filter.

  • :groupings (Array<String>) —

    Defines the level of aggregation for metrics data by a dimension(s). Its similar to sorting items into buckets based on a common characteristic, then counting or calculating something for each bucket. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues.

    The grouping list is an ordered list, with the first item in the list defined as the primary grouping. If no grouping is included in the request, the aggregation happens at the instance-level.

    • If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.

    • If you group by AGENT_STATUS, you must include the QUEUE as the primary grouping and use queue filter. When you group by AGENT_STATUS, the only metric available is the AGENTS_ONLINE metric.

    • If you group by SUBTYPE or VALIDATION_TEST_TYPE as secondary grouping then you must include QUEUE as primary grouping and use Queue as filter

    • If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED, CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.

    • When using the RoutingStepExpression filter, group by ROUTING_STEP_EXPRESSION is required.

  • :current_metrics (required, Array<Types::CurrentMetric>) —

    The metrics to retrieve. Specify the name or metricId, and unit for each metric. The following metrics are available. For a description of all the metrics, see Metrics definitions in the Connect Customer Administrator Guide.

    MetricId should be used to reference custom metrics or out of the box metrics as Arn. If using MetricId, the limit is 10 MetricId per request.

    AGENTS_AFTER_CONTACT_WORK

    Unit: COUNT

    Name in real-time metrics report: ACW

    AGENTS_AVAILABLE

    Unit: COUNT

    Name in real-time metrics report: Available

    AGENTS_ERROR

    Unit: COUNT

    Name in real-time metrics report: Error

    AGENTS_NON_PRODUCTIVE

    Unit: COUNT

    Name in real-time metrics report: NPT (Non-Productive Time)

    AGENTS_ON_CALL

    Unit: COUNT

    Name in real-time metrics report: On contact

    AGENTS_ON_CONTACT

    Unit: COUNT

    Name in real-time metrics report: On contact

    AGENTS_ONLINE

    Unit: COUNT

    Name in real-time metrics report: Online

    AGENTS_STAFFED

    Unit: COUNT

    Name in real-time metrics report: Staffed

    CONTACTS_IN_QUEUE

    Unit: COUNT

    Name in real-time metrics report: In queue

    CONTACTS_SCHEDULED

    Unit: COUNT

    Name in real-time metrics report: Scheduled

    ESTIMATED_WAIT_TIME

    Unit: SECONDS

    This metric supports filter and grouping combination only used for core routing purpose. Valid filter and grouping use cases:

    • Filter by a list of [Queues] and a list of [Channels], group by [“QUEUE”, “CHANNEL”]

    • Filter by a singleton list of [Queue], a singleton list of [Channel], a list of [RoutingStepExpression], group by [“ROUTING_STEP_EXPRESSION”].

    OLDEST_CONTACT_AGE

    Unit: SECONDS

    When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.

    When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:

    { "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0}

    The actual OLDEST_CONTACT_AGE is 24 seconds.

    When the filter RoutingStepExpression is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under <Expression 1> for 10 seconds has expired and <Expression 2> becomes active, then OLDEST_CONTACT_AGE for this queue will be counted starting from 10, not 0.

    Name in real-time metrics report: Oldest

    SLOTS_ACTIVE

    Unit: COUNT

    Name in real-time metrics report: Active

    SLOTS_AVAILABLE

    Unit: COUNT

    Name in real-time metrics report: Availability

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :sort_criteria (Array<Types::CurrentMetricSortCriteria>) —

    The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is sorted based on the input metrics.

    Note the following:

    • Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.

    ^

Returns:

See Also:



11904
11905
11906
11907
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11904

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

#get_current_user_data(params = {}) ⇒ Types::GetCurrentUserDataResponse

Gets the real-time active user data from the specified Connect Customer instance.

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

Examples:

Request syntax with placeholder values


resp = client.get_current_user_data({
  instance_id: "InstanceId", # required
  filters: { # required
    queues: ["QueueId"],
    contact_filter: {
      contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
    },
    routing_profiles: ["RoutingProfileId"],
    agents: ["UserId"],
    user_hierarchy_groups: ["HierarchyGroupId"],
  },
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.user_data_list #=> Array
resp.user_data_list[0].user.id #=> String
resp.user_data_list[0].user.arn #=> String
resp.user_data_list[0].routing_profile.id #=> String
resp.user_data_list[0].routing_profile.arn #=> String
resp.user_data_list[0].hierarchy_path.level_one.id #=> String
resp.user_data_list[0].hierarchy_path.level_one.arn #=> String
resp.user_data_list[0].hierarchy_path.level_two.id #=> String
resp.user_data_list[0].hierarchy_path.level_two.arn #=> String
resp.user_data_list[0].hierarchy_path.level_three.id #=> String
resp.user_data_list[0].hierarchy_path.level_three.arn #=> String
resp.user_data_list[0].hierarchy_path.level_four.id #=> String
resp.user_data_list[0].hierarchy_path.level_four.arn #=> String
resp.user_data_list[0].hierarchy_path.level_five.id #=> String
resp.user_data_list[0].hierarchy_path.level_five.arn #=> String
resp.user_data_list[0].status.status_start_timestamp #=> Time
resp.user_data_list[0].status.status_arn #=> String
resp.user_data_list[0].status.status_name #=> String
resp.user_data_list[0].available_slots_by_channel #=> Hash
resp.user_data_list[0].available_slots_by_channel["Channel"] #=> Integer
resp.user_data_list[0].max_slots_by_channel #=> Hash
resp.user_data_list[0].max_slots_by_channel["Channel"] #=> Integer
resp.user_data_list[0].active_slots_by_channel #=> Hash
resp.user_data_list[0].active_slots_by_channel["Channel"] #=> Integer
resp.user_data_list[0].contacts #=> Array
resp.user_data_list[0].contacts[0].contact_id #=> String
resp.user_data_list[0].contacts[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.user_data_list[0].contacts[0].initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR", "EXTERNAL_OUTBOUND", "WEBRTC_API", "AGENT_REPLY", "FLOW"
resp.user_data_list[0].contacts[0].agent_contact_state #=> String, one of "INCOMING", "PENDING", "CONNECTING", "CONNECTED", "CONNECTED_ONHOLD", "MISSED", "ERROR", "ENDED", "REJECTED"
resp.user_data_list[0].contacts[0].state_start_timestamp #=> Time
resp.user_data_list[0].contacts[0].connected_to_agent_timestamp #=> Time
resp.user_data_list[0].contacts[0].queue.id #=> String
resp.user_data_list[0].contacts[0].queue.arn #=> String
resp.user_data_list[0].next_status #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :filters (required, Types::UserDataFilters) —

    The filters to apply to returned user data. You can filter up to the following limits:

    • Queues: 100

    • Routing profiles: 100

    • Agents: 100

    • Contact states: 9

    • User hierarchy groups: 1

    The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.

    Currently tagging is only supported on the resources that are passed in the filter.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



12017
12018
12019
12020
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12017

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

#get_effective_hours_of_operations(params = {}) ⇒ Types::GetEffectiveHoursOfOperationsResponse

Get the hours of operations with the effective override applied.

Examples:

Request syntax with placeholder values


resp = client.get_effective_hours_of_operations({
  instance_id: "InstanceId", # required
  hours_of_operation_id: "HoursOfOperationId", # required
  from_date: "HoursOfOperationOverrideYearMonthDayDateFormat", # required
  to_date: "HoursOfOperationOverrideYearMonthDayDateFormat", # required
})

Response structure


resp.effective_hours_of_operation_list #=> Array
resp.effective_hours_of_operation_list[0].date #=> String
resp.effective_hours_of_operation_list[0].operational_hours #=> Array
resp.effective_hours_of_operation_list[0].operational_hours[0].start.hours #=> Integer
resp.effective_hours_of_operation_list[0].operational_hours[0].start.minutes #=> Integer
resp.effective_hours_of_operation_list[0].operational_hours[0].end.hours #=> Integer
resp.effective_hours_of_operation_list[0].operational_hours[0].end.minutes #=> Integer
resp.effective_override_hours_list #=> Array
resp.effective_override_hours_list[0].date #=> String
resp.effective_override_hours_list[0].override_hours #=> Array
resp.effective_override_hours_list[0].override_hours[0].start.hours #=> Integer
resp.effective_override_hours_list[0].override_hours[0].start.minutes #=> Integer
resp.effective_override_hours_list[0].override_hours[0].end.hours #=> Integer
resp.effective_override_hours_list[0].override_hours[0].end.minutes #=> Integer
resp.effective_override_hours_list[0].override_hours[0].override_name #=> String
resp.effective_override_hours_list[0].override_hours[0].operational_status #=> String, one of "OPEN", "CLOSED"
resp.time_zone #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance.

  • :hours_of_operation_id (required, String) —

    The identifier for the hours of operation.

  • :from_date (required, String) —

    The date from when the hours of operation are listed.

  • :to_date (required, String) —

    The date until when the hours of operation are listed.

Returns:

See Also:



12075
12076
12077
12078
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12075

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

#get_evaluation_form_validation(params = {}) ⇒ Types::GetEvaluationFormValidationResponse

Retrieves the status and results of a validation process started by StartEvaluationFormValidation. Returns the current execution status (IN_PROGRESS, COMPLETED, or FAILED), the validated form version, and when completed, a list of findings that identify structural issues and quality improvements for the evaluation form, and may include suggested fixes. If the validation failed, a reason is provided indicating the cause of the failure.

Examples:

Request syntax with placeholder values


resp = client.get_evaluation_form_validation({
  instance_id: "InstanceId", # required
  evaluation_form_id: "ResourceId", # required
  evaluation_form_version: 1,
})

Response structure


resp.status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.failure_reason #=> String
resp.evaluation_form_id #=> String
resp.evaluation_form_version #=> Integer
resp.started_time #=> Time
resp.findings #=> Array
resp.findings[0].issue_code #=> String
resp.findings[0].items #=> Array
resp.findings[0].items[0].ref_id #=> String
resp.findings[0].items[0].property #=> String
resp.findings[0].description #=> String
resp.findings[0].suggestion #=> String
resp.findings[0].severity #=> String, one of "WARNING", "ERROR"

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :evaluation_form_id (required, String) —

    The unique identifier for the evaluation form.

  • :evaluation_form_version (Integer) —

    The version of the evaluation form to retrieve validation results for.

Returns:

See Also:



12143
12144
12145
12146
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12143

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

#get_federation_token(params = {}) ⇒ Types::GetFederationTokenResponse

Supports SAML sign-in for Connect Customer. Retrieves a token for federation. The token is for the Connect Customer user which corresponds to the IAM credentials that were used to invoke this action.

For more information about how SAML sign-in works in Connect Customer, see Configure SAML with IAM for Connect Customer in the Connect Customer Administrator Guide.

This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:

Provided identity: Principal: .... User: .... cannot be used for federation with Connect Customer

Examples:

Request syntax with placeholder values


resp = client.get_federation_token({
  instance_id: "InstanceId", # required
})

Response structure


resp.user_id #=> String
resp.user_arn #=> String
resp.credentials.access_token #=> String
resp.credentials.access_token_expiration #=> Time
resp.credentials.refresh_token #=> String
resp.credentials.refresh_token_expiration #=> Time
resp. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



12205
12206
12207
12208
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12205

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

#get_flow_association(params = {}) ⇒ Types::GetFlowAssociationResponse

Retrieves the flow associated for a given resource.

Examples:

Request syntax with placeholder values


resp = client.get_flow_association({
  instance_id: "InstanceId", # required
  resource_id: "ARN", # required
  resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL, ANALYTICS_CONNECTOR, WHATSAPP_MESSAGING_PHONE_NUMBER
})

Response structure


resp.resource_id #=> String
resp.flow_id #=> String
resp.resource_type #=> String, one of "SMS_PHONE_NUMBER", "INBOUND_EMAIL", "OUTBOUND_EMAIL", "ANALYTICS_CONNECTOR", "WHATSAPP_MESSAGING_PHONE_NUMBER"

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :resource_id (required, String) —

    The identifier of the resource.

    • Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER

    • Amazon Web Services End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER

  • :resource_type (required, String) —

    A valid resource type.

Returns:

See Also:



12256
12257
12258
12259
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12256

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

#get_metric_data(params = {}) ⇒ Types::GetMetricDataResponse

Gets historical metric data from the specified Connect Customer instance.

For a description of each historical metric, see Metrics definitions in the Connect Customer Administrator Guide.

We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.

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

Examples:

Request syntax with placeholder values


resp = client.get_metric_data({
  instance_id: "InstanceId", # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  filters: { # required
    queues: ["QueueId"],
    channels: ["VOICE"], # accepts VOICE, CHAT, TASK, EMAIL
    routing_profiles: ["RoutingProfileId"],
    routing_step_expressions: ["RoutingExpression"],
    agent_statuses: ["AgentStatusId"],
    subtypes: ["Subtype"],
    validation_test_types: ["ValidationTestType"],
  },
  groupings: ["QUEUE"], # accepts QUEUE, CHANNEL, ROUTING_PROFILE, ROUTING_STEP_EXPRESSION, AGENT_STATUS, SUBTYPE, VALIDATION_TEST_TYPE
  historical_metrics: [ # required
    {
      name: "CONTACTS_QUEUED", # accepts CONTACTS_QUEUED, CONTACTS_HANDLED, CONTACTS_ABANDONED, CONTACTS_CONSULTED, CONTACTS_AGENT_HUNG_UP_FIRST, CONTACTS_HANDLED_INCOMING, CONTACTS_HANDLED_OUTBOUND, CONTACTS_HOLD_ABANDONS, CONTACTS_TRANSFERRED_IN, CONTACTS_TRANSFERRED_OUT, CONTACTS_TRANSFERRED_IN_FROM_QUEUE, CONTACTS_TRANSFERRED_OUT_FROM_QUEUE, CONTACTS_MISSED, CALLBACK_CONTACTS_HANDLED, API_CONTACTS_HANDLED, OCCUPANCY, HANDLE_TIME, AFTER_CONTACT_WORK_TIME, QUEUED_TIME, ABANDON_TIME, QUEUE_ANSWER_TIME, HOLD_TIME, INTERACTION_TIME, INTERACTION_AND_HOLD_TIME, SERVICE_LEVEL
      threshold: {
        comparison: "LT", # accepts LT
        threshold_value: 1.0,
      },
      statistic: "SUM", # accepts SUM, MAX, AVG
      unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.metric_results #=> Array
resp.metric_results[0].dimensions.queue.id #=> String
resp.metric_results[0].dimensions.queue.arn #=> String
resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.metric_results[0].dimensions.routing_profile.id #=> String
resp.metric_results[0].dimensions.routing_profile.arn #=> String
resp.metric_results[0].dimensions.routing_step_expression #=> String
resp.metric_results[0].dimensions.agent_status.arn #=> String
resp.metric_results[0].dimensions.agent_status.id #=> String
resp.metric_results[0].dimensions.subtype #=> String
resp.metric_results[0].dimensions.validation_test_type #=> String
resp.metric_results[0].collections #=> Array
resp.metric_results[0].collections[0].metric.name #=> String, one of "CONTACTS_QUEUED", "CONTACTS_HANDLED", "CONTACTS_ABANDONED", "CONTACTS_CONSULTED", "CONTACTS_AGENT_HUNG_UP_FIRST", "CONTACTS_HANDLED_INCOMING", "CONTACTS_HANDLED_OUTBOUND", "CONTACTS_HOLD_ABANDONS", "CONTACTS_TRANSFERRED_IN", "CONTACTS_TRANSFERRED_OUT", "CONTACTS_TRANSFERRED_IN_FROM_QUEUE", "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE", "CONTACTS_MISSED", "CALLBACK_CONTACTS_HANDLED", "API_CONTACTS_HANDLED", "OCCUPANCY", "HANDLE_TIME", "AFTER_CONTACT_WORK_TIME", "QUEUED_TIME", "ABANDON_TIME", "QUEUE_ANSWER_TIME", "HOLD_TIME", "INTERACTION_TIME", "INTERACTION_AND_HOLD_TIME", "SERVICE_LEVEL"
resp.metric_results[0].collections[0].metric.threshold.comparison #=> String, one of "LT"
resp.metric_results[0].collections[0].metric.threshold.threshold_value #=> Float
resp.metric_results[0].collections[0].metric.statistic #=> String, one of "SUM", "MAX", "AVG"
resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
resp.metric_results[0].collections[0].value #=> Float

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

    The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

    The time range between the start and end time must be less than 24 hours.

  • :filters (required, Types::Filters) —

    The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.

    RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

    To filter by Queues, enter the queue ID/ARN, not the name of the queue.

  • :groupings (Array<String>) —

    The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

    If no grouping is specified, a summary of metrics for all queues is returned.

    RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

  • :historical_metrics (required, Array<Types::HistoricalMetric>) —

    The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Metrics definition in the Connect Customer Administrator Guide.

    This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

    ABANDON_TIME

    Unit: SECONDS

    Statistic: AVG

    UI name: Average queue abandon time

    AFTER_CONTACT_WORK_TIME

    Unit: SECONDS

    Statistic: AVG

    UI name: After contact work time

    API_CONTACTS_HANDLED

    Unit: COUNT

    Statistic: SUM

    UI name: API contacts handled

    AVG_HOLD_TIME

    Unit: SECONDS

    Statistic: AVG

    UI name: Average customer hold time

    CALLBACK_CONTACTS_HANDLED

    Unit: COUNT

    Statistic: SUM

    UI name: Callback contacts handled

    CONTACTS_ABANDONED

    Unit: COUNT

    Statistic: SUM

    UI name: Contacts abandoned

    CONTACTS_AGENT_HUNG_UP_FIRST

    Unit: COUNT

    Statistic: SUM

    UI name: Contacts agent hung up first

    CONTACTS_CONSULTED

    Unit: COUNT

    Statistic: SUM

    UI name: Contacts consulted

    CONTACTS_HANDLED

    Unit: COUNT

    Statistic: SUM

    UI name: Contacts handled

    CONTACTS_HANDLED_INCOMING

    Unit: COUNT

    Statistic: SUM

    UI name: Contacts handled incoming

    CONTACTS_HANDLED_OUTBOUND

    Unit: COUNT

    Statistic: SUM

    UI name: Contacts handled outbound

    CONTACTS_HOLD_ABANDONS

    Unit: COUNT

    Statistic: SUM

    UI name: Contacts hold disconnect

    CONTACTS_MISSED

    Unit: COUNT

    Statistic: SUM

    UI name: AGENT_NON_RESPONSE

    CONTACTS_QUEUED

    Unit: COUNT

    Statistic: SUM

    UI name: Contacts queued

    CONTACTS_TRANSFERRED_IN

    Unit: COUNT

    Statistic: SUM

    UI name: Contacts transferred in

    CONTACTS_TRANSFERRED_IN_FROM_QUEUE

    Unit: COUNT

    Statistic: SUM

    UI name: Contacts transferred out queue

    CONTACTS_TRANSFERRED_OUT

    Unit: COUNT

    Statistic: SUM

    UI name: Contacts transferred out

    CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

    Unit: COUNT

    Statistic: SUM

    UI name: Contacts transferred out queue

    HANDLE_TIME

    Unit: SECONDS

    Statistic: AVG

    UI name: Average handle time

    INTERACTION_AND_HOLD_TIME

    Unit: SECONDS

    Statistic: AVG

    UI name: Average agent interaction and customer hold time

    INTERACTION_TIME

    Unit: SECONDS

    Statistic: AVG

    UI name: Average agent interaction time

    OCCUPANCY

    Unit: PERCENT

    Statistic: AVG

    UI name: Occupancy

    QUEUE_ANSWER_TIME

    Unit: SECONDS

    Statistic: AVG

    UI name: Average queue answer time

    QUEUED_TIME

    Unit: SECONDS

    Statistic: MAX

    UI name: Minimum flow time

    SERVICE_LEVEL

    You can include up to 20 SERVICE_LEVEL metrics in a request.

    Unit: PERCENT

    Statistic: AVG

    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

    UI name: Average queue abandon time

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



12652
12653
12654
12655
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12652

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

#get_metric_data_v2(params = {}) ⇒ Types::GetMetricDataV2Response

Gets metric data from the specified Connect Customer instance.

GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues.

For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Metrics definitions in the Connect Customer Administrator Guide.

When you make a successful API request, you can expect the following metric values in the response:

  1. Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data

  2. Metric value is a number (including 0) of defined type: The number provided is the calculation result

  3. MetricResult list is empty: The request cannot find any data in the system

The following guidelines can help you work with the API:

  • Each dimension in the metric response must contain a value

  • Each item in MetricResult must include all requested metrics

  • If the response is slow due to large result sets, try these approaches:

    • Narrow the time range of your request

    • Add filters to reduce the amount of data returned

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

Examples:

Request syntax with placeholder values


resp = client.get_metric_data_v2({
  resource_arn: "ARN", # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  interval: {
    time_zone: "String",
    interval_period: "FIFTEEN_MIN", # accepts FIFTEEN_MIN, THIRTY_MIN, HOUR, DAY, WEEK, TOTAL
  },
  filters: [ # required
    {
      filter_key: "ResourceArnOrId",
      filter_values: ["ResourceArnOrId"],
      string_condition: {
        comparison: "NOT_EXISTS", # accepts NOT_EXISTS
      },
    },
  ],
  groupings: ["GroupingV2"],
  metrics: [ # required
    {
      name: "MetricNameV2",
      threshold: [
        {
          comparison: "ResourceArnOrId",
          threshold_value: 1.0,
        },
      ],
      metric_id: "MetricId",
      metric_filters: [
        {
          metric_filter_key: "String",
          metric_filter_values: ["String"],
          negate: false,
        },
      ],
    },
  ],
  next_token: "NextToken2500",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.metric_results #=> Array
resp.metric_results[0].dimensions #=> Hash
resp.metric_results[0].dimensions["DimensionsV2Key"] #=> String
resp.metric_results[0].metric_interval.interval #=> String, one of "FIFTEEN_MIN", "THIRTY_MIN", "HOUR", "DAY", "WEEK", "TOTAL"
resp.metric_results[0].metric_interval.start_time #=> Time
resp.metric_results[0].metric_interval.end_time #=> Time
resp.metric_results[0].collections #=> Array
resp.metric_results[0].collections[0].metric.name #=> String
resp.metric_results[0].collections[0].metric.threshold #=> Array
resp.metric_results[0].collections[0].metric.threshold[0].comparison #=> String
resp.metric_results[0].collections[0].metric.threshold[0].threshold_value #=> Float
resp.metric_results[0].collections[0].metric.metric_id #=> String
resp.metric_results[0].collections[0].metric.metric_filters #=> Array
resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_key #=> String
resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_values #=> Array
resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_values[0] #=> String
resp.metric_results[0].collections[0].metric.metric_filters[0].negate #=> Boolean
resp.metric_results[0].collections[0].value #=> Float

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource. This includes the instanceId an Connect Customer instance.

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be before the end time timestamp. The start and end time depends on the IntervalPeriod selected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be later than the start time timestamp. It cannot be later than the current timestamp.

  • :interval (Types::IntervalDetails) —

    The interval period and timezone to apply to returned metrics.

    • IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL.

      For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime differs by 1 day, then Connect Customer returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Connect Customer aggregates results based on the TOTAL interval period.

      The following list describes restrictions on StartTime and EndTime based on which IntervalPeriod is requested.

      • FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days.

      • THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days.

      • HOUR: The difference between StartTime and EndTime must be less than 3 days.

      • DAY: The difference between StartTime and EndTime must be less than 35 days.

      • WEEK: The difference between StartTime and EndTime must be less than 35 days.

      • TOTAL: The difference between StartTime and EndTime must be less than 35 days.

    • TimeZone: The timezone applied to requested metrics.
  • :filters (required, Array<Types::FilterV2>) —

    Filtering is an operation that selects records that match a set of specified criteria. By narrowing the dataset before aggregation, filters ensure that only relevant records are included in the computation.

    Filter keys

    The following are valid filter keys for a GetMetricDataV2 request:

    AGENT | AI_AGENT | AI_AGENT_ID | AI_AGENT_NAME | AI_AGENT_TYPE | AI_PROMPT | AI_PROMPT_ID | AI_PROMPT_NAME | AI_PROMPT_TYPE | AI_TOOL_ID | AI_TOOL_NAME | AI_TOOL_TYPE | AI_USE_CASE | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS | BOT_ALIAS | BOT_ID | BOT_INTENT_NAME | BOT_LOCALE | BOT_VERSION | BROWSER_NAME | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE | CAMPAIGN_EXCLUDED_EVENT_TYPE | CASE_STATUS | CASE_TEMPLATE_ARN | CHANNEL | contact/segmentAttributes/connect:Subtype | contact/segmentAttributes/connect:ValidationTestType | DEVICE_MODEL | DEVICE_TYPE | DISCONNECT_REASON | EVALUATION_FORM | EVALUATION_QUESTION | EVALUATION_SECTION | EVALUATION_SOURCE | EVALUATOR_ID | FEATURE | FLOW_ACTION_ID | FLOW_TYPE | FLOWS_MODULE_RESOURCE_ID | FLOWS_NEXT_RESOURCE_ID | FLOWS_NEXT_RESOURCE_QUEUE_ID | FLOWS_OUTCOME_TYPE | FLOWS_RESOURCE_ID | FORM_VERSION | INITIATING_FLOW | INITIATION_METHOD | INVOKING_RESOURCE_PUBLISHED_TIMESTAMP | INVOKING_RESOURCE_TYPE | KNOWLEDGE_BASE_NAME | PARENT_FLOWS_RESOURCE_ID | Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | SESSION_ID | TEST_CASE | TEST_CASE_EXECUTION_FAILURE_REASON | TEST_CASE_EXECUTION_RESULT | TEST_CASE_EXECUTION_STATE | WEB_NOTIFICATION_TYPE

    The following filter keys correspond to Connect Customer resources and are used for authorizing requests. A GetMetricDataV2 request requires at least one of these filters:

    QUEUE, ROUTING_PROFILE, AGENT, AGENT_HIERARCHY_LEVEL_ONE, AGENT_HIERARCHY_LEVEL_TWO, AGENT_HIERARCHY_LEVEL_THREE, AGENT_HIERARCHY_LEVEL_FOUR, AGENT_HIERARCHY_LEVEL_FIVE, CAMPAIGN, EVALUATION_FORM, EVALUATOR_ID

    You can use up to 5 filter keys in a single request, and up to 100 filter values across all filter keys.

    Filter values

    • VOICE, CHAT, TASK, and EMAIL are valid filter values for the CHANNEL filter key. They do not count towards the limit of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 4 channel filters.

    • contact_lens_conversational_analytics is a valid filter value for the FEATURE filter key. It is available only for contacts analyzed by Contact Lens conversational analytics.

    • connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filter value examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key.

    • ROUTING_STEP_EXPRESSION accepts a filter value up to 3,000 characters in length. Filter values are case-sensitive. JSON object key order and whitespace may be arbitrary; array order and tree structure must be preserved.

    • TRUE and FALSE are the only valid filter values for the Q_CONNECT_ENABLED filter key.

      • TRUE includes all contacts that had Connect AI Agents enabled as part of the flow.

      • FALSE includes all contacts that did not have Connect AI Agents enabled as part of the flow.

    • EXPERIENCE_VALIDATION and FLOW_VALIDATION are the only valid filter values for the contact/segmentAttributes/connect:ValidationTestType filter key. This filter is available only for contact record-driven metrics.

    • Campaign ARNs are valid filter values for the CAMPAIGN filter key.

    • To filter by phone number, see Create a historical metrics report in the Connect Customer Administrator Guide.

  • :groupings (Array<String>) —

    The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.

    If no grouping is specified, a summary of all metrics is returned.

    Valid grouping keys: AGENT | AI_AGENT | AI_AGENT_ID | AI_AGENT_NAME | AI_AGENT_NAME_VERSION | AI_AGENT_TYPE | AI_PROMPT | AI_PROMPT_ID | AI_PROMPT_NAME | AI_PROMPT_NAME_VERSION | AI_PROMPT_TYPE | AI_TOOL_ID | AI_TOOL_NAME | AI_TOOL_TYPE | AI_USE_CASE | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS | BOT_ID | BOT_ALIAS | BOT_VERSION | BOT_LOCALE | BOT_INTENT_NAME | BROWSER_NAME | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE | CAMPAIGN_EXCLUDED_EVENT_TYPE | CAMPAIGN_EXECUTION_TIMESTAMP | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DEVICE_MODEL | DEVICE_TYPE | DISCONNECT_REASON | EVALUATION_FORM | EVALUATION_SECTION | EVALUATION_QUESTION | EVALUATION_SOURCE | EVALUATOR_ID | FLOWS_RESOURCE_ID | FLOWS_MODULE_RESOURCE_ID | FLOW_ACTION_ID | FLOW_TYPE | FLOWS_OUTCOME_TYPE | FORM_VERSION | INITIATION_METHOD | INVOKING_RESOURCE_PUBLISHED_TIMESTAMP | INVOKING_RESOURCE_TYPE | KNOWLEDGE_ARTICLE_NAME | KNOWLEDGE_BASE_NAME | PARENT_FLOWS_RESOURCE_ID | Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | SESSION_ID | TEST_CASE | TEST_CASE_EXECUTION_FAILURE_REASON | TEST_CASE_INVOCATION_METHOD | WEB_NOTIFICATION_TYPE

    AI_AGENT_NAME_VERSION, AI_PROMPT_NAME_VERSION, and KNOWLEDGE_ARTICLE_NAME are valid groupings but not valid filters.

    API, SCHEDULE, and EVENT are the only valid filterValues for TEST_CASE_INVOCATION_METHOD.

    OBSERVE_EVENT, SEND_INSTRUCTION, ASSERT_DATA, and OVERRIDE_SYSTEM_BEHAVIOR are the only valid filterValues for TEST_CASE_EXECUTION_FAILURE_REASON

    Type: Array of strings

    Array Members: Maximum number of 4 items

    Required: No

  • :metrics (required, Array<Types::MetricV2>) —

    The metrics to retrieve. Specify the name or metricId, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Metrics definition in the Connect Customer Administrator Guide.

    MetricId should be used to reference custom metrics or out of the box metrics as Arn. If using MetricId, the limit is 20 MetricId per request.

    ABANDONMENT_RATE

    Unit: Percent

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Abandonment rate

    AGENT_ADHERENT_TIME

    This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    UI name: Adherent time

    AGENT_ANSWER_RATE

    Unit: Percent

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    UI name: Agent answer rate

    AGENT_NON_ADHERENT_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    UI name: Non-adherent time

    AGENT_NON_RESPONSE

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    UI name: Agent non-response

    AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    Data for this metric is available starting from October 1, 2023 0:00:00 GMT.

    UI name: Agent non-response without customer abandons

    AGENT_OCCUPANCY

    Unit: Percentage

    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

    UI name: Occupancy

    AGENT_SCHEDULE_ADHERENCE

    This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

    Unit: Percent

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    UI name: Adherence

    AGENT_SCHEDULED_TIME

    This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    UI name: Scheduled time

    AVG_ABANDON_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect

    Valid metric filter key: INITIATION_METHOD

    UI name: Average queue abandon time

    AVG_ACTIVE_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

    UI name: Average active time

    AVG_AFTER_CONTACT_WORK_TIME

    Unit: Seconds

    Valid metric filter key: INITIATION_METHOD

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average after contact work time

    Feature is a valid filter but not a valid grouping.

    AVG_AGENT_CONCURRENCY

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

    UI name: Average agent concurrency

    AVG_AGENT_CONNECTING_TIME

    Unit: Seconds

    Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    UI name: Average agent API connecting time

    The Negate key in metric-level filters is not applicable for this metric.

    AVG_AGENT_PAUSE_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

    UI name: Average agent pause time

    AVG_BOT_CONVERSATION_TIME

    Unit: Seconds

    Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID

    UI name: Average bot conversation time

    AVG_BOT_CONVERSATION_TURNS

    Unit: Count

    Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID

    UI name: Average bot conversation turns

    AVG_CASE_RELATED_CONTACTS

    Unit: Count

    Required filter key: CASE_TEMPLATE_ARN

    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

    UI name: Average contacts per case

    AVG_CASE_RESOLUTION_TIME

    Unit: Seconds

    Required filter key: CASE_TEMPLATE_ARN

    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

    UI name: Average case resolution time

    AVG_CONTACT_DURATION

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average contact duration

    Feature is a valid filter but not a valid grouping.

    AVG_CONTACT_FIRST_RESPONSE_TIME_AGENT

    Unit: Seconds

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect

    UI name: Agent average contact first response wait time

    AVG_CONVERSATION_CLOSE_TIME

    Unit: Seconds

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect

    UI name: Average conversation close time

    AVG_CONVERSATION_DURATION

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average conversation duration

    AVG_DIALS_PER_MINUTE

    This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.

    Unit: Count

    Valid groupings and filters: Agent, Campaign, Queue, Routing Profile

    UI name: Average dials per minute

    AVG_EVALUATION_SCORE

    Unit: Percent

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile

    UI name: Average evaluation score

    AVG_FIRST_RESPONSE_TIME_AGENT

    Unit: Seconds

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect

    UI name: Average agent first response time

    AVG_FLOW_TIME

    Unit: Seconds

    Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp

    UI name: Average flow time

    AVG_GREETING_TIME_AGENT

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average agent greeting time

    AVG_HANDLE_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, AI Use Case, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression

    UI name: Average handle time

    Feature is a valid filter but not a valid grouping.

    ACTIVE_AI_AGENTS

    Unit: Count

    Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: Active AI Agents

    AI_HANDOFF_RATE

    Unit: Percent

    Valid groupings and filters: AI Agent ID, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Handoff Rate

    AI_HANDOFFS

    Unit: Count

    Valid groupings and filters: AI Agent ID, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Handoff Count

    AI_AGENT_INVOCATION_SUCCESS

    Unit: Count

    Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Agent Invocation Success

    AI Agent Name Version is not a valid filter but a valid grouping.

    AI_AGENT_INVOCATION_SUCCESS_RATE

    Unit: Percent

    Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Agent Invocation Success Rate

    AI Agent Name Version is not a valid filter but a valid grouping.

    AI_AGENT_INVOCATIONS

    Unit: Count

    Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Type, AI Agent Name Version, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Agent Invocation Count

    AI Agent Name Version is not a valid filter but a valid grouping.

    AI_AGENT_RESPONSE_HELPFUL

    Unit: Count

    Valid groupings and filters: AI Agent, AI Agent ID, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Agent Response Helpful

    AI Agent Name Version is not a valid filter but a valid grouping.

    AI_AGENT_RESPONSE_NOT_HELPFUL

    Unit: Count

    Valid groupings and filters: AI Agent, AI Agent ID, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Agent Response Not Helpful

    AI Agent Name Version is not a valid filter but a valid grouping.

    AI_RESPONSE_COMPLETION_RATE

    Unit: Percent

    Valid groupings and filters: AI Agent ID, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Response Completion Rate

    AI_INVOLVED_CONTACTS

    Unit: Count

    Valid groupings and filters: AI Agent ID, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Involved Contacts

    AI_PROMPT_INVOCATION_SUCCESS

    Unit: Count

    Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Prompt Invocation Success

    AI Agent Name Version is not a valid filter but a valid grouping.

    AI_PROMPT_INVOCATION_SUCCESS_RATE

    Unit: Percent

    Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Prompt Invocation Success Rate

    AI Agent Name Version is not a valid filter but a valid grouping.

    AI_PROMPT_INVOCATIONS

    Unit: Count

    Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Prompt Invocations

    AI Agent Name Version is not a valid filter but a valid grouping.

    AI_TOOL_INVOCATION_SUCCESS

    Unit: Count

    Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Tool Invocation Success

    AI Agent Name Version is not a valid filter but a valid grouping.

    AI_TOOL_INVOCATION_SUCCESS_RATE

    Unit: Percent

    Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Tool Invocation Success Rate

    AI Agent Name Version is not a valid filter but a valid grouping.

    AI_TOOL_INVOCATIONS

    Unit: Count

    Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Tool Invocations

    AI Agent Name Version is not a valid filter but a valid grouping.

    AVG_AI_AGENT_CONVERSATION_TURNS

    Unit: Count

    Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: Average AI Agent Conversation Turns

    AI Agent Name Version is not a valid filter but a valid grouping.

    AVG_AI_CONVERSATION_TURNS

    Unit: Count

    Valid groupings and filters: AI Agent ID, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: Average AI Conversation Turns

    AVG_AI_PROMPT_INVOCATION_LATENCY

    Unit: Milliseconds

    Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: Average AI Prompt Invocation Latency

    AI Agent Name Version is not a valid filter but a valid grouping.

    AVG_AI_TOOL_INVOCATION_LATENCY

    Unit: Milliseconds

    Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: Average AI Tool Invocation Latency

    AI Agent Name Version is not a valid filter but a valid grouping.

    AI_TOOL_PARAMETER_ACCURACY

    Unit: Double

    Valid groupings and filters: AI Agent, AI Agent ID, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Tool Parameter Accuracy

    AI Agent Name Version is not a valid filter but a valid grouping.

    AI_TOOL_SELECTION_ACCURACY

    Unit: Double

    Valid groupings and filters: AI Agent, AI Agent ID, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: AI Tool Selection Accuracy

    AI Agent Name Version is not a valid filter but a valid grouping.

    AI_TOOL_UTILIZATION_ACCURACY

    Unit: Double

    Valid groupings and filters: AI Agent, AI Agent ID, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile, Session ID

    UI name: AI Tool Utilization Accuracy

    AI Agent Name Version is not a valid filter but a valid grouping.

    COMPLETENESS_SCORE

    Unit: Double

    Valid groupings and filters: AI Agent ID, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile, Session ID

    UI name: Completeness Score

    FAITHFULNESS_SCORE

    Unit: Double

    Valid groupings and filters: AI Agent ID, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile, Session ID

    UI name: Faithfulness Score

    GOAL_SUCCESS_RATE

    Unit: Double

    Valid groupings and filters: AI Agent ID, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile, Session ID

    UI name: Goal Success Rate

    KNOWLEDGE_CONTENT_REFERENCES

    Unit: Count

    Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Type, AI Use Case, Channel, Knowledge Base Name, Queue, Routing Profile

    UI name: Knowledge Content References

    PROACTIVE_INTENT_ENGAGEMENT_RATE

    Unit: Percent

    Valid groupings and filters: AI Agent ID, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: Proactive Intent Engagement Rate

    PROACTIVE_INTENT_RESPONSE_RATE

    Unit: Percent

    Valid groupings and filters: AI Agent ID, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: Proactive Intent Response Rate

    PROACTIVE_INTENTS_ANSWERED

    Unit: Count

    Valid groupings and filters: AI Agent ID, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: Proactive Intents Answered

    PROACTIVE_INTENTS_DETECTED

    Unit: Count

    Valid groupings and filters: AI Agent ID, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: Proactive Intents Detected

    PROACTIVE_INTENTS_ENGAGED

    Unit: Count

    Valid groupings and filters: AI Agent ID, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile

    UI name: Proactive Intents Engaged

    AVG_HOLD_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average customer hold time

    Feature is a valid filter but not a valid grouping.

    AVG_HOLD_TIME_ALL_CONTACTS

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average customer hold time all contacts

    AVG_HOLDS

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average holds

    Feature is a valid filter but not a valid grouping.

    AVG_INTERACTION_AND_HOLD_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average agent interaction and customer hold time

    AVG_INTERACTION_TIME

    Unit: Seconds

    Valid metric filter key: INITIATION_METHOD

    Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average agent interaction time

    Feature is a valid filter but not a valid grouping.

    AVG_INTERRUPTIONS_AGENT

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average agent interruptions

    AVG_INTERRUPTION_TIME_AGENT

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average agent interruption time

    AVG_MESSAGE_LENGTH_AGENT

    Unit: Count

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect

    UI name: Average agent message length

    AVG_MESSAGE_LENGTH_CUSTOMER

    Unit: Count

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect

    UI name: Average customer message length

    AVG_MESSAGES

    Unit: Count

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect

    UI name: Average messages

    AVG_MESSAGES_AGENT

    Unit: Count

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect

    UI name: Average agent messages

    AVG_MESSAGES_BOT

    Unit: Count

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect

    UI name: Average bot messages

    AVG_MESSAGES_CUSTOMER

    Unit: Count

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect

    UI name: Average customer messages

    AVG_NON_TALK_TIME

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average non-talk time

    AVG_QUEUE_ANSWER_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average queue answer time

    Valid metric level filters: INITIATION_METHOD, FEATURE, DISCONNECT_REASON

    Feature is a valid filter but not a valid grouping.

    AVG_QUEUE_ANSWER_TIME_CUSTOMER_FIRST_CALLBACK

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect, Agent Hierarchy

    UI name: Avg. queue answer time - customer first callback

    AVG_RESPONSE_TIME_AGENT

    Unit: Seconds

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect

    UI name: Average agent response time

    AVG_RESPONSE_TIME_CUSTOMER

    Unit: Seconds

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect

    UI name: Average customer response time

    AVG_RESOLUTION_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average resolution time

    AVG_TALK_TIME

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average talk time

    AVG_TALK_TIME_AGENT

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average agent talk time

    AVG_TALK_TIME_CUSTOMER

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Average customer talk time

    AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION

    This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.

    Unit: Seconds

    Valid groupings and filters: Campaign

    UI name: Average wait time after customer connection

    AVG_WAIT_TIME_AFTER_CUSTOMER_FIRST_CALLBACK_CONNECTION

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect, Agent Hierarchy

    UI name: Avg. wait time after customer connection - customer first callback

    AVG_WEIGHTED_EVALUATION_SCORE

    Unit: Percent

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile

    UI name: Average weighted evaluation score

    BOT_CONVERSATIONS_COMPLETED

    Unit: Count

    Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID

    UI name: Bot conversations completed

    BOT_INTENTS_COMPLETED

    Unit: Count

    Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID

    UI name: Bot intents completed

    CAMPAIGN_CONTACTS_ABANDONED_AFTER_X

    This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.

    Unit: Count

    Valid groupings and filters: Agent, Campaign

    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).

    UI name: Campaign contacts abandoned after X

    CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE

    This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.

    Unit: Percent

    Valid groupings and filters: Agent, Campaign

    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).

    UI name: Campaign contacts abandoned after X rate

    CAMPAIGN_INTERACTIONS

    This metric is available only for outbound campaigns using the email, WhatsApp, and web notification delivery modes.

    Unit: Count

    Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE

    Valid groupings and filters: Browser Name, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Device Model, Device Type, Web Notification Type

    UI name: Campaign interactions

    CAMPAIGN_PROGRESS_RATE

    This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.

    Unit: Percent

    Valid groupings and filters: Campaign, Campaign Execution Timestamp

    UI name: Campaign progress rate

    CAMPAIGN_SEND_ATTEMPTS

    This metric is available only for outbound campaigns.

    Unit: Count

    Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype

    UI name: Campaign send attempts

    CAMPAIGN_SEND_EXCLUSIONS

    This metric is available only for outbound campaigns.

    Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPE

    Unit: Count

    Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution Timestamp

    UI name: Campaign send exclusions

    CASES_CREATED

    Unit: Count

    Required filter key: CASE_TEMPLATE_ARN

    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

    UI name: Cases created

    CONTACTS_CREATED

    Unit: Count

    Valid metric filter key: INITIATION_METHOD

    Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Contacts created

    Feature is a valid filter but not a valid grouping.

    CONTACTS_HANDLED

    Unit: Count

    Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect

    UI name: Contacts handled

    Feature is a valid filter but not a valid grouping.

    CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT

    Unit: Count

    Valid metric filter key: INITIATION_METHOD

    Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Contacts handled (connected to agent timestamp)

    CONTACTS_HOLD_ABANDONS

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Contacts hold disconnect

    CONTACTS_ON_HOLD_AGENT_DISCONNECT

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

    UI name: Contacts hold agent disconnect

    CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

    UI name: Contacts hold customer disconnect

    CONTACTS_PUT_ON_HOLD

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

    UI name: Contacts put on hold

    CONTACTS_TRANSFERRED_OUT_EXTERNAL

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

    UI name: Contacts transferred out external

    CONTACTS_TRANSFERRED_OUT_INTERNAL

    Unit: Percent

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

    UI name: Contacts transferred out internal

    CONTACTS_QUEUED

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Contacts queued

    CONTACTS_QUEUED_BY_ENQUEUE

    Unit: Count

    Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

    UI name: Contacts queued (enqueue timestamp)

    CONTACTS_REMOVED_FROM_QUEUE_IN_X

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect

    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for "Less than") or LTE (for "Less than equal").

    UI name: Contacts removed from queue in X seconds

    CONTACTS_RESOLVED_IN_X

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect

    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for "Less than") or LTE (for "Less than equal").

    UI name: Contacts resolved in X

    CONTACTS_TRANSFERRED_OUT

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Contacts transferred out

    Feature is a valid filter but not a valid grouping.

    CONTACTS_TRANSFERRED_OUT_BY_AGENT

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Contacts transferred out by agent

    CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Contacts transferred out queue

    CURRENT_CASES

    Unit: Count

    Required filter key: CASE_TEMPLATE_ARN

    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

    UI name: Current cases

    CONVERSATIONS_ABANDONED

    Unit: Count

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect

    UI name: Conversations abandoned

    DELIVERY_ATTEMPTS

    This metric is available only for outbound campaigns.

    Unit: Count

    Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON

    Valid groupings and filters: Agent, Answering Machine Detection Status, Browser Name, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Device Model, Device Type, Disconnect Reason, Queue, Routing Profile, Web Notification Type

    UI name: Delivery attempts

    Campaign Delivery EventType filter and grouping are only available for SMS, Email, WhatsApp, and web notification campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.

    DELIVERY_ATTEMPT_DISPOSITION_RATE

    This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.

    Unit: Percent

    Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON

    Valid groupings and filters: Agent, Answering Machine Detection Status, Browser Name, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Device Model, Device Type, Disconnect Reason, Queue, Routing Profile, Web Notification Type

    UI name: Delivery attempt disposition rate

    Campaign Delivery Event Type filter and grouping are only available for SMS, Email, WhatsApp, and web notification campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.

    EVALUATIONS_PERFORMED

    Unit: Count

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile

    UI name: Evaluations performed

    FLOWS_OUTCOME

    Unit: Count

    Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp

    UI name: Flows outcome

    FLOWS_STARTED

    Unit: Count

    Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp

    UI name: Flows started

    HUMAN_ANSWERED_CALLS

    This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.

    Unit: Count

    Valid groupings and filters: Agent, Campaign

    UI name: Human answered

    MAX_FLOW_TIME

    Unit: Seconds

    Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp

    UI name: Maximum flow time

    MAX_QUEUED_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Maximum queued time

    MIN_FLOW_TIME

    Unit: Seconds

    Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp

    UI name: Minimum flow time

    PERCENT_AUTOMATIC_FAILS

    Unit: Percent

    Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile

    UI name: Automatic fails percent

    PERCENT_BOT_CONVERSATIONS_OUTCOME

    Unit: Percent

    Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID

    UI name: Percent bot conversations outcome

    PERCENT_BOT_INTENTS_OUTCOME

    Unit: Percent

    Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID

    UI name: Percent bot intents outcome

    PERCENT_CASES_FIRST_CONTACT_RESOLVED

    Unit: Percent

    Required filter key: CASE_TEMPLATE_ARN

    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

    UI name: Cases resolved on first contact

    PERCENT_CONTACTS_STEP_EXPIRED

    Unit: Percent

    Valid groupings and filters: Queue, RoutingStepExpression

    UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.

    PERCENT_CONTACTS_STEP_JOINED

    Unit: Percent

    Valid groupings and filters: Queue, RoutingStepExpression

    UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.

    PERCENT_FLOWS_OUTCOME

    Unit: Percent

    Valid metric filter key: FLOWS_OUTCOME_TYPE

    Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp

    UI name: Flows outcome percentage.

    The FLOWS_OUTCOME_TYPE is not a valid grouping.

    PERCENT_NON_TALK_TIME

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Percentage

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Non-talk time percent

    PERCENT_TALK_TIME

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Percentage

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Talk time percent

    PERCENT_TALK_TIME_AGENT

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Percentage

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Agent talk time percent

    PERCENT_TALK_TIME_CUSTOMER

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Percentage

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Customer talk time percent

    RECIPIENTS_ATTEMPTED

    This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.

    Unit: Count

    Valid groupings and filters: Campaign, Campaign Execution Timestamp

    UI name: Recipients attempted

    RECIPIENTS_INTERACTED

    This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.

    Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE

    Unit: Count

    Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype, Campaign Execution Timestamp

    UI name: Recipients interacted

    RECIPIENTS_TARGETED

    This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.

    Unit: Count

    Valid groupings and filters: Campaign, Campaign Execution Timestamp

    UI name: Recipients targeted

    REOPENED_CASE_ACTIONS

    Unit: Count

    Required filter key: CASE_TEMPLATE_ARN

    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

    UI name: Cases reopened

    RESOLVED_CASE_ACTIONS

    Unit: Count

    Required filter key: CASE_TEMPLATE_ARN

    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

    UI name: Cases resolved

    SERVICE_LEVEL

    You can include up to 20 SERVICE_LEVEL metrics in a request.

    Unit: Percent

    Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect

    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for "Less than") or LTE (for "Less than equal").

    UI name: Service level X

    STEP_CONTACTS_QUEUED

    Unit: Count

    Valid groupings and filters: Queue, RoutingStepExpression

    UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.

    SUM_AFTER_CONTACT_WORK_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

    UI name: After contact work time

    SUM_CONNECTING_TIME_AGENT

    Unit: Seconds

    Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API | CALLBACK_CUSTOMER_FIRST_DIALED

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    UI name: Agent API connecting time

    The Negate key in metric-level filters is not applicable for this metric.

    CONTACTS_ABANDONED

    Unit: Count

    Metric filter:

    • Valid values: API| INCOMING | OUTBOUND | TRANSFER | CALLBACK | QUEUE_TRANSFER| Disconnect | CALLBACK_CUSTOMER_FIRST_DIALED

    ^

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect

    UI name: Contact abandoned

    SUM_CONTACTS_ABANDONED_IN_X

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect

    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for "Less than") or LTE (for "Less than equal").

    UI name: Contacts abandoned in X seconds

    SUM_CONTACTS_ANSWERED_IN_X

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect

    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for "Less than") or LTE (for "Less than equal").

    UI name: Contacts answered in X seconds

    SUM_CONTACT_FLOW_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

    UI name: Contact flow time

    SUM_CONTACT_TIME_AGENT

    Unit: Seconds

    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

    UI name: Agent on contact time

    SUM_CONTACTS_DISCONNECTED

    Valid metric filter key: DISCONNECT_REASON

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Contact disconnected

    SUM_ERROR_STATUS_TIME_AGENT

    Unit: Seconds

    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

    UI name: Error status time

    SUM_HANDLE_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

    UI name: Contact handle time

    SUM_HOLD_TIME

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

    UI name: Customer hold time

    SUM_IDLE_TIME_AGENT

    Unit: Seconds

    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

    UI name: Agent idle time

    SUM_INTERACTION_AND_HOLD_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

    UI name: Agent interaction and hold time

    SUM_INTERACTION_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    UI name: Agent interaction time

    SUM_NON_PRODUCTIVE_TIME_AGENT

    Unit: Seconds

    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

    UI name: Agent non-productive time

    SUM_ONLINE_TIME_AGENT

    Unit: Seconds

    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

    UI name: Online time

    SUM_RETRY_CALLBACK_ATTEMPTS

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect

    UI name: Callback attempts

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



14988
14989
14990
14991
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14988

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

#get_prompt_file(params = {}) ⇒ Types::GetPromptFileResponse

Gets the prompt file.

Examples:

Request syntax with placeholder values


resp = client.get_prompt_file({
  instance_id: "InstanceId", # required
  prompt_id: "PromptId", # required
})

Response structure


resp.prompt_presigned_url #=> String
resp.last_modified_time #=> Time
resp.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :prompt_id (required, String) —

    A unique identifier for the prompt.

Returns:

See Also:



15029
15030
15031
15032
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15029

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

#get_task_template(params = {}) ⇒ Types::GetTaskTemplateResponse

Gets details about a specific task template in the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.get_task_template({
  instance_id: "InstanceId", # required
  task_template_id: "TaskTemplateId", # required
  snapshot_version: "SnapshotVersion",
})

Response structure


resp.instance_id #=> String
resp.id #=> String
resp.arn #=> String
resp.name #=> String
resp.description #=> String
resp.contact_flow_id #=> String
resp.self_assign_flow_id #=> String
resp.constraints.required_fields #=> Array
resp.constraints.required_fields[0].id.name #=> String
resp.constraints.read_only_fields #=> Array
resp.constraints.read_only_fields[0].id.name #=> String
resp.constraints.invisible_fields #=> Array
resp.constraints.invisible_fields[0].id.name #=> String
resp.defaults.default_field_values #=> Array
resp.defaults.default_field_values[0].id.name #=> String
resp.defaults.default_field_values[0].default_value #=> String
resp.fields #=> Array
resp.fields[0].id.name #=> String
resp.fields[0].description #=> String
resp.fields[0].type #=> String, one of "NAME", "DESCRIPTION", "SCHEDULED_TIME", "QUICK_CONNECT", "URL", "NUMBER", "TEXT", "TEXT_AREA", "DATE_TIME", "BOOLEAN", "SINGLE_SELECT", "EMAIL", "SELF_ASSIGN", "EXPIRY_DURATION"
resp.fields[0].single_select_options #=> Array
resp.fields[0].single_select_options[0] #=> String
resp.status #=> String, one of "ACTIVE", "INACTIVE"
resp.last_modified_time #=> Time
resp.created_time #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :task_template_id (required, String) —

    A unique identifier for the task template.

  • :snapshot_version (String) —

    The system generated version of a task template that is associated with a task, when the task is created.

Returns:

See Also:



15111
15112
15113
15114
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15111

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

#get_test_case_execution_summary(params = {}) ⇒ Types::GetTestCaseExecutionSummaryResponse

Retrieves an overview of a test execution that includes the status of the execution, start and end time, and observation summary.

Examples:

Request syntax with placeholder values


resp = client.get_test_case_execution_summary({
  instance_id: "InstanceId", # required
  test_case_id: "TestCaseId", # required
  test_case_execution_id: "TestCaseExecutionId", # required
})

Response structure


resp.start_time #=> Time
resp.end_time #=> Time
resp.status #=> String, one of "INITIATED", "PASSED", "FAILED", "IN_PROGRESS", "STOPPED"
resp.observation_summary.total_observations #=> Integer
resp.observation_summary.observations_passed #=> Integer
resp.observation_summary.observations_failed #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance.

  • :test_case_id (required, String) —

    The identifier of the test case.

  • :test_case_execution_id (required, String) —

    The identifier of the test case execution.

Returns:

See Also:



15156
15157
15158
15159
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15156

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

#get_traffic_distribution(params = {}) ⇒ Types::GetTrafficDistributionResponse

Retrieves the current traffic distribution for a given traffic distribution group.

Examples:

Request syntax with placeholder values


resp = client.get_traffic_distribution({
  id: "TrafficDistributionGroupIdOrArn", # required
})

Response structure


resp.telephony_config.distributions #=> Array
resp.telephony_config.distributions[0].region #=> String
resp.telephony_config.distributions[0].percentage #=> Integer
resp.id #=> String
resp.arn #=> String
resp..distributions #=> Array
resp..distributions[0].region #=> String
resp..distributions[0].enabled #=> Boolean
resp.agent_config.distributions #=> Array
resp.agent_config.distributions[0].region #=> String
resp.agent_config.distributions[0].percentage #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

Returns:

See Also:



15202
15203
15204
15205
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15202

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

#import_phone_number(params = {}) ⇒ Types::ImportPhoneNumberResponse

Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Connect Customer instance. You can call this API only in the same Amazon Web Services Region where the Connect Customer instance was created.

Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation.

If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.

For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.

Examples:

Request syntax with placeholder values


resp = client.import_phone_number({
  instance_id: "InstanceId", # required
  source_phone_number_arn: "ARN", # required
  phone_number_description: "PhoneNumberDescription",
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken",
})

Response structure


resp.phone_number_id #=> String
resp.phone_number_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :source_phone_number_arn (required, String) —

    The claimed phone number ARN being imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number to import from Amazon Web Services End User Messaging.

  • :phone_number_description (String) —

    The description of the phone number.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



15299
15300
15301
15302
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15299

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

#import_workspace_media(params = {}) ⇒ Struct

Imports a media asset (such as a logo) for use in a workspace.

Examples:

Request syntax with placeholder values


resp = client.import_workspace_media({
  instance_id: "InstanceId", # required
  workspace_id: "WorkspaceId", # required
  media_type: "IMAGE_LOGO_LIGHT_FAVICON", # required, accepts IMAGE_LOGO_LIGHT_FAVICON, IMAGE_LOGO_DARK_FAVICON, IMAGE_LOGO_LIGHT_HORIZONTAL, IMAGE_LOGO_DARK_HORIZONTAL
  media_source: "MediaSource", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :workspace_id (required, String) —

    The identifier of the workspace.

  • :media_type (required, String) —

    The type of media. Valid values are: IMAGE_LOGO_FAVICON and IMAGE_LOGO_HORIZONTAL.

  • :media_source (required, String) —

    The media source. Can be an S3 presigned URL or a base64-encoded string.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



15340
15341
15342
15343
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15340

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

#list_agent_statuses(params = {}) ⇒ Types::ListAgentStatusResponse

Lists agent statuses.

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

Examples:

Request syntax with placeholder values


resp = client.list_agent_statuses({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
  agent_status_types: ["ROUTABLE"], # accepts ROUTABLE, CUSTOM, OFFLINE
})

Response structure


resp.next_token #=> String
resp.agent_status_summary_list #=> Array
resp.agent_status_summary_list[0].id #=> String
resp.agent_status_summary_list[0].arn #=> String
resp.agent_status_summary_list[0].name #=> String
resp.agent_status_summary_list[0].type #=> String, one of "ROUTABLE", "CUSTOM", "OFFLINE"
resp.agent_status_summary_list[0].last_modified_time #=> Time
resp.agent_status_summary_list[0].last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :agent_status_types (Array<String>) —

    Available agent status types.

Returns:

See Also:



15397
15398
15399
15400
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15397

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

#list_analytics_data_associations(params = {}) ⇒ Types::ListAnalyticsDataAssociationsResponse

Lists the association status of requested dataset ID for a given Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.list_analytics_data_associations({
  instance_id: "InstanceId", # required
  data_set_id: "DataSetId",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.results #=> Array
resp.results[0].data_set_id #=> String
resp.results[0]. #=> String
resp.results[0].resource_share_id #=> String
resp.results[0].resource_share_arn #=> String
resp.results[0].resource_share_status #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :data_set_id (String) —

    The identifier of the dataset to get the association status.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



15452
15453
15454
15455
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15452

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

#list_analytics_data_lake_data_sets(params = {}) ⇒ Types::ListAnalyticsDataLakeDataSetsResponse

Lists the data lake datasets available to associate with for a given Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.list_analytics_data_lake_data_sets({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.results #=> Array
resp.results[0].data_set_id #=> String
resp.results[0].data_set_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



15500
15501
15502
15503
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15500

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

#list_approved_origins(params = {}) ⇒ Types::ListApprovedOriginsResponse

This API is in preview release for Connect Customer and is subject to change.

Returns a paginated list of all approved origins associated with the instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_approved_origins({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



15552
15553
15554
15555
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15552

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

#list_associated_contacts(params = {}) ⇒ Types::ListAssociatedContactsResponse

Provides information about contact tree, a list of associated contacts with a unique identifier.

Examples:

Request syntax with placeholder values


resp = client.list_associated_contacts({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.contact_summary_list #=> Array
resp.contact_summary_list[0].contact_id #=> String
resp.contact_summary_list[0].contact_arn #=> String
resp.contact_summary_list[0].initiation_timestamp #=> Time
resp.contact_summary_list[0].disconnect_timestamp #=> Time
resp.contact_summary_list[0].initial_contact_id #=> String
resp.contact_summary_list[0].previous_contact_id #=> String
resp.contact_summary_list[0].related_contact_id #=> String
resp.contact_summary_list[0].initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR", "EXTERNAL_OUTBOUND", "WEBRTC_API", "AGENT_REPLY", "FLOW"
resp.contact_summary_list[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



15611
15612
15613
15614
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15611

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

#list_attached_files_configurations(params = {}) ⇒ Types::ListAttachedFilesConfigurationsResponse

Provides summary information about the attached files configurations for the specified Connect Customer instance.

This API returns effective configurations (custom overrides or defaults) for each attachment scope. If no custom configuration exists for a scope, the default configuration values are returned.

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

Examples:

Request syntax with placeholder values


resp = client.list_attached_files_configurations({
  instance_id: "InstanceId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.attached_files_configurations #=> Array
resp.attached_files_configurations[0].instance_id #=> String
resp.attached_files_configurations[0].attachment_scope #=> String, one of "EMAIL", "CHAT", "CASE", "TASK"
resp.attached_files_configurations[0].maximum_size_limit_in_bytes #=> Integer
resp.attached_files_configurations[0].extension_configuration.allowed_extensions #=> Array
resp.attached_files_configurations[0].extension_configuration.allowed_extensions[0].extension #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



15669
15670
15671
15672
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15669

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

#list_authentication_profiles(params = {}) ⇒ Types::ListAuthenticationProfilesResponse

This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support.

Provides summary information about the authentication profiles in a specified Connect Customer instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_authentication_profiles({
  instance_id: "InstanceId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.authentication_profile_summary_list #=> Array
resp.authentication_profile_summary_list[0].id #=> String
resp.authentication_profile_summary_list[0].arn #=> String
resp.authentication_profile_summary_list[0].name #=> String
resp.authentication_profile_summary_list[0].is_default #=> Boolean
resp.authentication_profile_summary_list[0].last_modified_time #=> Time
resp.authentication_profile_summary_list[0].last_modified_region #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



15727
15728
15729
15730
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15727

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

#list_bots(params = {}) ⇒ Types::ListBotsResponse

This API is in preview release for Connect Customer and is subject to change.

For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to return both Amazon Lex V1 and V2 bots.

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

Examples:

Request syntax with placeholder values


resp = client.list_bots({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
  lex_version: "V1", # required, accepts V1, V2
})

Response structure


resp.lex_bots #=> Array
resp.lex_bots[0].lex_bot.name #=> String
resp.lex_bots[0].lex_bot.lex_region #=> String
resp.lex_bots[0].lex_v2_bot.alias_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :lex_version (required, String) —

    The version of Amazon Lex or Amazon Lex V2.

Returns:

See Also:



15786
15787
15788
15789
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15786

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

#list_child_hours_of_operations(params = {}) ⇒ Types::ListChildHoursOfOperationsResponse

Provides information about the child hours of operations for the specified parent hours of operation.

For more information about child hours of operations, see Link overrides from different hours of operation in the Administrator Guide.

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

Examples:

Request syntax with placeholder values


resp = client.list_child_hours_of_operations({
  instance_id: "InstanceId", # required
  hours_of_operation_id: "HoursOfOperationId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.child_hours_of_operations_summary_list #=> Array
resp.child_hours_of_operations_summary_list[0].name #=> String
resp.child_hours_of_operations_summary_list[0].id #=> String
resp.child_hours_of_operations_summary_list[0].arn #=> String
resp.last_modified_time #=> Time
resp.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :hours_of_operation_id (required, String) —

    The identifier of the parent hours of operation.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



15854
15855
15856
15857
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15854

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

#list_contact_evaluations(params = {}) ⇒ Types::ListContactEvaluationsResponse

Lists contact evaluations in the specified Connect Customer instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_contact_evaluations({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  next_token: "NextToken",
})

Response structure


resp.evaluation_summary_list #=> Array
resp.evaluation_summary_list[0].evaluation_id #=> String
resp.evaluation_summary_list[0].evaluation_arn #=> String
resp.evaluation_summary_list[0].evaluation_form_title #=> String
resp.evaluation_summary_list[0].evaluation_form_id #=> String
resp.evaluation_summary_list[0].calibration_session_id #=> String
resp.evaluation_summary_list[0].status #=> String, one of "DRAFT", "SUBMITTED", "REVIEW_REQUESTED", "UNDER_REVIEW"
resp.evaluation_summary_list[0].auto_evaluation_enabled #=> Boolean
resp.evaluation_summary_list[0].auto_evaluation_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED"
resp.evaluation_summary_list[0].evaluator_arn #=> String
resp.evaluation_summary_list[0].score.percentage #=> Float
resp.evaluation_summary_list[0].score.not_applicable #=> Boolean
resp.evaluation_summary_list[0].score.automatic_fail #=> Boolean
resp.evaluation_summary_list[0].score.applied_weight #=> Float
resp.evaluation_summary_list[0].score.earned_points #=> Integer
resp.evaluation_summary_list[0].score.max_base_point #=> Integer
resp.evaluation_summary_list[0].score.performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
resp.evaluation_summary_list[0].acknowledgement.acknowledged_time #=> Time
resp.evaluation_summary_list[0].acknowledgement.acknowledged_by #=> String
resp.evaluation_summary_list[0].acknowledgement.acknowledger_comment #=> String
resp.evaluation_summary_list[0].evaluation_type #=> String, one of "STANDARD", "CALIBRATION"
resp.evaluation_summary_list[0].created_time #=> Time
resp.evaluation_summary_list[0].last_modified_time #=> Time
resp.evaluation_summary_list[0].contact_participant.contact_participant_role #=> String, one of "AGENT", "SYSTEM", "CUSTOM_BOT", "CUSTOMER"
resp.evaluation_summary_list[0].contact_participant.contact_participant_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    This is not expected to be set because the value returned in the previous response is always null.

Returns:

See Also:



15928
15929
15930
15931
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15928

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

#list_contact_flow_module_aliases(params = {}) ⇒ Types::ListContactFlowModuleAliasesResponse

Lists all aliases associated with a contact flow module, showing their current version mappings and metadata.

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

Examples:

Request syntax with placeholder values


resp = client.list_contact_flow_module_aliases({
  instance_id: "InstanceIdOrArn", # required
  contact_flow_module_id: "ARN", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.contact_flow_module_alias_summary_list #=> Array
resp.contact_flow_module_alias_summary_list[0].arn #=> String
resp.contact_flow_module_alias_summary_list[0].alias_id #=> String
resp.contact_flow_module_alias_summary_list[0].version #=> Integer
resp.contact_flow_module_alias_summary_list[0].alias_name #=> String
resp.contact_flow_module_alias_summary_list[0].alias_description #=> String
resp.contact_flow_module_alias_summary_list[0].last_modified_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_module_id (required, String) —

    The identifier of the flow module.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



15986
15987
15988
15989
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15986

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

#list_contact_flow_module_versions(params = {}) ⇒ Types::ListContactFlowModuleVersionsResponse

Retrieves a paginated list of all versions for a specific contact flow module.

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

Examples:

Request syntax with placeholder values


resp = client.list_contact_flow_module_versions({
  instance_id: "InstanceId", # required
  contact_flow_module_id: "ARN", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.contact_flow_module_version_summary_list #=> Array
resp.contact_flow_module_version_summary_list[0].arn #=> String
resp.contact_flow_module_version_summary_list[0].version_description #=> String
resp.contact_flow_module_version_summary_list[0].version #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_module_id (required, String) —

    The identifier of the flow module.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



16041
16042
16043
16044
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16041

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

#list_contact_flow_modules(params = {}) ⇒ Types::ListContactFlowModulesResponse

Provides information about the flow modules for the specified Connect Customer instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_contact_flow_modules({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
  contact_flow_module_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
})

Response structure


resp.contact_flow_modules_summary_list #=> Array
resp.contact_flow_modules_summary_list[0].id #=> String
resp.contact_flow_modules_summary_list[0].arn #=> String
resp.contact_flow_modules_summary_list[0].name #=> String
resp.contact_flow_modules_summary_list[0].state #=> String, one of "ACTIVE", "ARCHIVED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :contact_flow_module_state (String) —

    The state of the flow module.

Returns:

See Also:



16097
16098
16099
16100
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16097

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

#list_contact_flow_versions(params = {}) ⇒ Types::ListContactFlowVersionsResponse

Returns all the available versions for the specified Connect Customer instance and flow identifier.

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

Examples:

Request syntax with placeholder values


resp = client.list_contact_flow_versions({
  instance_id: "InstanceId", # required
  contact_flow_id: "ARN", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.contact_flow_version_summary_list #=> Array
resp.contact_flow_version_summary_list[0].arn #=> String
resp.contact_flow_version_summary_list[0].version_description #=> String
resp.contact_flow_version_summary_list[0].version #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance.

  • :contact_flow_id (required, String) —

    The identifier of the flow.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



16148
16149
16150
16151
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16148

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

#list_contact_flows(params = {}) ⇒ Types::ListContactFlowsResponse

Provides information about the flows for the specified Connect Customer instance.

You can also create and update flows using the Connect Customer Flow language.

For more information about flows, see Flows in the Connect Customer Administrator Guide.

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

Examples:

Request syntax with placeholder values


resp = client.list_contact_flows({
  instance_id: "InstanceId", # required
  contact_flow_types: ["CONTACT_FLOW"], # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER, CAMPAIGN
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.contact_flow_summary_list #=> Array
resp.contact_flow_summary_list[0].id #=> String
resp.contact_flow_summary_list[0].arn #=> String
resp.contact_flow_summary_list[0].name #=> String
resp.contact_flow_summary_list[0].contact_flow_type #=> String, one of "CONTACT_FLOW", "CUSTOMER_QUEUE", "CUSTOMER_HOLD", "CUSTOMER_WHISPER", "AGENT_HOLD", "AGENT_WHISPER", "OUTBOUND_WHISPER", "AGENT_TRANSFER", "QUEUE_TRANSFER", "CAMPAIGN"
resp.contact_flow_summary_list[0].contact_flow_state #=> String, one of "ACTIVE", "ARCHIVED"
resp.contact_flow_summary_list[0].contact_flow_status #=> String, one of "PUBLISHED", "SAVED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_types (Array<String>) —

    The type of flow.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



16218
16219
16220
16221
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16218

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

#list_contact_references(params = {}) ⇒ Types::ListContactReferencesResponse

This API is in preview release for Connect Customer and is subject to change.

For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.

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

Examples:

Request syntax with placeholder values


resp = client.list_contact_references({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  reference_types: ["URL"], # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT, EMAIL_MESSAGE_PLAIN_TEXT_REDACTED, EMAIL_MESSAGE_REDACTED
  next_token: "NextToken",
})

Response structure


resp.reference_summary_list #=> Array
resp.reference_summary_list[0].url.name #=> String
resp.reference_summary_list[0].url.value #=> String
resp.reference_summary_list[0].attachment.name #=> String
resp.reference_summary_list[0].attachment.value #=> String
resp.reference_summary_list[0].attachment.status #=> String, one of "AVAILABLE", "DELETED", "APPROVED", "REJECTED", "PROCESSING", "FAILED"
resp.reference_summary_list[0].attachment.arn #=> String
resp.reference_summary_list[0].email_message.name #=> String
resp.reference_summary_list[0].email_message.arn #=> String
resp.reference_summary_list[0].email_message_redacted.name #=> String
resp.reference_summary_list[0].email_message_redacted.arn #=> String
resp.reference_summary_list[0].email_message_plain_text.name #=> String
resp.reference_summary_list[0].email_message_plain_text.arn #=> String
resp.reference_summary_list[0].email_message_plain_text_redacted.name #=> String
resp.reference_summary_list[0].email_message_plain_text_redacted.arn #=> String
resp.reference_summary_list[0].string.name #=> String
resp.reference_summary_list[0].string.value #=> String
resp.reference_summary_list[0].number.name #=> String
resp.reference_summary_list[0].number.value #=> String
resp.reference_summary_list[0].date.name #=> String
resp.reference_summary_list[0].date.value #=> String
resp.reference_summary_list[0].email.name #=> String
resp.reference_summary_list[0].email.value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the initial contact.

  • :reference_types (required, Array<String>) —

    The type of reference.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    This is not expected to be set, because the value returned in the previous response is always null.

Returns:

See Also:



16299
16300
16301
16302
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16299

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

#list_data_table_attributes(params = {}) ⇒ Types::ListDataTableAttributesResponse

Returns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using Amazon Web Services Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.

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

Examples:

Request syntax with placeholder values


resp = client.list_data_table_attributes({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
  attribute_ids: ["DataTableId"],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.attributes #=> Array
resp.attributes[0].attribute_id #=> String
resp.attributes[0].name #=> String
resp.attributes[0].value_type #=> String, one of "TEXT", "NUMBER", "BOOLEAN", "TEXT_LIST", "NUMBER_LIST"
resp.attributes[0].description #=> String
resp.attributes[0].data_table_id #=> String
resp.attributes[0].data_table_arn #=> String
resp.attributes[0].primary #=> Boolean
resp.attributes[0].version #=> String
resp.attributes[0].lock_version.data_table #=> String
resp.attributes[0].lock_version.attribute #=> String
resp.attributes[0].lock_version.primary_values #=> String
resp.attributes[0].lock_version.value #=> String
resp.attributes[0].last_modified_time #=> Time
resp.attributes[0].last_modified_region #=> String
resp.attributes[0].validation.min_length #=> Integer
resp.attributes[0].validation.max_length #=> Integer
resp.attributes[0].validation.min_values #=> Integer
resp.attributes[0].validation.max_values #=> Integer
resp.attributes[0].validation.ignore_case #=> Boolean
resp.attributes[0].validation.minimum #=> Float
resp.attributes[0].validation.maximum #=> Float
resp.attributes[0].validation.exclusive_minimum #=> Float
resp.attributes[0].validation.exclusive_maximum #=> Float
resp.attributes[0].validation.multiple_of #=> Float
resp.attributes[0].validation.enum.strict #=> Boolean
resp.attributes[0].validation.enum.values #=> Array
resp.attributes[0].validation.enum.values[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table whose attributes should be listed.

  • :attribute_ids (Array<String>) —

    Optional list of specific attribute IDs to retrieve. Used for CloudFormation to effectively describe attributes by ID. If NextToken is provided, this parameter is ignored.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of data table attributes to return in one page of results.

Returns:

See Also:



16382
16383
16384
16385
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16382

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

#list_data_table_primary_values(params = {}) ⇒ Types::ListDataTablePrimaryValuesResponse

Lists all primary value combinations for a given data table. Returns the unique combinations of primary attribute values that identify records in the table. Up to 100 records are returned per request.

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

Examples:

Request syntax with placeholder values


resp = client.list_data_table_primary_values({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
  record_ids: ["DataTableId"],
  primary_attribute_values: [
    {
      attribute_name: "DataTableName", # required
      values: ["String"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.primary_values_list #=> Array
resp.primary_values_list[0].record_id #=> String
resp.primary_values_list[0].primary_values #=> Array
resp.primary_values_list[0].primary_values[0].attribute_name #=> String
resp.primary_values_list[0].primary_values[0].attribute_id #=> String
resp.primary_values_list[0].primary_values[0].value #=> String
resp.primary_values_list[0].last_modified_time #=> Time
resp.primary_values_list[0].last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table whose primary values should be listed.

  • :record_ids (Array<String>) —

    Optional list of specific record IDs to retrieve. Used for CloudFormation to effectively describe records by ID. If NextToken is provided, this parameter is ignored.

  • :primary_attribute_values (Array<Types::PrimaryAttributeValueFilter>) —

    Optional filter to retrieve primary values matching specific criteria.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of data table primary values to return in one page of results.

Returns:

See Also:



16453
16454
16455
16456
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16453

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

#list_data_table_values(params = {}) ⇒ Types::ListDataTableValuesResponse

Lists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such as lock versions and modification timestamps.

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

Examples:

Request syntax with placeholder values


resp = client.list_data_table_values({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
  record_ids: ["DataTableId"],
  primary_attribute_values: [
    {
      attribute_name: "DataTableName", # required
      values: ["String"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.values #=> Array
resp.values[0].record_id #=> String
resp.values[0].attribute_id #=> String
resp.values[0].primary_values #=> Array
resp.values[0].primary_values[0].attribute_name #=> String
resp.values[0].primary_values[0].attribute_id #=> String
resp.values[0].primary_values[0].value #=> String
resp.values[0].attribute_name #=> String
resp.values[0].value_type #=> String, one of "TEXT", "NUMBER", "BOOLEAN", "TEXT_LIST", "NUMBER_LIST"
resp.values[0].value #=> String
resp.values[0].lock_version.data_table #=> String
resp.values[0].lock_version.attribute #=> String
resp.values[0].lock_version.primary_values #=> String
resp.values[0].lock_version.value #=> String
resp.values[0].last_modified_time #=> Time
resp.values[0].last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table whose values should be listed.

  • :record_ids (Array<String>) —

    Optional list of specific record IDs to retrieve values for.

  • :primary_attribute_values (Array<Types::PrimaryAttributeValueFilter>) —

    Optional filter to retrieve values for records matching specific primary attribute criteria.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of data table values to return in one page of results.

Returns:

See Also:



16531
16532
16533
16534
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16531

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

#list_data_tables(params = {}) ⇒ Types::ListDataTablesResponse

Lists all data tables for the specified Amazon Connect instance. Returns summary information for each table including basic metadata and modification details.

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

Examples:

Request syntax with placeholder values


resp = client.list_data_tables({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.data_table_summary_list #=> Array
resp.data_table_summary_list[0].name #=> String
resp.data_table_summary_list[0].id #=> String
resp.data_table_summary_list[0].arn #=> String
resp.data_table_summary_list[0].last_modified_time #=> Time
resp.data_table_summary_list[0].last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance whose data tables should be listed.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of data tables to return in one page of results.

Returns:

See Also:



16580
16581
16582
16583
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16580

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

#list_default_vocabularies(params = {}) ⇒ Types::ListDefaultVocabulariesResponse

Lists the default vocabularies for the specified Connect Customer instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_default_vocabularies({
  instance_id: "InstanceId", # required
  language_code: "ar-AE", # accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA, ca-ES, da-DK, fi-FI, id-ID, ms-MY, nl-NL, no-NO, pl-PL, sv-SE, tl-PH
  max_results: 1,
  next_token: "VocabularyNextToken",
})

Response structure


resp.default_vocabulary_list #=> Array
resp.default_vocabulary_list[0].instance_id #=> String
resp.default_vocabulary_list[0].language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN", "en-NZ", "en-ZA", "ca-ES", "da-DK", "fi-FI", "id-ID", "ms-MY", "nl-NL", "no-NO", "pl-PL", "sv-SE", "tl-PH"
resp.default_vocabulary_list[0].vocabulary_id #=> String
resp.default_vocabulary_list[0].vocabulary_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :language_code (String) —

    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



16642
16643
16644
16645
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16642

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

#list_entity_security_profiles(params = {}) ⇒ Types::ListEntitySecurityProfilesResponse

Lists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_entity_security_profiles({
  instance_id: "InstanceId", # required
  entity_type: "USER", # required, accepts USER, AI_AGENT
  entity_arn: "EntityArn", # required
  next_token: "NextToken2500",
  max_results: 1,
})

Response structure


resp.security_profiles #=> Array
resp.security_profiles[0].id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :entity_type (required, String) —

    Only supported type is AI_AGENT.

  • :entity_arn (required, String) —

    ARN of a Q in Connect AI Agent.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



16696
16697
16698
16699
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16696

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

#list_evaluation_form_versions(params = {}) ⇒ Types::ListEvaluationFormVersionsResponse

Lists versions of an evaluation form in the specified Connect Customer instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_evaluation_form_versions({
  instance_id: "InstanceId", # required
  evaluation_form_id: "ResourceId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.evaluation_form_version_summary_list #=> Array
resp.evaluation_form_version_summary_list[0].evaluation_form_arn #=> String
resp.evaluation_form_version_summary_list[0].evaluation_form_id #=> String
resp.evaluation_form_version_summary_list[0].evaluation_form_version #=> Integer
resp.evaluation_form_version_summary_list[0].locked #=> Boolean
resp.evaluation_form_version_summary_list[0].status #=> String, one of "DRAFT", "ACTIVE"
resp.evaluation_form_version_summary_list[0].created_time #=> Time
resp.evaluation_form_version_summary_list[0].created_by #=> String
resp.evaluation_form_version_summary_list[0].last_modified_time #=> Time
resp.evaluation_form_version_summary_list[0].last_modified_by #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :evaluation_form_id (required, String) —

    The unique identifier for the evaluation form.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



16757
16758
16759
16760
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16757

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

#list_evaluation_forms(params = {}) ⇒ Types::ListEvaluationFormsResponse

Lists evaluation forms in the specified Connect Customer instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_evaluation_forms({
  instance_id: "InstanceId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.evaluation_form_summary_list #=> Array
resp.evaluation_form_summary_list[0].evaluation_form_id #=> String
resp.evaluation_form_summary_list[0].evaluation_form_arn #=> String
resp.evaluation_form_summary_list[0].title #=> String
resp.evaluation_form_summary_list[0].created_time #=> Time
resp.evaluation_form_summary_list[0].created_by #=> String
resp.evaluation_form_summary_list[0].last_modified_time #=> Time
resp.evaluation_form_summary_list[0].last_modified_by #=> String
resp.evaluation_form_summary_list[0].last_activated_time #=> Time
resp.evaluation_form_summary_list[0].last_activated_by #=> String
resp.evaluation_form_summary_list[0].latest_version #=> Integer
resp.evaluation_form_summary_list[0].active_version #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



16815
16816
16817
16818
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16815

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

#list_flow_associations(params = {}) ⇒ Types::ListFlowAssociationsResponse

List the flow association based on the filters.

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

Examples:

Request syntax with placeholder values


resp = client.list_flow_associations({
  instance_id: "InstanceId", # required
  resource_type: "WHATSAPP_MESSAGING_PHONE_NUMBER", # accepts WHATSAPP_MESSAGING_PHONE_NUMBER, VOICE_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL, ANALYTICS_CONNECTOR
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.flow_association_summary_list #=> Array
resp.flow_association_summary_list[0].resource_id #=> String
resp.flow_association_summary_list[0].flow_id #=> String
resp.flow_association_summary_list[0].resource_type #=> String, one of "WHATSAPP_MESSAGING_PHONE_NUMBER", "VOICE_PHONE_NUMBER", "INBOUND_EMAIL", "OUTBOUND_EMAIL", "ANALYTICS_CONNECTOR"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :resource_type (String) —

    A valid resource type.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



16869
16870
16871
16872
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16869

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

#list_hours_of_operation_overrides(params = {}) ⇒ Types::ListHoursOfOperationOverridesResponse

List the hours of operation overrides.

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

Examples:

Request syntax with placeholder values


resp = client.list_hours_of_operation_overrides({
  instance_id: "InstanceId", # required
  hours_of_operation_id: "HoursOfOperationId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.hours_of_operation_override_list #=> Array
resp.hours_of_operation_override_list[0].hours_of_operation_override_id #=> String
resp.hours_of_operation_override_list[0].hours_of_operation_id #=> String
resp.hours_of_operation_override_list[0].hours_of_operation_arn #=> String
resp.hours_of_operation_override_list[0].name #=> String
resp.hours_of_operation_override_list[0].description #=> String
resp.hours_of_operation_override_list[0].config #=> Array
resp.hours_of_operation_override_list[0].config[0].day #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
resp.hours_of_operation_override_list[0].config[0].start_time.hours #=> Integer
resp.hours_of_operation_override_list[0].config[0].start_time.minutes #=> Integer
resp.hours_of_operation_override_list[0].config[0].end_time.hours #=> Integer
resp.hours_of_operation_override_list[0].config[0].end_time.minutes #=> Integer
resp.hours_of_operation_override_list[0].effective_from #=> String
resp.hours_of_operation_override_list[0].effective_till #=> String
resp.hours_of_operation_override_list[0].recurrence_config.recurrence_pattern.frequency #=> String, one of "WEEKLY", "MONTHLY", "YEARLY"
resp.hours_of_operation_override_list[0].recurrence_config.recurrence_pattern.interval #=> Integer
resp.hours_of_operation_override_list[0].recurrence_config.recurrence_pattern.by_month #=> Array
resp.hours_of_operation_override_list[0].recurrence_config.recurrence_pattern.by_month[0] #=> Integer
resp.hours_of_operation_override_list[0].recurrence_config.recurrence_pattern.by_month_day #=> Array
resp.hours_of_operation_override_list[0].recurrence_config.recurrence_pattern.by_month_day[0] #=> Integer
resp.hours_of_operation_override_list[0].recurrence_config.recurrence_pattern.by_weekday_occurrence #=> Array
resp.hours_of_operation_override_list[0].recurrence_config.recurrence_pattern.by_weekday_occurrence[0] #=> Integer
resp.hours_of_operation_override_list[0].override_type #=> String, one of "STANDARD", "OPEN", "CLOSED"
resp.last_modified_region #=> String
resp.last_modified_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance.

  • :hours_of_operation_id (required, String) —

    The identifier for the hours of operation.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



16941
16942
16943
16944
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16941

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

#list_hours_of_operations(params = {}) ⇒ Types::ListHoursOfOperationsResponse

Provides information about the hours of operation for the specified Connect Customer instance.

For more information about hours of operation, see Set the Hours of Operation for a Queue in the Connect Customer Administrator Guide.

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

Examples:

Request syntax with placeholder values


resp = client.list_hours_of_operations({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.hours_of_operation_summary_list #=> Array
resp.hours_of_operation_summary_list[0].id #=> String
resp.hours_of_operation_summary_list[0].arn #=> String
resp.hours_of_operation_summary_list[0].name #=> String
resp.hours_of_operation_summary_list[0].last_modified_time #=> Time
resp.hours_of_operation_summary_list[0].last_modified_region #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



17003
17004
17005
17006
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17003

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

#list_instance_attributes(params = {}) ⇒ Types::ListInstanceAttributesResponse

This API is in preview release for Connect Customer and is subject to change.

Returns a paginated list of all attribute types for the given instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_instance_attributes({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.attributes #=> Array
resp.attributes[0].attribute_type #=> String, one of "INBOUND_CALLS", "OUTBOUND_CALLS", "CONTACTFLOW_LOGS", "CONTACT_LENS", "AUTO_RESOLVE_BEST_VOICES", "USE_CUSTOM_TTS_VOICES", "EARLY_MEDIA", "MULTI_PARTY_CONFERENCE", "HIGH_VOLUME_OUTBOUND", "ENHANCED_CONTACT_MONITORING", "ENHANCED_CHAT_MONITORING", "MULTI_PARTY_CHAT_CONFERENCE", "MESSAGE_STREAMING"
resp.attributes[0].value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



17056
17057
17058
17059
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17056

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

#list_instance_storage_configs(params = {}) ⇒ Types::ListInstanceStorageConfigsResponse

This API is in preview release for Connect Customer and is subject to change.

Returns a paginated list of storage configs for the identified instance and resource type.

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

Examples:

Request syntax with placeholder values


resp = client.list_instance_storage_configs({
  instance_id: "InstanceId", # required
  resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, ATTACHMENTS, CONTACT_EVALUATIONS, SCREEN_RECORDINGS, REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS, REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS, EMAIL_MESSAGES
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.storage_configs #=> Array
resp.storage_configs[0].association_id #=> String
resp.storage_configs[0].storage_type #=> String, one of "S3", "KINESIS_VIDEO_STREAM", "KINESIS_STREAM", "KINESIS_FIREHOSE"
resp.storage_configs[0].s3_config.bucket_name #=> String
resp.storage_configs[0].s3_config.bucket_prefix #=> String
resp.storage_configs[0].s3_config.encryption_config.encryption_type #=> String, one of "KMS"
resp.storage_configs[0].s3_config.encryption_config.key_id #=> String
resp.storage_configs[0].kinesis_video_stream_config.prefix #=> String
resp.storage_configs[0].kinesis_video_stream_config.retention_period_hours #=> Integer
resp.storage_configs[0].kinesis_video_stream_config.encryption_config.encryption_type #=> String, one of "KMS"
resp.storage_configs[0].kinesis_video_stream_config.encryption_config.key_id #=> String
resp.storage_configs[0].kinesis_stream_config.stream_arn #=> String
resp.storage_configs[0].kinesis_firehose_config.firehose_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :resource_type (required, String) —

    A valid resource type.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



17123
17124
17125
17126
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17123

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

#list_instances(params = {}) ⇒ Types::ListInstancesResponse

This API is in preview release for Connect Customer and is subject to change.

Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

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

Examples:

Request syntax with placeholder values


resp = client.list_instances({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.instance_summary_list #=> Array
resp.instance_summary_list[0].id #=> String
resp.instance_summary_list[0].arn #=> String
resp.instance_summary_list[0].identity_management_type #=> String, one of "SAML", "CONNECT_MANAGED", "EXISTING_DIRECTORY"
resp.instance_summary_list[0].instance_alias #=> String
resp.instance_summary_list[0].created_time #=> Time
resp.instance_summary_list[0].service_role #=> String
resp.instance_summary_list[0].instance_status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED"
resp.instance_summary_list[0].inbound_calls_enabled #=> Boolean
resp.instance_summary_list[0].outbound_calls_enabled #=> Boolean
resp.instance_summary_list[0].instance_access_url #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



17177
17178
17179
17180
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17177

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

#list_integration_associations(params = {}) ⇒ Types::ListIntegrationAssociationsResponse

Provides summary information about the Amazon Web Services resource associations for the specified Connect Customer instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_integration_associations({
  instance_id: "InstanceId", # required
  integration_type: "EVENT", # accepts EVENT, VOICE_ID, PINPOINT_APP, WISDOM_ASSISTANT, WISDOM_KNOWLEDGE_BASE, WISDOM_QUICK_RESPONSES, Q_MESSAGE_TEMPLATES, CASES_DOMAIN, APPLICATION, FILE_SCANNER, SES_IDENTITY, ANALYTICS_CONNECTOR, CALL_TRANSFER_CONNECTOR, COGNITO_USER_POOL, MESSAGE_PROCESSOR
  next_token: "NextToken",
  max_results: 1,
  integration_arn: "ARN",
})

Response structure


resp.integration_association_summary_list #=> Array
resp.integration_association_summary_list[0].integration_association_id #=> String
resp.integration_association_summary_list[0].integration_association_arn #=> String
resp.integration_association_summary_list[0].instance_id #=> String
resp.integration_association_summary_list[0].integration_type #=> String, one of "EVENT", "VOICE_ID", "PINPOINT_APP", "WISDOM_ASSISTANT", "WISDOM_KNOWLEDGE_BASE", "WISDOM_QUICK_RESPONSES", "Q_MESSAGE_TEMPLATES", "CASES_DOMAIN", "APPLICATION", "FILE_SCANNER", "SES_IDENTITY", "ANALYTICS_CONNECTOR", "CALL_TRANSFER_CONNECTOR", "COGNITO_USER_POOL", "MESSAGE_PROCESSOR"
resp.integration_association_summary_list[0].integration_arn #=> String
resp.integration_association_summary_list[0].source_application_url #=> String
resp.integration_association_summary_list[0].source_application_name #=> String
resp.integration_association_summary_list[0].source_type #=> String, one of "SALESFORCE", "ZENDESK", "CASES"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :integration_type (String) —

    The integration type.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :integration_arn (String) —

    The Amazon Resource Name (ARN) of the integration.

Returns:

See Also:



17241
17242
17243
17244
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17241

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

#list_lambda_functions(params = {}) ⇒ Types::ListLambdaFunctionsResponse

This API is in preview release for Connect Customer and is subject to change.

Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.

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

Examples:

Request syntax with placeholder values


resp = client.list_lambda_functions({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



17293
17294
17295
17296
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17293

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

#list_lex_bots(params = {}) ⇒ Types::ListLexBotsResponse

This API is in preview release for Connect Customer and is subject to change.

Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.

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

Examples:

Request syntax with placeholder values


resp = client.list_lex_bots({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.lex_bots #=> Array
resp.lex_bots[0].name #=> String
resp.lex_bots[0].lex_region #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. If no value is specified, the default is 10.

Returns:

See Also:



17352
17353
17354
17355
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17352

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

#list_metrics(params = {}) ⇒ Types::ListMetricsResponse

Retrieves a paginated list of metric summaries for the specified Connect Customer instance. Use pagination to ensure that the operation returns quickly and successfully.

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

Examples:

Request syntax with placeholder values


resp = client.list_metrics({
  instance_id: "InstanceId", # required
  type: "AWS_MANAGED", # accepts AWS_MANAGED, CUSTOMER_MANAGED
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.metric_summary_list #=> Array
resp.metric_summary_list[0].arn #=> String
resp.metric_summary_list[0].id #=> String
resp.metric_summary_list[0].name #=> String
resp.metric_summary_list[0].status #=> String, one of "PUBLISHED", "SAVED"
resp.metric_summary_list[0].type #=> String, one of "AWS_MANAGED", "CUSTOMER_MANAGED"
resp.metric_summary_list[0].last_modified_region #=> String
resp.metric_summary_list[0].last_modified_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :type (String) —

    The type of metrics to list. Valid values: AWS_MANAGED | CUSTOMER_MANAGED.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



17413
17414
17415
17416
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17413

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

#list_notifications(params = {}) ⇒ Types::ListNotificationsResponse

Retrieves a paginated list of all notifications in the Amazon Connect instance.

Examples:

Request syntax with placeholder values


resp = client.list_notifications({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.notification_summary_list #=> Array
resp.notification_summary_list[0].content #=> Hash
resp.notification_summary_list[0].content["LocaleCode"] #=> String
resp.notification_summary_list[0].id #=> String
resp.notification_summary_list[0].arn #=> String
resp.notification_summary_list[0].priority #=> String, one of "URGENT", "HIGH", "LOW"
resp.notification_summary_list[0].recipients #=> Array
resp.notification_summary_list[0].recipients[0] #=> String
resp.notification_summary_list[0].last_modified_time #=> Time
resp.notification_summary_list[0].created_at #=> Time
resp.notification_summary_list[0].expires_at #=> Time
resp.notification_summary_list[0].last_modified_region #=> String
resp.notification_summary_list[0].tags #=> Hash
resp.notification_summary_list[0].tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. Valid range is 1-100.

Returns:

See Also:



17472
17473
17474
17475
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17472

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

#list_phone_numbers(params = {}) ⇒ Types::ListPhoneNumbersResponse

Provides information about the phone numbers for the specified Connect Customer instance.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Connect Customer Administrator Guide.

  • We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE or DID.

  • The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.

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

Examples:

Request syntax with placeholder values


resp = client.list_phone_numbers({
  instance_id: "InstanceId", # required
  phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID, SHORT_CODE
  phone_number_country_codes: ["AF"], # accepts AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.phone_number_summary_list #=> Array
resp.phone_number_summary_list[0].id #=> String
resp.phone_number_summary_list[0].arn #=> String
resp.phone_number_summary_list[0].phone_number #=> String
resp.phone_number_summary_list[0].phone_number_type #=> String, one of "TOLL_FREE", "DID", "UIFN", "SHARED", "THIRD_PARTY_TF", "THIRD_PARTY_DID", "SHORT_CODE"
resp.phone_number_summary_list[0].phone_number_country_code #=> String, one of "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BR", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CK", "CR", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "TL", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "PF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "KP", "MP", "NO", "OM", "PK", "PW", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "CG", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "KR", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "VI", "UG", "UA", "AE", "GB", "US", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :phone_number_types (Array<String>) —

    The type of phone number.

    We recommend using ListPhoneNumbersV2 to return phone number types. While ListPhoneNumbers returns number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID, it incorrectly lists them as TOLL_FREE or DID.

  • :phone_number_country_codes (Array<String>) —

    The ISO country code.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



17567
17568
17569
17570
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17567

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

#list_phone_numbers_v2(params = {}) ⇒ Types::ListPhoneNumbersV2Response

Lists phone numbers claimed to your Connect Customer instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Connect Customer Administrator Guide.

* When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.

  • When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.

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

Examples:

Request syntax with placeholder values


resp = client.list_phone_numbers_v2({
  target_arn: "ARN",
  instance_id: "InstanceId",
  max_results: 1,
  next_token: "LargeNextToken",
  phone_number_country_codes: ["AF"], # accepts AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
  phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID, SHORT_CODE
  phone_number_prefix: "PhoneNumberPrefix",
})

Response structure


resp.next_token #=> String
resp.list_phone_numbers_summary_list #=> Array
resp.list_phone_numbers_summary_list[0].phone_number_id #=> String
resp.list_phone_numbers_summary_list[0].phone_number_arn #=> String
resp.list_phone_numbers_summary_list[0].phone_number #=> String
resp.list_phone_numbers_summary_list[0].phone_number_country_code #=> String, one of "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BR", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CK", "CR", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "TL", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "PF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "KP", "MP", "NO", "OM", "PK", "PW", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "CG", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "KR", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "VI", "UG", "UA", "AE", "GB", "US", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW"
resp.list_phone_numbers_summary_list[0].phone_number_type #=> String, one of "TOLL_FREE", "DID", "UIFN", "SHARED", "THIRD_PARTY_TF", "THIRD_PARTY_DID", "SHORT_CODE"
resp.list_phone_numbers_summary_list[0].target_arn #=> String
resp.list_phone_numbers_summary_list[0].instance_id #=> String
resp.list_phone_numbers_summary_list[0].phone_number_description #=> String
resp.list_phone_numbers_summary_list[0].source_phone_number_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :target_arn (String) —

    The Amazon Resource Name (ARN) for Connect Customer instances or traffic distribution groups that phone number inbound traffic is routed through. If both TargetArn and InstanceId input are not provided, this API lists numbers claimed to all the Connect Customer instances belonging to your account in the same Amazon Web Services Region as the request.

  • :instance_id (String) —

    The identifier of the Connect Customer instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. If both TargetArn and InstanceId are not provided, this API lists numbers claimed to all the Connect Customer instances belonging to your account in the same Amazon Web Services Region as the request.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :phone_number_country_codes (Array<String>) —

    The ISO country code.

  • :phone_number_types (Array<String>) —

    The type of phone number.

  • :phone_number_prefix (String) —

    The prefix of the phone number. If provided, it must contain + as part of the country code.

Returns:

See Also:



17669
17670
17671
17672
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17669

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

#list_predefined_attributes(params = {}) ⇒ Types::ListPredefinedAttributesResponse

Lists predefined attributes for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for:

For the predefined attributes per instance quota, see Connect Customer quotas.

Endpoints: See Connect Customer endpoints and quotas.

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

Examples:

Request syntax with placeholder values


resp = client.list_predefined_attributes({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.predefined_attribute_summary_list #=> Array
resp.predefined_attribute_summary_list[0].name #=> String
resp.predefined_attribute_summary_list[0].last_modified_time #=> Time
resp.predefined_attribute_summary_list[0].last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



17738
17739
17740
17741
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17738

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

#list_prompts(params = {}) ⇒ Types::ListPromptsResponse

Provides information about the prompts for the specified Connect Customer instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_prompts({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.prompt_summary_list #=> Array
resp.prompt_summary_list[0].id #=> String
resp.prompt_summary_list[0].arn #=> String
resp.prompt_summary_list[0].name #=> String
resp.prompt_summary_list[0].last_modified_time #=> Time
resp.prompt_summary_list[0].last_modified_region #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



17787
17788
17789
17790
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17787

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

#list_queue_email_addresses(params = {}) ⇒ Types::ListQueueEmailAddressesResponse

Lists all email addresses that are currently associated with a specific queue, providing details about which "From" email addresses agents can select when handling email contacts. This helps administrators manage agent email address options and understand the available choices for different brands and business units.

Important things to know

  • The response includes metadata about each email address available for agent selection, including whether it's configured as the default outbound email.

  • Agents can select from these email addresses when replying to inbound contacts or initiating outbound contacts in this queue.

  • The list includes both explicitly associated email addresses and any default outbound email address configured for the queue.

  • Results are paginated to handle queues with many associated email addresses (up to 50 per queue).

Examples:

Request syntax with placeholder values


resp = client.list_queue_email_addresses({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.email_address_metadata_list #=> Array
resp.email_address_metadata_list[0].id #=> String
resp.email_address_metadata_list[0].arn #=> String
resp.email_address_metadata_list[0].is_default_outbound_email #=> Boolean
resp.last_modified_time #=> Time
resp.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :queue_id (required, String) —

    The identifier for the queue.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



17862
17863
17864
17865
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17862

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

#list_queue_quick_connects(params = {}) ⇒ Types::ListQueueQuickConnectsResponse

Lists the quick connects associated with a queue.

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

Examples:

Request syntax with placeholder values


resp = client.list_queue_quick_connects({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.quick_connect_summary_list #=> Array
resp.quick_connect_summary_list[0].id #=> String
resp.quick_connect_summary_list[0].arn #=> String
resp.quick_connect_summary_list[0].name #=> String
resp.quick_connect_summary_list[0].quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER", "FLOW"
resp.quick_connect_summary_list[0].last_modified_time #=> Time
resp.quick_connect_summary_list[0].last_modified_region #=> String
resp.last_modified_time #=> Time
resp.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :queue_id (required, String) —

    The identifier for the queue.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



17924
17925
17926
17927
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17924

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

#list_queues(params = {}) ⇒ Types::ListQueuesResponse

Provides information about the queues for the specified Connect Customer instance.

If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.

For more information about queues, see Queues: Standard and Agent in the Connect Customer Administrator Guide.

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

Examples:

Request syntax with placeholder values


resp = client.list_queues({
  instance_id: "InstanceId", # required
  queue_types: ["STANDARD"], # accepts STANDARD, AGENT
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.queue_summary_list #=> Array
resp.queue_summary_list[0].id #=> String
resp.queue_summary_list[0].arn #=> String
resp.queue_summary_list[0].name #=> String
resp.queue_summary_list[0].queue_type #=> String, one of "STANDARD", "AGENT"
resp.queue_summary_list[0].last_modified_time #=> Time
resp.queue_summary_list[0].last_modified_region #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :queue_types (Array<String>) —

    The type of queue.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



17995
17996
17997
17998
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17995

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

#list_quick_connects(params = {}) ⇒ Types::ListQuickConnectsResponse

Provides information about the quick connects for the specified Connect Customer instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_quick_connects({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
  quick_connect_types: ["USER"], # accepts USER, QUEUE, PHONE_NUMBER, FLOW
})

Response structure


resp.quick_connect_summary_list #=> Array
resp.quick_connect_summary_list[0].id #=> String
resp.quick_connect_summary_list[0].arn #=> String
resp.quick_connect_summary_list[0].name #=> String
resp.quick_connect_summary_list[0].quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER", "FLOW"
resp.quick_connect_summary_list[0].last_modified_time #=> Time
resp.quick_connect_summary_list[0].last_modified_region #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Both Instance ID and Instance ARN are supported input formats.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

  • :quick_connect_types (Array<String>) —

    The type of quick connect. In the Connect Customer admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

Returns:

See Also:



18058
18059
18060
18061
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18058

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

#list_realtime_contact_analysis_segments_v2(params = {}) ⇒ Types::ListRealtimeContactAnalysisSegmentsV2Response

Provides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only.

This API does not support VOICE. If you attempt to use it for VOICE, an InvalidRequestException occurs.

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

Examples:

Request syntax with placeholder values


resp = client.list_realtime_contact_analysis_segments_v2({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  max_results: 1,
  next_token: "LargeNextToken",
  output_type: "Raw", # required, accepts Raw, Redacted
  segment_types: ["Transcript"], # required, accepts Transcript, Categories, Issues, Event, Attachments, PostContactSummary
})

Response structure


resp.channel #=> String, one of "VOICE", "CHAT"
resp.status #=> String, one of "IN_PROGRESS", "FAILED", "COMPLETED"
resp.segments #=> Array
resp.segments[0].transcript.id #=> String
resp.segments[0].transcript.participant_id #=> String
resp.segments[0].transcript.participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM", "CUSTOM_BOT", "SUPERVISOR"
resp.segments[0].transcript.display_name #=> String
resp.segments[0].transcript.content #=> String
resp.segments[0].transcript.content_type #=> String
resp.segments[0].transcript.time.absolute_time #=> Time
resp.segments[0].transcript.redaction.character_offsets #=> Array
resp.segments[0].transcript.redaction.character_offsets[0].begin_offset_char #=> Integer
resp.segments[0].transcript.redaction.character_offsets[0].end_offset_char #=> Integer
resp.segments[0].transcript.sentiment #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL"
resp.segments[0].categories.matched_details #=> Hash
resp.segments[0].categories.matched_details["RealTimeContactAnalysisCategoryName"].points_of_interest #=> Array
resp.segments[0].categories.matched_details["RealTimeContactAnalysisCategoryName"].points_of_interest[0].transcript_items #=> Array
resp.segments[0].categories.matched_details["RealTimeContactAnalysisCategoryName"].points_of_interest[0].transcript_items[0].id #=> String
resp.segments[0].categories.matched_details["RealTimeContactAnalysisCategoryName"].points_of_interest[0].transcript_items[0].character_offsets.begin_offset_char #=> Integer
resp.segments[0].categories.matched_details["RealTimeContactAnalysisCategoryName"].points_of_interest[0].transcript_items[0].character_offsets.end_offset_char #=> Integer
resp.segments[0].issues.issues_detected #=> Array
resp.segments[0].issues.issues_detected[0].transcript_items #=> Array
resp.segments[0].issues.issues_detected[0].transcript_items[0].content #=> String
resp.segments[0].issues.issues_detected[0].transcript_items[0].id #=> String
resp.segments[0].issues.issues_detected[0].transcript_items[0].character_offsets.begin_offset_char #=> Integer
resp.segments[0].issues.issues_detected[0].transcript_items[0].character_offsets.end_offset_char #=> Integer
resp.segments[0].event.id #=> String
resp.segments[0].event.participant_id #=> String
resp.segments[0].event.participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM", "CUSTOM_BOT", "SUPERVISOR"
resp.segments[0].event.display_name #=> String
resp.segments[0].event.event_type #=> String
resp.segments[0].event.time.absolute_time #=> Time
resp.segments[0].attachments.id #=> String
resp.segments[0].attachments.participant_id #=> String
resp.segments[0].attachments.participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM", "CUSTOM_BOT", "SUPERVISOR"
resp.segments[0].attachments.display_name #=> String
resp.segments[0].attachments.attachments #=> Array
resp.segments[0].attachments.attachments[0].attachment_name #=> String
resp.segments[0].attachments.attachments[0].content_type #=> String
resp.segments[0].attachments.attachments[0].attachment_id #=> String
resp.segments[0].attachments.attachments[0].status #=> String, one of "APPROVED", "REJECTED", "IN_PROGRESS"
resp.segments[0].attachments.time.absolute_time #=> Time
resp.segments[0].post_contact_summary.content #=> String
resp.segments[0].post_contact_summary.status #=> String, one of "FAILED", "COMPLETED"
resp.segments[0].post_contact_summary.failure_code #=> String, one of "QUOTA_EXCEEDED", "INSUFFICIENT_CONVERSATION_CONTENT", "FAILED_SAFETY_GUIDELINES", "INVALID_ANALYSIS_CONFIGURATION", "INTERNAL_ERROR"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :output_type (required, String) —

    The Contact Lens output type to be returned.

  • :segment_types (required, Array<String>) —

    Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types.

Returns:

See Also:



18170
18171
18172
18173
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18170

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

#list_routing_profile_manual_assignment_queues(params = {}) ⇒ Types::ListRoutingProfileManualAssignmentQueuesResponse

Lists the manual assignment queues associated with a routing profile.

Use cases

Following are common uses cases for this API:

  • This API returns list of queues where contacts can be manually assigned or picked by an agent who has access to the Worklist app. The user can additionally filter on queues, if they have access to those queues (otherwise a invalid request exception will be thrown).

    For information about how manual contact assignment works in the agent workspace, see the Access the Worklist app in the Connect Customer agent workspace in the Connect Customer Administrator Guide.

Important things to know

  • This API only returns the manual assignment queues associated with a routing profile. Use the ListRoutingProfileQueues API to list the auto assignment queues for the routing profile.

^

Endpoints: See Connect Customer endpoints and quotas.

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

Examples:

Request syntax with placeholder values


resp = client.list_routing_profile_manual_assignment_queues({
  instance_id: "InstanceId", # required
  routing_profile_id: "RoutingProfileId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.routing_profile_manual_assignment_queue_config_summary_list #=> Array
resp.routing_profile_manual_assignment_queue_config_summary_list[0].queue_id #=> String
resp.routing_profile_manual_assignment_queue_config_summary_list[0].queue_arn #=> String
resp.routing_profile_manual_assignment_queue_config_summary_list[0].queue_name #=> String
resp.routing_profile_manual_assignment_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.last_modified_time #=> Time
resp.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :routing_profile_id (required, String) —

    The identifier of the routing profile.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



18258
18259
18260
18261
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18258

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

#list_routing_profile_queues(params = {}) ⇒ Types::ListRoutingProfileQueuesResponse

Lists the queues associated with a routing profile.

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

Examples:

Request syntax with placeholder values


resp = client.list_routing_profile_queues({
  instance_id: "InstanceId", # required
  routing_profile_id: "RoutingProfileId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.routing_profile_queue_config_summary_list #=> Array
resp.routing_profile_queue_config_summary_list[0].queue_id #=> String
resp.routing_profile_queue_config_summary_list[0].queue_arn #=> String
resp.routing_profile_queue_config_summary_list[0].queue_name #=> String
resp.routing_profile_queue_config_summary_list[0].priority #=> Integer
resp.routing_profile_queue_config_summary_list[0].delay #=> Integer
resp.routing_profile_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.last_modified_time #=> Time
resp.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :routing_profile_id (required, String) —

    The identifier of the routing profile.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



18320
18321
18322
18323
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18320

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

#list_routing_profiles(params = {}) ⇒ Types::ListRoutingProfilesResponse

Provides summary information about the routing profiles for the specified Connect Customer instance.

For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Connect Customer Administrator Guide.

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

Examples:

Request syntax with placeholder values


resp = client.list_routing_profiles({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.routing_profile_summary_list #=> Array
resp.routing_profile_summary_list[0].id #=> String
resp.routing_profile_summary_list[0].arn #=> String
resp.routing_profile_summary_list[0].name #=> String
resp.routing_profile_summary_list[0].last_modified_time #=> Time
resp.routing_profile_summary_list[0].last_modified_region #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



18383
18384
18385
18386
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18383

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

#list_rules(params = {}) ⇒ Types::ListRulesResponse

List all rules for the specified Connect Customer instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_rules({
  instance_id: "InstanceId", # required
  publish_status: "DRAFT", # accepts DRAFT, PUBLISHED
  event_source_name: "OnPostCallAnalysisAvailable", # accepts OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnRealTimeChatAnalysisAvailable, OnPostChatAnalysisAvailable, OnEmailAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit, OnMetricDataUpdate, OnCaseCreate, OnCaseUpdate, OnSlaBreach, OnAlertUpdate, OnSchedulePublish, OnScheduleUpdate, OnScheduleTimeOffRequestActivity
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.rule_summary_list #=> Array
resp.rule_summary_list[0].name #=> String
resp.rule_summary_list[0].rule_id #=> String
resp.rule_summary_list[0].rule_arn #=> String
resp.rule_summary_list[0].event_source_name #=> String, one of "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", "OnRealTimeChatAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnEmailAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate", "OnContactEvaluationSubmit", "OnMetricDataUpdate", "OnCaseCreate", "OnCaseUpdate", "OnSlaBreach", "OnAlertUpdate", "OnSchedulePublish", "OnScheduleUpdate", "OnScheduleTimeOffRequestActivity"
resp.rule_summary_list[0].publish_status #=> String, one of "DRAFT", "PUBLISHED"
resp.rule_summary_list[0].rule_capability_tiers #=> Array
resp.rule_summary_list[0].rule_capability_tiers[0] #=> String, one of "GenerativeAI"
resp.rule_summary_list[0].action_summaries #=> Array
resp.rule_summary_list[0].action_summaries[0].action_type #=> String, one of "CREATE_TASK", "ASSIGN_CONTACT_CATEGORY", "GENERATE_EVENTBRIDGE_EVENT", "SEND_NOTIFICATION", "CREATE_CASE", "UPDATE_CASE", "ASSIGN_SLA", "END_ASSOCIATED_TASKS", "SUBMIT_AUTO_EVALUATION"
resp.rule_summary_list[0].created_time #=> Time
resp.rule_summary_list[0].last_updated_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :publish_status (String) —

    The publish status of the rule.

  • :event_source_name (String) —

    The name of the event source.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



18449
18450
18451
18452
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18449

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

#list_security_keys(params = {}) ⇒ Types::ListSecurityKeysResponse

This API is in preview release for Connect Customer and is subject to change.

Returns a paginated list of all security keys associated with the instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_security_keys({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.security_keys #=> Array
resp.security_keys[0].association_id #=> String
resp.security_keys[0].key #=> String
resp.security_keys[0].creation_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



18503
18504
18505
18506
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18503

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

#list_security_profile_applications(params = {}) ⇒ Types::ListSecurityProfileApplicationsResponse

Returns a list of third-party applications or MCP Servers in a specific security profile.

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

Examples:

Request syntax with placeholder values


resp = client.list_security_profile_applications({
  security_profile_id: "SecurityProfileId", # required
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.applications #=> Array
resp.applications[0].namespace #=> String
resp.applications[0].application_permissions #=> Array
resp.applications[0].application_permissions[0] #=> String
resp.applications[0].type #=> String, one of "MCP", "THIRD_PARTY_APPLICATION"
resp.next_token #=> String
resp.last_modified_time #=> Time
resp.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :security_profile_id (required, String) —

    The identifier for the security profle.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



18563
18564
18565
18566
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18563

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

#list_security_profile_flow_modules(params = {}) ⇒ Types::ListSecurityProfileFlowModulesResponse

A list of Flow Modules an AI Agent can invoke as a tool

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

Examples:

Request syntax with placeholder values


resp = client.list_security_profile_flow_modules({
  security_profile_id: "SecurityProfileId", # required
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.allowed_flow_modules #=> Array
resp.allowed_flow_modules[0].type #=> String, one of "MCP"
resp.allowed_flow_modules[0].flow_module_id #=> String
resp.next_token #=> String
resp.last_modified_time #=> Time
resp.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :security_profile_id (required, String) —

    The identifier for the security profile.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



18621
18622
18623
18624
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18621

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

#list_security_profile_permissions(params = {}) ⇒ Types::ListSecurityProfilePermissionsResponse

Lists the permissions granted to a security profile.

For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

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

Examples:

Request syntax with placeholder values


resp = client.list_security_profile_permissions({
  security_profile_id: "SecurityProfileId", # required
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.permissions #=> Array
resp.permissions[0] #=> String
resp.next_token #=> String
resp.last_modified_time #=> Time
resp.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :security_profile_id (required, String) —

    The identifier for the security profle.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



18687
18688
18689
18690
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18687

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

#list_security_profiles(params = {}) ⇒ Types::ListSecurityProfilesResponse

Provides summary information about the security profiles for the specified Connect Customer instance.

For more information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

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

Examples:

Request syntax with placeholder values


resp = client.list_security_profiles({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.security_profile_summary_list #=> Array
resp.security_profile_summary_list[0].id #=> String
resp.security_profile_summary_list[0].arn #=> String
resp.security_profile_summary_list[0].name #=> String
resp.security_profile_summary_list[0].last_modified_time #=> Time
resp.security_profile_summary_list[0].last_modified_region #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



18751
18752
18753
18754
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18751

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

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

Lists the tags for the specified resource.

For sample policies that use tags, see Connect Customer Identity-Based Policy Examples in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource. All Connect Customer resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN for an instance, for example, see Find your Connect Customer instance ID/ARN.

Returns:

See Also:



18795
18796
18797
18798
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18795

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

#list_task_templates(params = {}) ⇒ Types::ListTaskTemplatesResponse

Lists task templates for the specified Connect Customer instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_task_templates({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
  status: "ACTIVE", # accepts ACTIVE, INACTIVE
  name: "TaskTemplateName",
})

Response structure


resp.task_templates #=> Array
resp.task_templates[0].id #=> String
resp.task_templates[0].arn #=> String
resp.task_templates[0].name #=> String
resp.task_templates[0].description #=> String
resp.task_templates[0].status #=> String, one of "ACTIVE", "INACTIVE"
resp.task_templates[0].last_modified_time #=> Time
resp.task_templates[0].created_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    It is not expected that you set this because the value returned in the previous response is always null.

  • :max_results (Integer) —

    The maximum number of results to return per page.

    It is not expected that you set this.

  • :status (String) —

    Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

  • :name (String) —

    The name of the task template.

Returns:

See Also:



18865
18866
18867
18868
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18865

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

#list_test_case_execution_records(params = {}) ⇒ Types::ListTestCaseExecutionRecordsResponse

Lists detailed steps of test case execution that includes all observations along with actions taken and data associated in the specified Amazon Connect instance.

Examples:

Request syntax with placeholder values


resp = client.list_test_case_execution_records({
  instance_id: "InstanceId", # required
  test_case_id: "TestCaseId", # required
  test_case_execution_id: "TestCaseExecutionId", # required
  status: "INITIATED", # accepts INITIATED, PASSED, FAILED, IN_PROGRESS, STOPPED
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.execution_records #=> Array
resp.execution_records[0].observation_id #=> String
resp.execution_records[0].status #=> String, one of "PASSED", "FAILED", "IN_PROGRESS", "STOPPED"
resp.execution_records[0].timestamp #=> Time
resp.execution_records[0].record #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance.

  • :test_case_id (required, String) —

    The identifier of the test case.

  • :test_case_execution_id (required, String) —

    The identifier of the test case execution.

  • :status (String) —

    Filter execution records by status.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



18923
18924
18925
18926
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18923

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

#list_test_case_executions(params = {}) ⇒ Types::ListTestCaseExecutionsResponse

Lists all test case executions and allows filtering by test case id, test case name, start time, end time or status of the execution for the specified Amazon Connect instance.

Examples:

Request syntax with placeholder values


resp = client.list_test_case_executions({
  instance_id: "InstanceId", # required
  test_case_id: "TestCaseId",
  test_case_name: "TestCaseName",
  start_time: 1,
  end_time: 1,
  status: "INITIATED", # accepts INITIATED, PASSED, FAILED, IN_PROGRESS, STOPPED
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.test_case_executions #=> Array
resp.test_case_executions[0].start_time #=> Time
resp.test_case_executions[0].end_time #=> Time
resp.test_case_executions[0].test_case_execution_id #=> String
resp.test_case_executions[0].test_case_id #=> String
resp.test_case_executions[0].test_case_execution_status #=> String, one of "INITIATED", "PASSED", "FAILED", "IN_PROGRESS", "STOPPED"
resp.test_case_executions[0].tags #=> Hash
resp.test_case_executions[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance.

  • :test_case_id (String) —

    Filter executions by test case identifier.

  • :test_case_name (String) —

    Filter executions by test case name.

  • :start_time (Integer) —

    Filter executions that started after this time.

  • :end_time (Integer) —

    Filter executions that started before this time.

  • :status (String) —

    Filter executions by status.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



18992
18993
18994
18995
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18992

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

#list_test_cases(params = {}) ⇒ Types::ListTestCasesResponse

Lists the test cases present in the specific Amazon Connect instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_test_cases({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.test_case_summary_list #=> Array
resp.test_case_summary_list[0].id #=> String
resp.test_case_summary_list[0].arn #=> String
resp.test_case_summary_list[0].name #=> String
resp.test_case_summary_list[0].status #=> String, one of "PUBLISHED", "SAVED"
resp.test_case_summary_list[0].last_modified_time #=> Time
resp.test_case_summary_list[0].last_modified_region #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



19040
19041
19042
19043
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19040

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

#list_traffic_distribution_group_users(params = {}) ⇒ Types::ListTrafficDistributionGroupUsersResponse

Lists traffic distribution group users.

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

Examples:

Request syntax with placeholder values


resp = client.list_traffic_distribution_group_users({
  traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.traffic_distribution_group_user_summary_list #=> Array
resp.traffic_distribution_group_user_summary_list[0].user_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :traffic_distribution_group_id (required, String) —

    The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



19086
19087
19088
19089
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19086

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

#list_traffic_distribution_groups(params = {}) ⇒ Types::ListTrafficDistributionGroupsResponse

Lists traffic distribution groups.

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

Examples:

Request syntax with placeholder values


resp = client.list_traffic_distribution_groups({
  max_results: 1,
  next_token: "NextToken",
  instance_id: "InstanceIdOrArn",
})

Response structure


resp.next_token #=> String
resp.traffic_distribution_group_summary_list #=> Array
resp.traffic_distribution_group_summary_list[0].id #=> String
resp.traffic_distribution_group_summary_list[0].arn #=> String
resp.traffic_distribution_group_summary_list[0].name #=> String
resp.traffic_distribution_group_summary_list[0].instance_arn #=> String
resp.traffic_distribution_group_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "PENDING_DELETION", "DELETION_FAILED", "UPDATE_IN_PROGRESS"
resp.traffic_distribution_group_summary_list[0].is_default #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :instance_id (String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



19139
19140
19141
19142
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19139

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

#list_use_cases(params = {}) ⇒ Types::ListUseCasesResponse

Lists the use cases for the integration association.

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

Examples:

Request syntax with placeholder values


resp = client.list_use_cases({
  instance_id: "InstanceId", # required
  integration_association_id: "IntegrationAssociationId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.use_case_summary_list #=> Array
resp.use_case_summary_list[0].use_case_id #=> String
resp.use_case_summary_list[0].use_case_arn #=> String
resp.use_case_summary_list[0].use_case_type #=> String, one of "RULES_EVALUATION", "CONNECT_CAMPAIGNS"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :integration_association_id (required, String) —

    The identifier for the integration association.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



19193
19194
19195
19196
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19193

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

#list_user_hierarchy_groups(params = {}) ⇒ Types::ListUserHierarchyGroupsResponse

Provides summary information about the hierarchy groups for the specified Connect Customer instance.

For more information about agent hierarchies, see Set Up Agent Hierarchies in the Connect Customer Administrator Guide.

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

Examples:

Request syntax with placeholder values


resp = client.list_user_hierarchy_groups({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.user_hierarchy_group_summary_list #=> Array
resp.user_hierarchy_group_summary_list[0].id #=> String
resp.user_hierarchy_group_summary_list[0].arn #=> String
resp.user_hierarchy_group_summary_list[0].name #=> String
resp.user_hierarchy_group_summary_list[0].last_modified_time #=> Time
resp.user_hierarchy_group_summary_list[0].last_modified_region #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



19254
19255
19256
19257
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19254

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

#list_user_notifications(params = {}) ⇒ Types::ListUserNotificationsResponse

Retrieves a paginated list of notifications for a specific user, including the notification status for that user.

Examples:

Request syntax with placeholder values


resp = client.list_user_notifications({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
  user_id: "UserId", # required
})

Response structure


resp.user_notifications #=> Array
resp.user_notifications[0].notification_id #=> String
resp.user_notifications[0].notification_status #=> String, one of "READ", "UNREAD", "HIDDEN"
resp.user_notifications[0].instance_id #=> String
resp.user_notifications[0].recipient_id #=> String
resp.user_notifications[0].content #=> Hash
resp.user_notifications[0].content["LocaleCode"] #=> String
resp.user_notifications[0].priority #=> String, one of "URGENT", "HIGH", "LOW"
resp.user_notifications[0].source #=> String, one of "CUSTOMER", "RULES", "SYSTEM"
resp.user_notifications[0].created_at #=> Time
resp.user_notifications[0].expires_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. Valid range is 1-1000.

  • :user_id (required, String) —

    The identifier of the user.

Returns:

See Also:



19314
19315
19316
19317
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19314

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

#list_user_proficiencies(params = {}) ⇒ Types::ListUserProficienciesResponse

Lists proficiencies associated with a user.

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

Examples:

Request syntax with placeholder values


resp = client.list_user_proficiencies({
  instance_id: "InstanceId", # required
  user_id: "UserId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.user_proficiency_list #=> Array
resp.user_proficiency_list[0].attribute_name #=> String
resp.user_proficiency_list[0].attribute_value #=> String
resp.user_proficiency_list[0].level #=> Float
resp.last_modified_time #=> Time
resp.last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :user_id (required, String) —

    The identifier of the user account.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



19368
19369
19370
19371
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19368

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

#list_users(params = {}) ⇒ Types::ListUsersResponse

Provides summary information about the users for the specified Connect Customer instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_users({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.user_summary_list #=> Array
resp.user_summary_list[0].id #=> String
resp.user_summary_list[0].arn #=> String
resp.user_summary_list[0].username #=> String
resp.user_summary_list[0].last_modified_time #=> Time
resp.user_summary_list[0].last_modified_region #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



19422
19423
19424
19425
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19422

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

#list_view_versions(params = {}) ⇒ Types::ListViewVersionsResponse

Returns all the available versions for the specified Connect Customer instance and view identifier.

Results will be sorted from highest to lowest.

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

Examples:

Request syntax with placeholder values


resp = client.list_view_versions({
  instance_id: "ViewsInstanceId", # required
  view_id: "ViewId", # required
  next_token: "ViewsNextToken",
  max_results: 1,
})

Response structure


resp.view_version_summary_list #=> Array
resp.view_version_summary_list[0].id #=> String
resp.view_version_summary_list[0].arn #=> String
resp.view_version_summary_list[0].description #=> String
resp.view_version_summary_list[0].name #=> String
resp.view_version_summary_list[0].type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
resp.view_version_summary_list[0].version #=> Integer
resp.view_version_summary_list[0].version_description #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

  • :view_id (required, String) —

    The identifier of the view. Both ViewArn and ViewId can be used.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



19480
19481
19482
19483
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19480

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

#list_views(params = {}) ⇒ Types::ListViewsResponse

Returns views in the given instance.

Results are sorted primarily by type, and secondarily by name.

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

Examples:

Request syntax with placeholder values


resp = client.list_views({
  instance_id: "ViewsInstanceId", # required
  type: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED, AWS_MANAGED
  next_token: "ViewsNextToken",
  max_results: 1,
})

Response structure


resp.views_summary_list #=> Array
resp.views_summary_list[0].id #=> String
resp.views_summary_list[0].arn #=> String
resp.views_summary_list[0].name #=> String
resp.views_summary_list[0].type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
resp.views_summary_list[0].status #=> String, one of "PUBLISHED", "SAVED"
resp.views_summary_list[0].description #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

  • :type (String) —

    The type of the view.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. The default MaxResult size is 100.

Returns:

See Also:



19536
19537
19538
19539
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19536

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

#list_workspace_media(params = {}) ⇒ Types::ListWorkspaceMediaResponse

Lists media assets (such as logos) associated with a workspace.

Examples:

Request syntax with placeholder values


resp = client.list_workspace_media({
  instance_id: "InstanceId", # required
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.media #=> Array
resp.media[0].type #=> String, one of "IMAGE_LOGO_LIGHT_FAVICON", "IMAGE_LOGO_DARK_FAVICON", "IMAGE_LOGO_LIGHT_HORIZONTAL", "IMAGE_LOGO_DARK_HORIZONTAL"
resp.media[0].source #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :workspace_id (required, String) —

    The identifier of the workspace.

Returns:

See Also:



19575
19576
19577
19578
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19575

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

#list_workspace_pages(params = {}) ⇒ Types::ListWorkspacePagesResponse

Lists the page configurations in a workspace, including the views assigned to each page.

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

Examples:

Request syntax with placeholder values


resp = client.list_workspace_pages({
  instance_id: "InstanceId", # required
  workspace_id: "WorkspaceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.workspace_page_list #=> Array
resp.workspace_page_list[0].resource_arn #=> String
resp.workspace_page_list[0].page #=> String
resp.workspace_page_list[0].slug #=> String
resp.workspace_page_list[0].input_data #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :workspace_id (required, String) —

    The identifier of the workspace.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



19631
19632
19633
19634
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19631

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

#list_workspaces(params = {}) ⇒ Types::ListWorkspacesResponse

Lists the workspaces in an Amazon Connect instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_workspaces({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.workspace_summary_list #=> Array
resp.workspace_summary_list[0].id #=> String
resp.workspace_summary_list[0].name #=> String
resp.workspace_summary_list[0].arn #=> String
resp.workspace_summary_list[0].last_modified_time #=> Time
resp.workspace_summary_list[0].last_modified_region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



19683
19684
19685
19686
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19683

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

#monitor_contact(params = {}) ⇒ Types::MonitorContactResponse

Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.

Examples:

Request syntax with placeholder values


resp = client.monitor_contact({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  user_id: "AgentResourceId", # required
  allowed_monitor_capabilities: ["SILENT_MONITOR"], # accepts SILENT_MONITOR, BARGE
  client_token: "ClientToken",
})

Response structure


resp.contact_id #=> String
resp.contact_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

  • :contact_id (required, String) —

    The identifier of the contact.

  • :user_id (required, String) —

    The identifier of the user account.

  • :allowed_monitor_capabilities (Array<String>) —

    Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



19745
19746
19747
19748
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19745

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

#pause_contact(params = {}) ⇒ Struct

Allows pausing an ongoing task contact.

Examples:

Request syntax with placeholder values


resp = client.pause_contact({
  contact_id: "ContactId", # required
  instance_id: "InstanceId", # required
  contact_flow_id: "ContactFlowId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    The identifier of the contact.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

  • :contact_flow_id (String) —

    The identifier of the flow.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



19776
19777
19778
19779
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19776

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

#put_user_status(params = {}) ⇒ Struct

Changes the current status of a user or agent in Connect Customer. If the agent is currently handling a contact, this sets the agent's next status.

For more information, see Agent status and Set your next status in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.put_user_status({
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
  agent_status_id: "AgentStatusId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :user_id (required, String) —

    The identifier of the user.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :agent_status_id (required, String) —

    The identifier of the agent status.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



19821
19822
19823
19824
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19821

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

#release_phone_number(params = {}) ⇒ Struct

Releases a phone number previously claimed to an Connect Customer instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Connect Customer admin website.

After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.

If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

Examples:

Request syntax with placeholder values


resp = client.release_phone_number({
  phone_number_id: "PhoneNumberId", # required
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    A unique identifier for the phone number.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



19885
19886
19887
19888
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19885

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

#replicate_instance(params = {}) ⇒ Types::ReplicateInstanceResponse

Replicates an Connect Customer instance in the specified Amazon Web Services Region and copies configuration information for Connect Customer resources across Amazon Web Services Regions.

For more information about replicating an Connect Customer instance, see Create a replica of your existing Connect Customer instance in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.replicate_instance({
  instance_id: "InstanceIdOrArn", # required
  replica_region: "AwsRegion", # required
  client_token: "ClientToken",
  replica_alias: "DirectoryAlias", # required
})

Response structure


resp.id #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You can provide the InstanceId, or the entire ARN.

  • :replica_region (required, String) —

    The Amazon Web Services Region where to replicate the Connect Customer instance.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :replica_alias (required, String) —

    The alias for the replicated instance. The ReplicaAlias must be unique.

Returns:

See Also:



19955
19956
19957
19958
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19955

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

#resume_contact(params = {}) ⇒ Struct

Allows resuming a task contact in a paused state.

Examples:

Request syntax with placeholder values


resp = client.resume_contact({
  contact_id: "ContactId", # required
  instance_id: "InstanceId", # required
  contact_flow_id: "ContactFlowId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    The identifier of the contact.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

  • :contact_flow_id (String) —

    The identifier of the flow.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



19986
19987
19988
19989
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19986

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

#resume_contact_recording(params = {}) ⇒ Struct

When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.

Voice and screen recordings are supported.

Examples:

Request syntax with placeholder values


resp = client.resume_contact_recording({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  initial_contact_id: "ContactId", # required
  contact_recording_type: "AGENT", # accepts AGENT, IVR, SCREEN
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact.

  • :initial_contact_id (required, String) —

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

  • :contact_recording_type (String) —

    The type of recording being operated on.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



20032
20033
20034
20035
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20032

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

#search_agent_statuses(params = {}) ⇒ Types::SearchAgentStatusesResponse

Searches AgentStatuses in an Connect Customer instance, with optional filtering.

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

Examples:

Request syntax with placeholder values


resp = client.search_agent_statuses({
  instance_id: "InstanceId", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_filter: {
    attribute_filter: {
      or_conditions: [
        {
          tag_conditions: [
            {
              tag_key: "String",
              tag_value: "String",
            },
          ],
        },
      ],
      and_condition: {
        tag_conditions: [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      },
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive AgentStatusSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive AgentStatusSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
  },
})

Response structure


resp.agent_statuses #=> Array
resp.agent_statuses[0].agent_status_arn #=> String
resp.agent_statuses[0].agent_status_id #=> String
resp.agent_statuses[0].name #=> String
resp.agent_statuses[0].description #=> String
resp.agent_statuses[0].type #=> String, one of "ROUTABLE", "CUSTOM", "OFFLINE"
resp.agent_statuses[0].display_order #=> Integer
resp.agent_statuses[0].state #=> String, one of "ENABLED", "DISABLED"
resp.agent_statuses[0].tags #=> Hash
resp.agent_statuses[0].tags["TagKey"] #=> String
resp.agent_statuses[0].last_modified_time #=> Time
resp.agent_statuses[0].last_modified_region #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::AgentStatusSearchFilter) —

    Filters to be applied to search results.

  • :search_criteria (Types::AgentStatusSearchCriteria) —

    The search criteria to be used to return agent statuses.

Returns:

See Also:



20138
20139
20140
20141
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20138

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

#search_available_phone_numbers(params = {}) ⇒ Types::SearchAvailablePhoneNumbersResponse

Searches for available phone numbers that you can claim to your Connect Customer instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.

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

Examples:

Request syntax with placeholder values


resp = client.search_available_phone_numbers({
  target_arn: "ARN",
  instance_id: "InstanceId",
  phone_number_country_code: "AF", # required, accepts AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
  phone_number_type: "TOLL_FREE", # required, accepts TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID, SHORT_CODE
  phone_number_prefix: "PhoneNumberPrefix",
  max_results: 1,
  next_token: "LargeNextToken",
})

Response structure


resp.next_token #=> String
resp.available_numbers_list #=> Array
resp.available_numbers_list[0].phone_number #=> String
resp.available_numbers_list[0].phone_number_country_code #=> String, one of "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BR", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CK", "CR", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "TL", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "PF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "KP", "MP", "NO", "OM", "PK", "PW", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "CG", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "KR", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "VI", "UG", "UA", "AE", "GB", "US", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW"
resp.available_numbers_list[0].phone_number_type #=> String, one of "TOLL_FREE", "DID", "UIFN", "SHARED", "THIRD_PARTY_TF", "THIRD_PARTY_DID", "SHORT_CODE"

Parameters:

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

    ({})

Options Hash (params):

  • :target_arn (String) —

    The Amazon Resource Name (ARN) for Connect Customer instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.

  • :instance_id (String) —

    The identifier of the Connect Customer instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

  • :phone_number_country_code (required, String) —

    The ISO country code.

  • :phone_number_type (required, String) —

    The type of phone number.

  • :phone_number_prefix (String) —

    The prefix of the phone number. If provided, it must contain + as part of the country code.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



20213
20214
20215
20216
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20213

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

#search_contact_evaluations(params = {}) ⇒ Types::SearchContactEvaluationsResponse

Searches contact evaluations in an Connect Customer instance, with optional filtering.

Use cases

Following are common uses cases for this API:

  • Find contact evaluations by using specific search criteria.

  • Find contact evaluations that are tagged with a specific set of tags.

Important things to know

  • A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds.

^

Endpoints: See Connect Customer endpoints and quotas.

Examples:

Request syntax with placeholder values


resp = client.search_contact_evaluations({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
  search_criteria: {
    or_conditions: [
      {
        # recursive EvaluationSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive EvaluationSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
    number_condition: {
      field_name: "String",
      min_value: 1,
      max_value: 1,
      comparison_type: "GREATER_OR_EQUAL", # accepts GREATER_OR_EQUAL, GREATER, LESSER_OR_EQUAL, LESSER, EQUAL, NOT_EQUAL, RANGE
    },
    boolean_condition: {
      field_name: "String",
      comparison_type: "IS_TRUE", # accepts IS_TRUE, IS_FALSE
    },
    date_time_condition: {
      field_name: "String",
      min_value: "DateTimeFormat",
      max_value: "DateTimeFormat",
      comparison_type: "GREATER_THAN", # accepts GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN_OR_EQUAL_TO, EQUAL_TO, RANGE
    },
    decimal_condition: {
      field_name: "String",
      min_value: 1.0,
      max_value: 1.0,
      comparison_type: "GREATER_OR_EQUAL", # accepts GREATER_OR_EQUAL, GREATER, LESSER_OR_EQUAL, LESSER, EQUAL, NOT_EQUAL, RANGE
    },
  },
  search_filter: {
    attribute_filter: {
      or_conditions: [
        {
          tag_conditions: [
            {
              tag_key: "String",
              tag_value: "String",
            },
          ],
        },
      ],
      and_condition: {
        tag_conditions: [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      },
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
    contact_evaluation_attribute_filter: {
      or_conditions: [
        {
          tag_conditions: [
            {
              tag_key: "String",
              tag_value: "String",
            },
          ],
          attribute_conditions: [
            {
              attribute_key: "ContactAgentId", # accepts ContactAgentId
              attribute_value: {
                string_value: "String",
              },
              comparison_type: "EXACT", # accepts EXACT
            },
          ],
        },
      ],
      and_condition: {
        tag_conditions: [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
        attribute_conditions: [
          {
            attribute_key: "ContactAgentId", # accepts ContactAgentId
            attribute_value: {
              string_value: "String",
            },
            comparison_type: "EXACT", # accepts EXACT
          },
        ],
      },
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
      contact_evaluation_attribute_condition: {
        attribute_key: "ContactAgentId", # accepts ContactAgentId
        attribute_value: {
          string_value: "String",
        },
        comparison_type: "EXACT", # accepts EXACT
      },
    },
  },
})

Response structure


resp.evaluation_search_summary_list #=> Array
resp.evaluation_search_summary_list[0].evaluation_id #=> String
resp.evaluation_search_summary_list[0].evaluation_arn #=> String
resp.evaluation_search_summary_list[0].evaluation_form_id #=> String
resp.evaluation_search_summary_list[0].evaluation_form_version #=> Integer
resp.evaluation_search_summary_list[0].evaluation_form_title #=> String
resp.evaluation_search_summary_list[0].metadata.contact_id #=> String
resp.evaluation_search_summary_list[0].metadata.evaluator_arn #=> String
resp.evaluation_search_summary_list[0].metadata.contact_agent_id #=> String
resp.evaluation_search_summary_list[0].metadata.calibration_session_id #=> String
resp.evaluation_search_summary_list[0].metadata.score_percentage #=> Float
resp.evaluation_search_summary_list[0].metadata.score_automatic_fail #=> Boolean
resp.evaluation_search_summary_list[0].metadata.score_not_applicable #=> Boolean
resp.evaluation_search_summary_list[0].metadata.auto_evaluation_enabled #=> Boolean
resp.evaluation_search_summary_list[0].metadata.auto_evaluation_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED"
resp.evaluation_search_summary_list[0].metadata.acknowledged_time #=> Time
resp.evaluation_search_summary_list[0].metadata.acknowledged_by #=> String
resp.evaluation_search_summary_list[0].metadata.acknowledger_comment #=> String
resp.evaluation_search_summary_list[0].metadata.sampling_job_id #=> String
resp.evaluation_search_summary_list[0].metadata.review_id #=> String
resp.evaluation_search_summary_list[0].metadata.contact_participant_role #=> String, one of "AGENT", "SYSTEM", "CUSTOM_BOT", "CUSTOMER"
resp.evaluation_search_summary_list[0].metadata.contact_participant_id #=> String
resp.evaluation_search_summary_list[0].metadata.earned_points #=> Integer
resp.evaluation_search_summary_list[0].metadata.max_base_point #=> Integer
resp.evaluation_search_summary_list[0].metadata.performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
resp.evaluation_search_summary_list[0].status #=> String, one of "DRAFT", "SUBMITTED", "REVIEW_REQUESTED", "UNDER_REVIEW"
resp.evaluation_search_summary_list[0].evaluation_type #=> String, one of "STANDARD", "CALIBRATION"
resp.evaluation_search_summary_list[0].created_time #=> Time
resp.evaluation_search_summary_list[0].last_modified_time #=> Time
resp.evaluation_search_summary_list[0].tags #=> Hash
resp.evaluation_search_summary_list[0].tags["TagKey"] #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_criteria (Types::EvaluationSearchCriteria) —

    The search criteria to be used to return contact evaluations.

  • :search_filter (Types::EvaluationSearchFilter) —

    Filters to be applied to search results.

Returns:

See Also:



20435
20436
20437
20438
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20435

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

#search_contact_flow_modules(params = {}) ⇒ Types::SearchContactFlowModulesResponse

Searches the flow modules in an Connect Customer instance, with optional filtering.

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

Examples:

Request syntax with placeholder values


resp = client.search_contact_flow_modules({
  instance_id: "InstanceId", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_filter: {
    tag_filter: {
      or_conditions: [
        [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      ],
      and_conditions: [
        {
          tag_key: "String",
          tag_value: "String",
        },
      ],
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive ContactFlowModuleSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive ContactFlowModuleSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
    state_condition: "ACTIVE", # accepts ACTIVE, ARCHIVED
    status_condition: "PUBLISHED", # accepts PUBLISHED, SAVED
  },
})

Response structure


resp.contact_flow_modules #=> Array
resp.contact_flow_modules[0].arn #=> String
resp.contact_flow_modules[0].id #=> String
resp.contact_flow_modules[0].name #=> String
resp.contact_flow_modules[0].content #=> String
resp.contact_flow_modules[0].description #=> String
resp.contact_flow_modules[0].state #=> String, one of "ACTIVE", "ARCHIVED"
resp.contact_flow_modules[0].status #=> String, one of "PUBLISHED", "SAVED"
resp.contact_flow_modules[0].tags #=> Hash
resp.contact_flow_modules[0].tags["TagKey"] #=> String
resp.contact_flow_modules[0].flow_module_content_sha_256 #=> String
resp.contact_flow_modules[0].version #=> Integer
resp.contact_flow_modules[0].version_description #=> String
resp.contact_flow_modules[0].settings #=> String
resp.contact_flow_modules[0].external_invocation_configuration.enabled #=> Boolean
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::ContactFlowModuleSearchFilter) —

    Filters to be applied to search results.

  • :search_criteria (Types::ContactFlowModuleSearchCriteria) —

    The search criteria to be used to return flow modules.

    The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.

Returns:

See Also:



20549
20550
20551
20552
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20549

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

#search_contact_flows(params = {}) ⇒ Types::SearchContactFlowsResponse

Searches the flows in an Connect Customer instance, with optional filtering.

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

Examples:

Request syntax with placeholder values


resp = client.search_contact_flows({
  instance_id: "InstanceId", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_filter: {
    tag_filter: {
      or_conditions: [
        [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      ],
      and_conditions: [
        {
          tag_key: "String",
          tag_value: "String",
        },
      ],
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
    flow_attribute_filter: {
      or_conditions: [
        {
          tag_conditions: [
            {
              tag_key: "String",
              tag_value: "String",
            },
          ],
          contact_flow_type_condition: {
            contact_flow_type: "CONTACT_FLOW", # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER, CAMPAIGN
          },
        },
      ],
      and_condition: {
        tag_conditions: [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
        contact_flow_type_condition: {
          contact_flow_type: "CONTACT_FLOW", # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER, CAMPAIGN
        },
      },
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
      contact_flow_type_condition: {
        contact_flow_type: "CONTACT_FLOW", # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER, CAMPAIGN
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive ContactFlowSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive ContactFlowSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
    type_condition: "CONTACT_FLOW", # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER, CAMPAIGN
    state_condition: "ACTIVE", # accepts ACTIVE, ARCHIVED
    status_condition: "PUBLISHED", # accepts PUBLISHED, SAVED
  },
})

Response structure


resp.contact_flows #=> Array
resp.contact_flows[0].arn #=> String
resp.contact_flows[0].id #=> String
resp.contact_flows[0].name #=> String
resp.contact_flows[0].type #=> String, one of "CONTACT_FLOW", "CUSTOMER_QUEUE", "CUSTOMER_HOLD", "CUSTOMER_WHISPER", "AGENT_HOLD", "AGENT_WHISPER", "OUTBOUND_WHISPER", "AGENT_TRANSFER", "QUEUE_TRANSFER", "CAMPAIGN"
resp.contact_flows[0].state #=> String, one of "ACTIVE", "ARCHIVED"
resp.contact_flows[0].status #=> String, one of "PUBLISHED", "SAVED"
resp.contact_flows[0].description #=> String
resp.contact_flows[0].content #=> String
resp.contact_flows[0].tags #=> Hash
resp.contact_flows[0].tags["TagKey"] #=> String
resp.contact_flows[0].flow_content_sha_256 #=> String
resp.contact_flows[0].version #=> Integer
resp.contact_flows[0].version_description #=> String
resp.contact_flows[0].last_modified_time #=> Time
resp.contact_flows[0].last_modified_region #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::ContactFlowSearchFilter) —

    Filters to be applied to search results.

  • :search_criteria (Types::ContactFlowSearchCriteria) —

    The search criteria to be used to return flows.

    The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.

Returns:

See Also:



20698
20699
20700
20701
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20698

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

#search_contacts(params = {}) ⇒ Types::SearchContactsResponse

Searches contacts in an Connect Customer instance.

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

Examples:

Request syntax with placeholder values


resp = client.search_contacts({
  instance_id: "InstanceId", # required
  time_range: { # required
    type: "INITIATION_TIMESTAMP", # required, accepts INITIATION_TIMESTAMP, SCHEDULED_TIMESTAMP, CONNECTED_TO_AGENT_TIMESTAMP, DISCONNECT_TIMESTAMP, ENQUEUE_TIMESTAMP
    start_time: Time.now, # required
    end_time: Time.now, # required
  },
  search_criteria: {
    name: {
      search_text: ["SearchText"], # required
      match_type: "MATCH_ALL", # required, accepts MATCH_ALL, MATCH_ANY, MATCH_EXACT, MATCH_NONE
    },
    agent_ids: ["AgentResourceId"],
    agent_hierarchy_groups: {
      l1_ids: ["HierarchyGroupId"],
      l2_ids: ["HierarchyGroupId"],
      l3_ids: ["HierarchyGroupId"],
      l4_ids: ["HierarchyGroupId"],
      l5_ids: ["HierarchyGroupId"],
    },
    channels: ["VOICE"], # accepts VOICE, CHAT, TASK, EMAIL
    contact_analysis: {
      transcript: {
        criteria: [ # required
          {
            participant_role: "AGENT", # required, accepts AGENT, CUSTOMER, SYSTEM, CUSTOM_BOT, SUPERVISOR
            search_text: ["SearchText"], # required
            match_type: "MATCH_ALL", # required, accepts MATCH_ALL, MATCH_ANY, MATCH_EXACT, MATCH_NONE
          },
        ],
        match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY, MATCH_EXACT, MATCH_NONE
      },
    },
    initiation_methods: ["INBOUND"], # accepts INBOUND, OUTBOUND, TRANSFER, QUEUE_TRANSFER, CALLBACK, API, DISCONNECT, MONITOR, EXTERNAL_OUTBOUND, WEBRTC_API, AGENT_REPLY, FLOW
    queue_ids: ["QueueId"],
    routing_criteria: {
      steps: [
        {
          agent_criteria: {
            agent_ids: ["AgentResourceId"],
            match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY, MATCH_EXACT, MATCH_NONE
          },
        },
      ],
    },
    additional_time_range: {
      criteria: [ # required
        {
          time_range: {
            type: "INITIATION_TIMESTAMP", # required, accepts INITIATION_TIMESTAMP, SCHEDULED_TIMESTAMP, CONNECTED_TO_AGENT_TIMESTAMP, DISCONNECT_TIMESTAMP, ENQUEUE_TIMESTAMP
            start_time: Time.now, # required
            end_time: Time.now, # required
          },
          timestamp_condition: {
            type: "INITIATION_TIMESTAMP", # required, accepts INITIATION_TIMESTAMP, SCHEDULED_TIMESTAMP, CONNECTED_TO_AGENT_TIMESTAMP, DISCONNECT_TIMESTAMP, ENQUEUE_TIMESTAMP
            condition_type: "NOT_EXISTS", # required, accepts NOT_EXISTS
          },
        },
      ],
      match_type: "MATCH_ALL", # required, accepts MATCH_ALL, MATCH_ANY, MATCH_EXACT, MATCH_NONE
    },
    searchable_contact_attributes: {
      criteria: [ # required
        {
          key: "SearchableContactAttributeKey", # required
          values: ["SearchableContactAttributeValue"], # required
        },
      ],
      match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY, MATCH_EXACT, MATCH_NONE
    },
    searchable_segment_attributes: {
      criteria: [ # required
        {
          key: "SearchableSegmentAttributeKey", # required
          values: ["SearchableSegmentAttributeValue"], # required
        },
      ],
      match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY, MATCH_EXACT, MATCH_NONE
    },
    active_regions: ["RegionName"],
    contact_tags: {
      or_conditions: [
        [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      ],
      and_conditions: [
        {
          tag_key: "String",
          tag_value: "String",
        },
      ],
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
    ai_agents: {
      criteria: [
        {
          id: "AiAgentId",
          version_number: 1,
          ai_agent_escalated: false,
          ai_use_case: "AgentAssistance", # accepts AgentAssistance, SelfService
        },
      ],
    },
  },
  max_results: 1,
  next_token: "LargeNextToken",
  sort: {
    field_name: "INITIATION_TIMESTAMP", # required, accepts INITIATION_TIMESTAMP, SCHEDULED_TIMESTAMP, CONNECTED_TO_AGENT_TIMESTAMP, DISCONNECT_TIMESTAMP, INITIATION_METHOD, CHANNEL, EXPIRY_TIMESTAMP
    order: "ASCENDING", # required, accepts ASCENDING, DESCENDING
  },
})

Response structure


resp.contacts #=> Array
resp.contacts[0].arn #=> String
resp.contacts[0].id #=> String
resp.contacts[0].initial_contact_id #=> String
resp.contacts[0].previous_contact_id #=> String
resp.contacts[0].initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR", "EXTERNAL_OUTBOUND", "WEBRTC_API", "AGENT_REPLY", "FLOW"
resp.contacts[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.contacts[0].queue_info.id #=> String
resp.contacts[0].queue_info.enqueue_timestamp #=> Time
resp.contacts[0].agent_info.id #=> String
resp.contacts[0].agent_info.connected_to_agent_timestamp #=> Time
resp.contacts[0].initiation_timestamp #=> Time
resp.contacts[0].disconnect_timestamp #=> Time
resp.contacts[0].scheduled_timestamp #=> Time
resp.contacts[0].segment_attributes #=> Hash
resp.contacts[0].segment_attributes["SegmentAttributeName"].value_string #=> String
resp.contacts[0].segment_attributes["SegmentAttributeName"].value_map #=> Hash
resp.contacts[0].segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"].value_string #=> String
resp.contacts[0].segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"].value_map #=> Types::SegmentAttributeValueMap
resp.contacts[0].segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"].value_integer #=> Integer
resp.contacts[0].segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"].value_list #=> Array
resp.contacts[0].segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"].value_list[0] #=> Types::SegmentAttributeValue
resp.contacts[0].segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"].value_arn #=> String
resp.contacts[0].name #=> String
resp.contacts[0].routing_criteria.steps #=> Array
resp.contacts[0].routing_criteria.steps[0].expiry.duration_in_seconds #=> Integer
resp.contacts[0].routing_criteria.steps[0].expiry.expiry_timestamp #=> Time
resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.name #=> String
resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.value #=> String
resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.proficiency_level #=> Float
resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.range.min_proficiency_level #=> Float
resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.range.max_proficiency_level #=> Float
resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.match_criteria.agents_criteria.agent_ids #=> Array
resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.match_criteria.agents_criteria.agent_ids[0] #=> String
resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.comparison_operator #=> String
resp.contacts[0].routing_criteria.steps[0].expression.and_expression #=> Array
resp.contacts[0].routing_criteria.steps[0].expression.and_expression[0] #=> Types::Expression
resp.contacts[0].routing_criteria.steps[0].expression.or_expression #=> Array
resp.contacts[0].routing_criteria.steps[0].expression.or_expression[0] #=> Types::Expression
resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.name #=> String
resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.value #=> String
resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.proficiency_level #=> Float
resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.range.min_proficiency_level #=> Float
resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.range.max_proficiency_level #=> Float
resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.match_criteria.agents_criteria.agent_ids #=> Array
resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.match_criteria.agents_criteria.agent_ids[0] #=> String
resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.comparison_operator #=> String
resp.contacts[0].routing_criteria.steps[0].status #=> String, one of "ACTIVE", "INACTIVE", "JOINED", "EXPIRED"
resp.contacts[0].routing_criteria.activation_timestamp #=> Time
resp.contacts[0].routing_criteria.index #=> Integer
resp.contacts[0].tags #=> Hash
resp.contacts[0].tags["ContactTagKey"] #=> String
resp.contacts[0].global_resiliency_metadata.active_region #=> String
resp.contacts[0].global_resiliency_metadata.origin_region #=> String
resp.contacts[0].global_resiliency_metadata.traffic_distribution_group_id #=> String
resp.contacts[0].ai_agent_info #=> Array
resp.contacts[0].ai_agent_info[0].ai_agent_version_id #=> String
resp.contacts[0].ai_agent_info[0].ai_agent_escalated #=> Boolean
resp.contacts[0].ai_agent_info[0].ai_use_case #=> String, one of "AgentAssistance", "SelfService"
resp.next_token #=> String
resp.total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :time_range (required, Types::SearchContactsTimeRange) —

    Time range that you want to search results.

  • :search_criteria (Types::SearchCriteria) —

    The search criteria to be used to return contacts.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :sort (Types::Sort) —

    Specifies a field to sort by and a sort order.

Returns:

See Also:



20923
20924
20925
20926
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20923

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

#search_data_tables(params = {}) ⇒ Types::SearchDataTablesResponse

Searches for data tables based on the table's ID, name, and description. In the future, this operation can support searching on attribute names and possibly primary values. Follows other search operations closely and supports both search criteria and filters.

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

Examples:

Request syntax with placeholder values


resp = client.search_data_tables({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
  search_filter: {
    attribute_filter: {
      or_conditions: [
        {
          tag_conditions: [
            {
              tag_key: "String",
              tag_value: "String",
            },
          ],
        },
      ],
      and_condition: {
        tag_conditions: [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      },
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive DataTableSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive DataTableSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
  },
})

Response structure


resp.data_tables #=> Array
resp.data_tables[0].name #=> String
resp.data_tables[0].id #=> String
resp.data_tables[0].arn #=> String
resp.data_tables[0].time_zone #=> String
resp.data_tables[0].description #=> String
resp.data_tables[0].value_lock_level #=> String, one of "NONE", "DATA_TABLE", "PRIMARY_VALUE", "ATTRIBUTE", "VALUE"
resp.data_tables[0].lock_version.data_table #=> String
resp.data_tables[0].lock_version.attribute #=> String
resp.data_tables[0].lock_version.primary_values #=> String
resp.data_tables[0].lock_version.value #=> String
resp.data_tables[0].version #=> String
resp.data_tables[0].version_description #=> String
resp.data_tables[0].status #=> String, one of "PUBLISHED"
resp.data_tables[0].created_time #=> Time
resp.data_tables[0].last_modified_time #=> Time
resp.data_tables[0].last_modified_region #=> String
resp.data_tables[0].tags #=> Hash
resp.data_tables[0].tags["TagKey"] #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance to search within.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of data tables to return in one page of results.

  • :search_filter (Types::DataTableSearchFilter) —

    Optional filters to apply to the search results, such as tag-based filtering for attribute-based access control.

  • :search_criteria (Types::DataTableSearchCriteria) —

    Search criteria including string conditions for matching table names, descriptions, or resource IDs. Supports STARTS_WITH, CONTAINS, and EXACT comparison types.

Returns:

See Also:



21040
21041
21042
21043
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21040

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

#search_email_addresses(params = {}) ⇒ Types::SearchEmailAddressesResponse

Searches email address in an instance, with optional filtering.

Examples:

Request syntax with placeholder values


resp = client.search_email_addresses({
  instance_id: "InstanceId", # required
  max_results: 1,
  next_token: "NextToken2500",
  search_criteria: {
    or_conditions: [
      {
        # recursive EmailAddressSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive EmailAddressSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
  },
  search_filter: {
    tag_filter: {
      or_conditions: [
        [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      ],
      and_conditions: [
        {
          tag_key: "String",
          tag_value: "String",
        },
      ],
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
})

Response structure


resp.next_token #=> String
resp.email_addresses #=> Array
resp.email_addresses[0].email_address_id #=> String
resp.email_addresses[0].email_address_arn #=> String
resp.email_addresses[0].email_address #=> String
resp.email_addresses[0].description #=> String
resp.email_addresses[0].display_name #=> String
resp.email_addresses[0].alias_configurations #=> Array
resp.email_addresses[0].alias_configurations[0].email_address_id #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :search_criteria (Types::EmailAddressSearchCriteria) —

    The search criteria to be used to return email addresses.

  • :search_filter (Types::EmailAddressSearchFilter) —

    Filters to be applied to search results.

Returns:

See Also:



21139
21140
21141
21142
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21139

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

#search_evaluation_forms(params = {}) ⇒ Types::SearchEvaluationFormsResponse

Searches evaluation forms in an Connect Customer instance, with optional filtering.

Use cases

Following are common uses cases for this API:

  • List all evaluation forms in an instance.

  • Find all evaluation forms that meet specific criteria, such as Title, Description, Status, and more.

  • Find all evaluation forms that are tagged with a specific set of tags.

Important things to know

  • A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds.

^

Endpoints: See Connect Customer endpoints and quotas.

Examples:

Request syntax with placeholder values


resp = client.search_evaluation_forms({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
  search_criteria: {
    or_conditions: [
      {
        # recursive EvaluationFormSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive EvaluationFormSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
    number_condition: {
      field_name: "String",
      min_value: 1,
      max_value: 1,
      comparison_type: "GREATER_OR_EQUAL", # accepts GREATER_OR_EQUAL, GREATER, LESSER_OR_EQUAL, LESSER, EQUAL, NOT_EQUAL, RANGE
    },
    boolean_condition: {
      field_name: "String",
      comparison_type: "IS_TRUE", # accepts IS_TRUE, IS_FALSE
    },
    date_time_condition: {
      field_name: "String",
      min_value: "DateTimeFormat",
      max_value: "DateTimeFormat",
      comparison_type: "GREATER_THAN", # accepts GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN_OR_EQUAL_TO, EQUAL_TO, RANGE
    },
  },
  search_filter: {
    attribute_filter: {
      or_conditions: [
        {
          tag_conditions: [
            {
              tag_key: "String",
              tag_value: "String",
            },
          ],
        },
      ],
      and_condition: {
        tag_conditions: [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      },
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
})

Response structure


resp.evaluation_form_search_summary_list #=> Array
resp.evaluation_form_search_summary_list[0].evaluation_form_id #=> String
resp.evaluation_form_search_summary_list[0].evaluation_form_arn #=> String
resp.evaluation_form_search_summary_list[0].title #=> String
resp.evaluation_form_search_summary_list[0].status #=> String, one of "DRAFT", "ACTIVE"
resp.evaluation_form_search_summary_list[0].description #=> String
resp.evaluation_form_search_summary_list[0].created_time #=> Time
resp.evaluation_form_search_summary_list[0].created_by #=> String
resp.evaluation_form_search_summary_list[0].last_modified_time #=> Time
resp.evaluation_form_search_summary_list[0].last_modified_by #=> String
resp.evaluation_form_search_summary_list[0].last_activated_time #=> Time
resp.evaluation_form_search_summary_list[0].last_activated_by #=> String
resp.evaluation_form_search_summary_list[0].latest_version #=> Integer
resp.evaluation_form_search_summary_list[0].active_version #=> Integer
resp.evaluation_form_search_summary_list[0].auto_evaluation_enabled #=> Boolean
resp.evaluation_form_search_summary_list[0].evaluation_form_language #=> String, one of "de-DE", "en-US", "es-ES", "fr-FR", "it-IT", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "ms-MY"
resp.evaluation_form_search_summary_list[0].contact_interaction_type #=> String, one of "AGENT", "AUTOMATED", "CUSTOMER"
resp.evaluation_form_search_summary_list[0].tags #=> Hash
resp.evaluation_form_search_summary_list[0].tags["TagKey"] #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_criteria (Types::EvaluationFormSearchCriteria) —

    The search criteria to be used to return evaluation forms.

  • :search_filter (Types::EvaluationFormSearchFilter) —

    Filters to be applied to search results.

Returns:

See Also:



21297
21298
21299
21300
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21297

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

#search_hours_of_operation_overrides(params = {}) ⇒ Types::SearchHoursOfOperationOverridesResponse

Searches the hours of operation overrides.

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

Examples:

Request syntax with placeholder values


resp = client.search_hours_of_operation_overrides({
  instance_id: "InstanceId", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_filter: {
    tag_filter: {
      or_conditions: [
        [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      ],
      and_conditions: [
        {
          tag_key: "String",
          tag_value: "String",
        },
      ],
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive HoursOfOperationOverrideSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive HoursOfOperationOverrideSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
    date_condition: {
      field_name: "String",
      value: "DateYearMonthDayFormat",
      comparison_type: "GREATER_THAN", # accepts GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN_OR_EQUAL_TO, EQUAL_TO
    },
  },
})

Response structure


resp.hours_of_operation_overrides #=> Array
resp.hours_of_operation_overrides[0].hours_of_operation_override_id #=> String
resp.hours_of_operation_overrides[0].hours_of_operation_id #=> String
resp.hours_of_operation_overrides[0].hours_of_operation_arn #=> String
resp.hours_of_operation_overrides[0].name #=> String
resp.hours_of_operation_overrides[0].description #=> String
resp.hours_of_operation_overrides[0].config #=> Array
resp.hours_of_operation_overrides[0].config[0].day #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
resp.hours_of_operation_overrides[0].config[0].start_time.hours #=> Integer
resp.hours_of_operation_overrides[0].config[0].start_time.minutes #=> Integer
resp.hours_of_operation_overrides[0].config[0].end_time.hours #=> Integer
resp.hours_of_operation_overrides[0].config[0].end_time.minutes #=> Integer
resp.hours_of_operation_overrides[0].effective_from #=> String
resp.hours_of_operation_overrides[0].effective_till #=> String
resp.hours_of_operation_overrides[0].recurrence_config.recurrence_pattern.frequency #=> String, one of "WEEKLY", "MONTHLY", "YEARLY"
resp.hours_of_operation_overrides[0].recurrence_config.recurrence_pattern.interval #=> Integer
resp.hours_of_operation_overrides[0].recurrence_config.recurrence_pattern.by_month #=> Array
resp.hours_of_operation_overrides[0].recurrence_config.recurrence_pattern.by_month[0] #=> Integer
resp.hours_of_operation_overrides[0].recurrence_config.recurrence_pattern.by_month_day #=> Array
resp.hours_of_operation_overrides[0].recurrence_config.recurrence_pattern.by_month_day[0] #=> Integer
resp.hours_of_operation_overrides[0].recurrence_config.recurrence_pattern.by_weekday_occurrence #=> Array
resp.hours_of_operation_overrides[0].recurrence_config.recurrence_pattern.by_weekday_occurrence[0] #=> Integer
resp.hours_of_operation_overrides[0].override_type #=> String, one of "STANDARD", "OPEN", "CLOSED"
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::HoursOfOperationSearchFilter) —

    Filters to be applied to search results.

  • :search_criteria (Types::HoursOfOperationOverrideSearchCriteria) —

    The search criteria to be used to return hours of operations overrides.

Returns:

See Also:



21414
21415
21416
21417
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21414

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

#search_hours_of_operations(params = {}) ⇒ Types::SearchHoursOfOperationsResponse

Searches the hours of operation in an Connect Customer instance, with optional filtering.

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

Examples:

Request syntax with placeholder values


resp = client.search_hours_of_operations({
  instance_id: "InstanceId", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_filter: {
    tag_filter: {
      or_conditions: [
        [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      ],
      and_conditions: [
        {
          tag_key: "String",
          tag_value: "String",
        },
      ],
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive HoursOfOperationSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive HoursOfOperationSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
  },
})

Response structure


resp.hours_of_operations #=> Array
resp.hours_of_operations[0].hours_of_operation_id #=> String
resp.hours_of_operations[0].hours_of_operation_arn #=> String
resp.hours_of_operations[0].name #=> String
resp.hours_of_operations[0].description #=> String
resp.hours_of_operations[0].time_zone #=> String
resp.hours_of_operations[0].config #=> Array
resp.hours_of_operations[0].config[0].day #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
resp.hours_of_operations[0].config[0].start_time.hours #=> Integer
resp.hours_of_operations[0].config[0].start_time.minutes #=> Integer
resp.hours_of_operations[0].config[0].end_time.hours #=> Integer
resp.hours_of_operations[0].config[0].end_time.minutes #=> Integer
resp.hours_of_operations[0].parent_hours_of_operations #=> Array
resp.hours_of_operations[0].parent_hours_of_operations[0].name #=> String
resp.hours_of_operations[0].parent_hours_of_operations[0].id #=> String
resp.hours_of_operations[0].parent_hours_of_operations[0].arn #=> String
resp.hours_of_operations[0].tags #=> Hash
resp.hours_of_operations[0].tags["TagKey"] #=> String
resp.hours_of_operations[0].last_modified_time #=> Time
resp.hours_of_operations[0].last_modified_region #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::HoursOfOperationSearchFilter) —

    Filters to be applied to search results.

  • :search_criteria (Types::HoursOfOperationSearchCriteria) —

    The search criteria to be used to return hours of operations.

Returns:

See Also:



21528
21529
21530
21531
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21528

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

#search_metrics(params = {}) ⇒ Types::SearchMetricsResponse

Searches for metrics in the specified Connect Customer instance using search criteria and optional tag-based filters. Use pagination to ensure that the operation returns quickly and successfully.

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

Examples:

Request syntax with placeholder values


resp = client.search_metrics({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
  search_filter: {
    tag_filter: {
      or_conditions: [
        [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      ],
      and_conditions: [
        {
          tag_key: "String",
          tag_value: "String",
        },
      ],
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive MetricSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive MetricSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
    boolean_condition: {
      field_name: "String",
      comparison_type: "IS_TRUE", # accepts IS_TRUE, IS_FALSE
    },
  },
})

Response structure


resp.metrics #=> Array
resp.metrics[0].arn #=> String
resp.metrics[0].id #=> String
resp.metrics[0].name #=> String
resp.metrics[0].description #=> String
resp.metrics[0].metric_calculation.calculation_components #=> Array
resp.metrics[0].metric_calculation.calculation_components[0].alias #=> String
resp.metrics[0].metric_calculation.calculation_components[0].metric_name #=> String
resp.metrics[0].metric_calculation.calculation_components[0].metric_id #=> String
resp.metrics[0].metric_calculation.calculation_components[0].metric_filters #=> Array
resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].metric_filter_key #=> String
resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].negate #=> Boolean
resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].number_condition.comparison #=> String, one of "LESSER", "LESSER_OR_EQUAL", "GREATER", "GREATER_OR_EQUAL"
resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].number_condition.values #=> Array
resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].number_condition.values[0] #=> Float
resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].string_condition.comparison #=> String, one of "MATCHES_ANY", "MATCHES_NONE"
resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].string_condition.values #=> Array
resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].string_condition.values[0] #=> String
resp.metrics[0].metric_calculation.calculation_components[0].metric_filters[0].boolean_condition.comparison #=> String, one of "IS_TRUE", "IS_FALSE"
resp.metrics[0].metric_calculation.calculation #=> String
resp.metrics[0].creation_method #=> String, one of "SERVICE_LEVEL_BUILDER", "METRIC_BUILDER"
resp.metrics[0].status #=> String, one of "PUBLISHED", "SAVED"
resp.metrics[0].type #=> String, one of "AWS_MANAGED", "CUSTOMER_MANAGED"
resp.metrics[0].unit #=> String, one of "INTEGER", "DOUBLE", "PERCENT", "SECONDS"
resp.metrics[0].positive_trend_indicator #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL"
resp.metrics[0].groupings #=> Array
resp.metrics[0].groupings[0] #=> String
resp.metrics[0].filters #=> Array
resp.metrics[0].filters[0].id #=> String
resp.metrics[0].filters[0].type #=> String, one of "METRIC_LEVEL", "RESOURCE_LEVEL"
resp.metrics[0].effective_time #=> Time
resp.metrics[0].refresh_rate #=> Integer
resp.metrics[0].category #=> String
resp.metrics[0].supported_stats #=> Array
resp.metrics[0].supported_stats[0] #=> String
resp.metrics[0].default_stat #=> String
resp.metrics[0].supports_preaggregate_calculation #=> Boolean
resp.metrics[0].supports_custom_calculation #=> Boolean
resp.metrics[0].primary_event_source #=> String
resp.metrics[0].primary_event_source_effective_timestamp_type #=> String
resp.metrics[0].created_time #=> Time
resp.metrics[0].created_user.connect_user_arn #=> String
resp.metrics[0].created_user.aws_identity_arn #=> String
resp.metrics[0].last_modified_region #=> String
resp.metrics[0].last_modified_time #=> Time
resp.metrics[0].last_modified_user.connect_user_arn #=> String
resp.metrics[0].last_modified_user.aws_identity_arn #=> String
resp.metrics[0].tags #=> Hash
resp.metrics[0].tags["TagKey"] #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::MetricSearchFilter) —

    Filters to be applied to search results.

  • :search_criteria (Types::MetricSearchCriteria) —

    The search criteria to filter the metrics.

Returns:

See Also:



21676
21677
21678
21679
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21676

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

#search_notifications(params = {}) ⇒ Types::SearchNotificationsResponse

Searches for notifications based on specified criteria and filters. Returns a paginated list of notifications matching the search parameters, ordered by descending creation time. Supports filtering by content and tags.

Examples:

Request syntax with placeholder values


resp = client.search_notifications({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
  search_filter: {
    attribute_filter: {
      or_conditions: [
        {
          tag_conditions: [
            {
              tag_key: "String",
              tag_value: "String",
            },
          ],
        },
      ],
      and_condition: {
        tag_conditions: [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      },
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive NotificationSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive NotificationSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
  },
})

Response structure


resp.notifications #=> Array
resp.notifications[0].id #=> String
resp.notifications[0].arn #=> String
resp.notifications[0].instance_id #=> String
resp.notifications[0].content #=> Hash
resp.notifications[0].content["LocaleCode"] #=> String
resp.notifications[0].priority #=> String, one of "URGENT", "HIGH", "LOW"
resp.notifications[0].recipients #=> Array
resp.notifications[0].recipients[0] #=> String
resp.notifications[0].created_at #=> Time
resp.notifications[0].expires_at #=> Time
resp.notifications[0].last_modified_region #=> String
resp.notifications[0].last_modified_time #=> Time
resp.notifications[0].tags #=> Hash
resp.notifications[0].tags["TagKey"] #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.

  • :max_results (Integer) —

    The maximum number of results to return per page. Valid range is 1-100.

  • :search_filter (Types::NotificationSearchFilter) —

    Filters to apply to the search results, such as tag-based filters.

  • :search_criteria (Types::NotificationSearchCriteria) —

    The search criteria to apply when searching for notifications. Supports filtering by notification ID and message content using comparison types such as STARTS_WITH, CONTAINS, and EXACT.

Returns:

See Also:



21791
21792
21793
21794
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21791

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

#search_predefined_attributes(params = {}) ⇒ Types::SearchPredefinedAttributesResponse

Searches predefined attributes that meet certain criteria. A predefined attribute is made up of a name and a value. You can use predefined attributes for:

For the predefined attributes per instance quota, see Connect Customer quotas.

Endpoints: See Connect Customer endpoints and quotas.

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

Examples:

Request syntax with placeholder values


resp = client.search_predefined_attributes({
  instance_id: "InstanceId", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_criteria: {
    or_conditions: [
      {
        # recursive PredefinedAttributeSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive PredefinedAttributeSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
  },
})

Response structure


resp.predefined_attributes #=> Array
resp.predefined_attributes[0].name #=> String
resp.predefined_attributes[0].values.string_list #=> Array
resp.predefined_attributes[0].values.string_list[0] #=> String
resp.predefined_attributes[0].purposes #=> Array
resp.predefined_attributes[0].purposes[0] #=> String
resp.predefined_attributes[0].attribute_configuration.enable_value_validation_on_association #=> Boolean
resp.predefined_attributes[0].attribute_configuration.is_read_only #=> Boolean
resp.predefined_attributes[0].last_modified_time #=> Time
resp.predefined_attributes[0].last_modified_region #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_criteria (Types::PredefinedAttributeSearchCriteria) —

    The search criteria to be used to return predefined attributes.

Returns:

See Also:



21888
21889
21890
21891
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21888

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

#search_prompts(params = {}) ⇒ Types::SearchPromptsResponse

Searches prompts in an Connect Customer instance, with optional filtering.

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

Examples:

Request syntax with placeholder values


resp = client.search_prompts({
  instance_id: "InstanceId", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_filter: {
    tag_filter: {
      or_conditions: [
        [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      ],
      and_conditions: [
        {
          tag_key: "String",
          tag_value: "String",
        },
      ],
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive PromptSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive PromptSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
  },
})

Response structure


resp.prompts #=> Array
resp.prompts[0].prompt_arn #=> String
resp.prompts[0].prompt_id #=> String
resp.prompts[0].name #=> String
resp.prompts[0].description #=> String
resp.prompts[0].tags #=> Hash
resp.prompts[0].tags["TagKey"] #=> String
resp.prompts[0].last_modified_time #=> Time
resp.prompts[0].last_modified_region #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::PromptSearchFilter) —

    Filters to be applied to search results.

  • :search_criteria (Types::PromptSearchCriteria) —

    The search criteria to be used to return prompts.

Returns:

See Also:



21991
21992
21993
21994
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21991

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

#search_queues(params = {}) ⇒ Types::SearchQueuesResponse

Searches queues in an Connect Customer instance, with optional filtering.

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

Examples:

Request syntax with placeholder values


resp = client.search_queues({
  instance_id: "InstanceId", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_filter: {
    tag_filter: {
      or_conditions: [
        [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      ],
      and_conditions: [
        {
          tag_key: "String",
          tag_value: "String",
        },
      ],
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive QueueSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive QueueSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
    queue_type_condition: "STANDARD", # accepts STANDARD
  },
})

Response structure


resp.queues #=> Array
resp.queues[0].name #=> String
resp.queues[0].queue_arn #=> String
resp.queues[0].queue_id #=> String
resp.queues[0].description #=> String
resp.queues[0].outbound_caller_config.outbound_caller_id_name #=> String
resp.queues[0].outbound_caller_config.outbound_caller_id_number_id #=> String
resp.queues[0].outbound_caller_config.outbound_flow_id #=> String
resp.queues[0].outbound_email_config.outbound_email_address_id #=> String
resp.queues[0].hours_of_operation_id #=> String
resp.queues[0].max_contacts #=> Integer
resp.queues[0].status #=> String, one of "ENABLED", "DISABLED"
resp.queues[0].tags #=> Hash
resp.queues[0].tags["TagKey"] #=> String
resp.queues[0].last_modified_time #=> Time
resp.queues[0].last_modified_region #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::QueueSearchFilter) —

    Filters to be applied to search results.

  • :search_criteria (Types::QueueSearchCriteria) —

    The search criteria to be used to return queues.

    The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

Returns:

See Also:



22109
22110
22111
22112
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22109

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

#search_quick_connects(params = {}) ⇒ Types::SearchQuickConnectsResponse

Searches quick connects in an Connect Customer instance, with optional filtering.

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

Examples:

Request syntax with placeholder values


resp = client.search_quick_connects({
  instance_id: "InstanceId", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_filter: {
    tag_filter: {
      or_conditions: [
        [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      ],
      and_conditions: [
        {
          tag_key: "String",
          tag_value: "String",
        },
      ],
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive QuickConnectSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive QuickConnectSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
  },
})

Response structure


resp.quick_connects #=> Array
resp.quick_connects[0].quick_connect_arn #=> String
resp.quick_connects[0].quick_connect_id #=> String
resp.quick_connects[0].name #=> String
resp.quick_connects[0].description #=> String
resp.quick_connects[0].quick_connect_config.quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER", "FLOW"
resp.quick_connects[0].quick_connect_config.user_config.user_id #=> String
resp.quick_connects[0].quick_connect_config.user_config.contact_flow_id #=> String
resp.quick_connects[0].quick_connect_config.queue_config.queue_id #=> String
resp.quick_connects[0].quick_connect_config.queue_config.contact_flow_id #=> String
resp.quick_connects[0].quick_connect_config.phone_config.phone_number #=> String
resp.quick_connects[0].quick_connect_config.flow_config.contact_flow_id #=> String
resp.quick_connects[0].tags #=> Hash
resp.quick_connects[0].tags["TagKey"] #=> String
resp.quick_connects[0].last_modified_time #=> Time
resp.quick_connects[0].last_modified_region #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::QuickConnectSearchFilter) —

    Filters to be applied to search results.

  • :search_criteria (Types::QuickConnectSearchCriteria) —

    The search criteria to be used to return quick connects.

Returns:

See Also:



22219
22220
22221
22222
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22219

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

#search_resource_tags(params = {}) ⇒ Types::SearchResourceTagsResponse

Searches tags used in an Connect Customer instance using optional search criteria.

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

Examples:

Request syntax with placeholder values


resp = client.search_resource_tags({
  instance_id: "InstanceIdOrArn", # required
  resource_types: ["String"],
  next_token: "NextToken2500",
  max_results: 1,
  search_criteria: {
    tag_search_condition: {
      tag_key: "TagKeyString",
      tag_value: "TagValueString",
      tag_key_comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
      tag_value_comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
  },
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the Amazon Resource Name (ARN) of the instance.

  • :resource_types (Array<String>) —

    The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types. Note that lowercase and - are required.

    Supported resource types

    • agent

    • agent-state

    • routing-profile

    • standard-queue

    • security-profile

    • operating-hours

    • prompt

    • contact-flow

    • flow- module

    • transfer-destination (also known as quick connect)

    • metric

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_criteria (Types::ResourceTagsSearchCriteria) —

    The search criteria to be used to return tags.

Returns:

See Also:



22306
22307
22308
22309
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22306

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

#search_routing_profiles(params = {}) ⇒ Types::SearchRoutingProfilesResponse

Searches routing profiles in an Connect Customer instance, with optional filtering.

SearchRoutingProfiles does not populate LastModifiedRegion, LastModifiedTime, MediaConcurrencies.CrossChannelBehavior, and AgentAvailabilityTimer in its response, but DescribeRoutingProfile does.

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

Examples:

Request syntax with placeholder values


resp = client.search_routing_profiles({
  instance_id: "InstanceId", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_filter: {
    tag_filter: {
      or_conditions: [
        [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      ],
      and_conditions: [
        {
          tag_key: "String",
          tag_value: "String",
        },
      ],
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive RoutingProfileSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive RoutingProfileSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
  },
})

Response structure


resp.routing_profiles #=> Array
resp.routing_profiles[0].instance_id #=> String
resp.routing_profiles[0].name #=> String
resp.routing_profiles[0].routing_profile_arn #=> String
resp.routing_profiles[0].routing_profile_id #=> String
resp.routing_profiles[0].description #=> String
resp.routing_profiles[0].media_concurrencies #=> Array
resp.routing_profiles[0].media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.routing_profiles[0].media_concurrencies[0].concurrency #=> Integer
resp.routing_profiles[0].media_concurrencies[0].cross_channel_behavior.behavior_type #=> String, one of "ROUTE_CURRENT_CHANNEL_ONLY", "ROUTE_ANY_CHANNEL"
resp.routing_profiles[0].default_outbound_queue_id #=> String
resp.routing_profiles[0].tags #=> Hash
resp.routing_profiles[0].tags["TagKey"] #=> String
resp.routing_profiles[0].number_of_associated_queues #=> Integer
resp.routing_profiles[0].number_of_associated_manual_assignment_queues #=> Integer
resp.routing_profiles[0].number_of_associated_users #=> Integer
resp.routing_profiles[0].agent_availability_timer #=> String, one of "TIME_SINCE_LAST_ACTIVITY", "TIME_SINCE_LAST_INBOUND"
resp.routing_profiles[0].last_modified_time #=> Time
resp.routing_profiles[0].last_modified_region #=> String
resp.routing_profiles[0].is_default #=> Boolean
resp.routing_profiles[0].associated_queue_ids #=> Array
resp.routing_profiles[0].associated_queue_ids[0] #=> String
resp.routing_profiles[0].associated_manual_assignment_queue_ids #=> Array
resp.routing_profiles[0].associated_manual_assignment_queue_ids[0] #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::RoutingProfileSearchFilter) —

    Filters to be applied to search results.

  • :search_criteria (Types::RoutingProfileSearchCriteria) —

    The search criteria to be used to return routing profiles.

    The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

Returns:

See Also:



22442
22443
22444
22445
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22442

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

#search_rules(params = {}) ⇒ Types::SearchRulesResponse

Searches rules in an Connect Customer instance, with optional filtering.

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

Examples:

Example: SearchRules


# Searches for published rules in an Amazon Connect instance.

resp = client.search_rules({
  instance_id: "12345678-1234-1234-1234-123456789012", 
  max_results: 10, 
  search_criteria: {
    string_condition: {
      comparison_type: "EXACT", 
      field_name: "PublishStatus", 
      value: "PUBLISHED", 
    }, 
  }, 
})

resp.to_h outputs the following:
{
  approximate_total_count: 1, 
  rules: [
    {
      action_summaries: [
        {
          action_type: "CREATE_TASK", 
        }, 
      ], 
      created_time: Time.parse("2026-01-15T10:00:00Z"), 
      last_updated_by: "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/agent/agent-id", 
      last_updated_time: Time.parse("2026-03-20T14:30:00Z"), 
      name: "MyRule", 
      publish_status: "PUBLISHED", 
      rule_arn: "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/rule/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", 
      rule_capability_tiers: [
      ], 
      rule_id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", 
      trigger_event_source: {
        event_source_name: "OnPostCallAnalysisAvailable", 
      }, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.search_rules({
  instance_id: "InstanceId", # required
  max_results: 1,
  next_token: "NextToken2500",
  search_criteria: {
    or_conditions: [
      {
        # recursive RulesSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive RulesSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
  },
  search_filter: {
    attribute_filter: {
      or_conditions: [
        {
          tag_conditions: [
            {
              tag_key: "String",
              tag_value: "String",
            },
          ],
        },
      ],
      and_condition: {
        tag_conditions: [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      },
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
})

Response structure


resp.rules #=> Array
resp.rules[0].name #=> String
resp.rules[0].rule_id #=> String
resp.rules[0].rule_arn #=> String
resp.rules[0].trigger_event_source.event_source_name #=> String, one of "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", "OnRealTimeChatAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnEmailAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate", "OnContactEvaluationSubmit", "OnMetricDataUpdate", "OnCaseCreate", "OnCaseUpdate", "OnSlaBreach", "OnAlertUpdate", "OnSchedulePublish", "OnScheduleUpdate", "OnScheduleTimeOffRequestActivity"
resp.rules[0].trigger_event_source.integration_association_id #=> String
resp.rules[0].action_summaries #=> Array
resp.rules[0].action_summaries[0].action_type #=> String, one of "CREATE_TASK", "ASSIGN_CONTACT_CATEGORY", "GENERATE_EVENTBRIDGE_EVENT", "SEND_NOTIFICATION", "CREATE_CASE", "UPDATE_CASE", "ASSIGN_SLA", "END_ASSOCIATED_TASKS", "SUBMIT_AUTO_EVALUATION"
resp.rules[0].rule_capability_tiers #=> Array
resp.rules[0].rule_capability_tiers[0] #=> String, one of "GenerativeAI"
resp.rules[0].publish_status #=> String, one of "DRAFT", "PUBLISHED"
resp.rules[0].created_time #=> Time
resp.rules[0].last_updated_time #=> Time
resp.rules[0].last_updated_by #=> String
resp.rules[0].tags #=> Hash
resp.rules[0].tags["TagKey"] #=> String
resp.approximate_total_count #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :search_criteria (Types::RulesSearchCriteria) —

    The search criteria to be used to return rules.

  • :search_filter (Types::RulesSearchFilter) —

    Filters to be applied to search results, such as tag-based filters.

Returns:

See Also:



22599
22600
22601
22602
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22599

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

#search_security_profiles(params = {}) ⇒ Types::SearchSecurityProfilesResponse

Searches security profiles in an Connect Customer instance, with optional filtering.

For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

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

Examples:

Request syntax with placeholder values


resp = client.search_security_profiles({
  instance_id: "InstanceId", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_criteria: {
    or_conditions: [
      {
        # recursive SecurityProfileSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive SecurityProfileSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
  },
  search_filter: {
    tag_filter: {
      or_conditions: [
        [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      ],
      and_conditions: [
        {
          tag_key: "String",
          tag_value: "String",
        },
      ],
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
})

Response structure


resp.security_profiles #=> Array
resp.security_profiles[0].id #=> String
resp.security_profiles[0].organization_resource_id #=> String
resp.security_profiles[0].arn #=> String
resp.security_profiles[0].security_profile_name #=> String
resp.security_profiles[0].description #=> String
resp.security_profiles[0].tags #=> Hash
resp.security_profiles[0].tags["TagKey"] #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_criteria (Types::SecurityProfileSearchCriteria) —

    The search criteria to be used to return security profiles.

    The name field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

    The currently supported value for FieldName: name

  • :search_filter (Types::SecurityProfilesSearchFilter) —

    Filters to be applied to search results.

Returns:

See Also:



22721
22722
22723
22724
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22721

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

#search_test_cases(params = {}) ⇒ Types::SearchTestCasesResponse

Searches for test cases in the specified Amazon Connect instance, with optional filtering.

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

Examples:

Request syntax with placeholder values


resp = client.search_test_cases({
  instance_id: "InstanceIdOrArn", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_filter: {
    tag_filter: {
      or_conditions: [
        [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      ],
      and_conditions: [
        {
          tag_key: "String",
          tag_value: "String",
        },
      ],
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive TestCaseSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive TestCaseSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
    status_condition: "PUBLISHED", # accepts PUBLISHED, SAVED
  },
})

Response structure


resp.test_cases #=> Array
resp.test_cases[0].arn #=> String
resp.test_cases[0].id #=> String
resp.test_cases[0].name #=> String
resp.test_cases[0].content #=> String
resp.test_cases[0].entry_point.type #=> String, one of "VOICE_CALL", "CHAT"
resp.test_cases[0].entry_point.voice_call_entry_point_parameters.source_phone_number #=> String
resp.test_cases[0].entry_point.voice_call_entry_point_parameters.destination_phone_number #=> String
resp.test_cases[0].entry_point.voice_call_entry_point_parameters.flow_id #=> String
resp.test_cases[0].entry_point.chat_entry_point_parameters.flow_id #=> String
resp.test_cases[0].initialization_data #=> String
resp.test_cases[0].description #=> String
resp.test_cases[0].status #=> String, one of "PUBLISHED", "SAVED"
resp.test_cases[0].last_modified_time #=> Time
resp.test_cases[0].last_modified_region #=> String
resp.test_cases[0].tags #=> Hash
resp.test_cases[0].tags["TagKey"] #=> String
resp.test_cases[0].test_case_sha_256 #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::TestCaseSearchFilter) —

    Filters to be applied to search results.

  • :search_criteria (Types::TestCaseSearchCriteria) —

    The search criteria to be used to return test cases.

Returns:

See Also:



22830
22831
22832
22833
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22830

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

#search_user_hierarchy_groups(params = {}) ⇒ Types::SearchUserHierarchyGroupsResponse

Searches UserHierarchyGroups in an Connect Customer instance, with optional filtering.

The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.

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

Examples:

Request syntax with placeholder values


resp = client.search_user_hierarchy_groups({
  instance_id: "InstanceId", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_filter: {
    attribute_filter: {
      or_conditions: [
        {
          tag_conditions: [
            {
              tag_key: "String",
              tag_value: "String",
            },
          ],
        },
      ],
      and_condition: {
        tag_conditions: [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      },
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive UserHierarchyGroupSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive UserHierarchyGroupSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
  },
})

Response structure


resp.user_hierarchy_groups #=> Array
resp.user_hierarchy_groups[0].id #=> String
resp.user_hierarchy_groups[0].arn #=> String
resp.user_hierarchy_groups[0].name #=> String
resp.user_hierarchy_groups[0].level_id #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_one.id #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_one.arn #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_one.name #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_one.last_modified_time #=> Time
resp.user_hierarchy_groups[0].hierarchy_path.level_one.last_modified_region #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_two.id #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_two.arn #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_two.name #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_two.last_modified_time #=> Time
resp.user_hierarchy_groups[0].hierarchy_path.level_two.last_modified_region #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_three.id #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_three.arn #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_three.name #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_three.last_modified_time #=> Time
resp.user_hierarchy_groups[0].hierarchy_path.level_three.last_modified_region #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_four.id #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_four.arn #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_four.name #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_four.last_modified_time #=> Time
resp.user_hierarchy_groups[0].hierarchy_path.level_four.last_modified_region #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_five.id #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_five.arn #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_five.name #=> String
resp.user_hierarchy_groups[0].hierarchy_path.level_five.last_modified_time #=> Time
resp.user_hierarchy_groups[0].hierarchy_path.level_five.last_modified_region #=> String
resp.user_hierarchy_groups[0].tags #=> Hash
resp.user_hierarchy_groups[0].tags["TagKey"] #=> String
resp.user_hierarchy_groups[0].last_modified_time #=> Time
resp.user_hierarchy_groups[0].last_modified_region #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::UserHierarchyGroupSearchFilter) —

    Filters to be applied to search results.

  • :search_criteria (Types::UserHierarchyGroupSearchCriteria) —

    The search criteria to be used to return UserHierarchyGroups.

Returns:

See Also:



22962
22963
22964
22965
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22962

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

#search_users(params = {}) ⇒ Types::SearchUsersResponse

Searches users in an Connect Customer instance, with optional filtering.

AfterContactWorkTimeLimit is returned in milliseconds.

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

Examples:

Request syntax with placeholder values


resp = client.search_users({
  instance_id: "InstanceId", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_filter: {
    tag_filter: {
      or_conditions: [
        [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      ],
      and_conditions: [
        {
          tag_key: "String",
          tag_value: "String",
        },
      ],
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
    user_attribute_filter: {
      or_conditions: [
        {
          tag_conditions: [
            {
              tag_key: "String",
              tag_value: "String",
            },
          ],
          hierarchy_group_condition: {
            value: "String",
            hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
          },
        },
      ],
      and_condition: {
        tag_conditions: [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
        hierarchy_group_condition: {
          value: "String",
          hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
        },
      },
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
      hierarchy_group_condition: {
        value: "String",
        hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive UserSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive UserSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
    list_condition: {
      target_list_type: "PROFICIENCIES", # accepts PROFICIENCIES
      conditions: [
        {
          string_condition: {
            field_name: "String",
            value: "String",
            comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
          },
          number_condition: {
            field_name: "String",
            min_value: 1,
            max_value: 1,
            comparison_type: "GREATER_OR_EQUAL", # accepts GREATER_OR_EQUAL, GREATER, LESSER_OR_EQUAL, LESSER, EQUAL, NOT_EQUAL, RANGE
          },
        },
      ],
    },
    hierarchy_group_condition: {
      value: "String",
      hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
    },
  },
})

Response structure


resp.users #=> Array
resp.users[0].arn #=> String
resp.users[0].directory_user_id #=> String
resp.users[0].hierarchy_group_id #=> String
resp.users[0].id #=> String
resp.users[0].identity_info.first_name #=> String
resp.users[0].identity_info.last_name #=> String
resp.users[0].phone_config.phone_type #=> String, one of "SOFT_PHONE", "DESK_PHONE"
resp.users[0].phone_config.auto_accept #=> Boolean
resp.users[0].phone_config.after_contact_work_time_limit #=> Integer
resp.users[0].phone_config.desk_phone_number #=> String
resp.users[0].phone_config.persistent_connection #=> Boolean
resp.users[0].routing_profile_id #=> String
resp.users[0].security_profile_ids #=> Array
resp.users[0].security_profile_ids[0] #=> String
resp.users[0].tags #=> Hash
resp.users[0].tags["TagKey"] #=> String
resp.users[0].username #=> String
resp.users[0].auto_accept_configs #=> Array
resp.users[0].auto_accept_configs[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.users[0].auto_accept_configs[0].auto_accept #=> Boolean
resp.users[0].auto_accept_configs[0].agent_first_callback_auto_accept #=> Boolean
resp.users[0].after_contact_work_configs #=> Array
resp.users[0].after_contact_work_configs[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.users[0].after_contact_work_configs[0].after_contact_work_config.after_contact_work_time_limit #=> Integer
resp.users[0].after_contact_work_configs[0].agent_first_callback_after_contact_work_config.after_contact_work_time_limit #=> Integer
resp.users[0].phone_number_configs #=> Array
resp.users[0].phone_number_configs[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.users[0].phone_number_configs[0].phone_type #=> String, one of "SOFT_PHONE", "DESK_PHONE"
resp.users[0].phone_number_configs[0].phone_number #=> String
resp.users[0].persistent_connection_configs #=> Array
resp.users[0].persistent_connection_configs[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.users[0].persistent_connection_configs[0].persistent_connection #=> Boolean
resp.users[0].voice_enhancement_configs #=> Array
resp.users[0].voice_enhancement_configs[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
resp.users[0].voice_enhancement_configs[0].voice_enhancement_mode #=> String, one of "VOICE_ISOLATION", "NOISE_SUPPRESSION", "NONE"
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::UserSearchFilter) —

    Filters to be applied to search results.

  • :search_criteria (Types::UserSearchCriteria) —

    The search criteria to be used to return users.

    The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

Returns:

See Also:



23161
23162
23163
23164
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23161

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

#search_views(params = {}) ⇒ Types::SearchViewsResponse

Searches views based on name, description, or tags.

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

Examples:

Request syntax with placeholder values


resp = client.search_views({
  instance_id: "InstanceIdOrArn", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_filter: {
    attribute_filter: {
      or_conditions: [
        {
          tag_conditions: [
            {
              tag_key: "String",
              tag_value: "String",
            },
          ],
        },
      ],
      and_condition: {
        tag_conditions: [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      },
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive ViewSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive ViewSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
    view_type_condition: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED, AWS_MANAGED
    view_status_condition: "PUBLISHED", # accepts PUBLISHED, SAVED
  },
})

Response structure


resp.views #=> Array
resp.views[0].id #=> String
resp.views[0].arn #=> String
resp.views[0].name #=> String
resp.views[0].status #=> String, one of "PUBLISHED", "SAVED"
resp.views[0].type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
resp.views[0].description #=> String
resp.views[0].version #=> Integer
resp.views[0].version_description #=> String
resp.views[0].content.input_schema #=> String
resp.views[0].content.template #=> String
resp.views[0].content.actions #=> Array
resp.views[0].content.actions[0] #=> String
resp.views[0].tags #=> Hash
resp.views[0].tags["TagKey"] #=> String
resp.views[0].created_time #=> Time
resp.views[0].last_modified_time #=> Time
resp.views[0].view_content_sha_256 #=> String
resp.next_token #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::ViewSearchFilter) —

    Filters to apply to the search, such as tag-based filters.

  • :search_criteria (Types::ViewSearchCriteria) —

    The search criteria, including field names and comparison types.

Returns:

See Also:



23278
23279
23280
23281
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23278

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

#search_vocabularies(params = {}) ⇒ Types::SearchVocabulariesResponse

Searches for vocabularies within a specific Connect Customer instance using State, NameStartsWith, and LanguageCode.

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

Examples:

Request syntax with placeholder values


resp = client.search_vocabularies({
  instance_id: "InstanceId", # required
  max_results: 1,
  next_token: "VocabularyNextToken",
  state: "CREATION_IN_PROGRESS", # accepts CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS
  name_starts_with: "VocabularyName",
  language_code: "ar-AE", # accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA, ca-ES, da-DK, fi-FI, id-ID, ms-MY, nl-NL, no-NO, pl-PL, sv-SE, tl-PH
})

Response structure


resp.vocabulary_summary_list #=> Array
resp.vocabulary_summary_list[0].name #=> String
resp.vocabulary_summary_list[0].id #=> String
resp.vocabulary_summary_list[0].arn #=> String
resp.vocabulary_summary_list[0].language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN", "en-NZ", "en-ZA", "ca-ES", "da-DK", "fi-FI", "id-ID", "ms-MY", "nl-NL", "no-NO", "pl-PL", "sv-SE", "tl-PH"
resp.vocabulary_summary_list[0].state #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "DELETE_IN_PROGRESS"
resp.vocabulary_summary_list[0].last_modified_time #=> Time
resp.vocabulary_summary_list[0].failure_reason #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :state (String) —

    The current state of the custom vocabulary.

  • :name_starts_with (String) —

    The starting pattern of the name of the vocabulary.

  • :language_code (String) —

    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

Returns:

See Also:



23351
23352
23353
23354
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23351

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

#search_workspace_associations(params = {}) ⇒ Types::SearchWorkspaceAssociationsResponse

Searches for workspace associations with users or routing profiles based on various criteria.

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

Examples:

Request syntax with placeholder values


resp = client.search_workspace_associations({
  instance_id: "InstanceId", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_filter: {
    attribute_filter: {
      or_conditions: [
        {
          tag_conditions: [
            {
              tag_key: "String",
              tag_value: "String",
            },
          ],
        },
      ],
      and_condition: {
        tag_conditions: [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      },
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive WorkspaceAssociationSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive WorkspaceAssociationSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
  },
})

Response structure


resp.next_token #=> String
resp.workspace_associations #=> Array
resp.workspace_associations[0].workspace_id #=> String
resp.workspace_associations[0].workspace_arn #=> String
resp.workspace_associations[0].resource_id #=> String
resp.workspace_associations[0].resource_arn #=> String
resp.workspace_associations[0].resource_type #=> String
resp.workspace_associations[0].resource_name #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::WorkspaceAssociationSearchFilter) —

    Filters to apply to the search, such as tag-based filters.

  • :search_criteria (Types::WorkspaceAssociationSearchCriteria) —

    The search criteria, including workspace ID, resource ID, or resource type.

Returns:

See Also:



23457
23458
23459
23460
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23457

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

#search_workspaces(params = {}) ⇒ Types::SearchWorkspacesResponse

Searches workspaces based on name, description, visibility, or tags.

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

Examples:

Request syntax with placeholder values


resp = client.search_workspaces({
  instance_id: "InstanceId", # required
  next_token: "NextToken2500",
  max_results: 1,
  search_filter: {
    attribute_filter: {
      or_conditions: [
        {
          tag_conditions: [
            {
              tag_key: "String",
              tag_value: "String",
            },
          ],
        },
      ],
      and_condition: {
        tag_conditions: [
          {
            tag_key: "String",
            tag_value: "String",
          },
        ],
      },
      tag_condition: {
        tag_key: "String",
        tag_value: "String",
      },
    },
  },
  search_criteria: {
    or_conditions: [
      {
        # recursive WorkspaceSearchCriteria
      },
    ],
    and_conditions: [
      {
        # recursive WorkspaceSearchCriteria
      },
    ],
    string_condition: {
      field_name: "String",
      value: "String",
      comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
    },
  },
})

Response structure


resp.next_token #=> String
resp.workspaces #=> Array
resp.workspaces[0].id #=> String
resp.workspaces[0].name #=> String
resp.workspaces[0].visibility #=> String, one of "ALL", "ASSIGNED", "NONE"
resp.workspaces[0].description #=> String
resp.workspaces[0].title #=> String
resp.workspaces[0].arn #=> String
resp.workspaces[0].created_at #=> Time
resp.workspaces[0].tags #=> Hash
resp.workspaces[0].tags["TagKey"] #=> String
resp.approximate_total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :search_filter (Types::WorkspaceSearchFilter) —

    Filters to apply to the search, such as tag-based filters.

  • :search_criteria (Types::WorkspaceSearchCriteria) —

    The search criteria, including field names and comparison types.

Returns:

See Also:



23564
23565
23566
23567
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23564

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

#send_chat_integration_event(params = {}) ⇒ Types::SendChatIntegrationEventResponse

Processes chat integration events from Amazon Web Services or external integrations to Connect Customer. A chat integration event includes:

  • SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat

  • ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat

When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.

Access to this API is currently restricted to Amazon Web Services End User Messaging for supporting SMS integration.

Examples:

Request syntax with placeholder values


resp = client.send_chat_integration_event({
  source_id: "SourceId", # required
  destination_id: "DestinationId", # required
  subtype: "Subtype",
  event: { # required
    type: "DISCONNECT", # required, accepts DISCONNECT, MESSAGE, EVENT
    content_type: "ChatContentType",
    content: "ChatContent",
  },
  new_session_details: {
    supported_messaging_content_types: ["SupportedMessagingContentType"],
    participant_details: {
      display_name: "DisplayName", # required
    },
    attributes: {
      "AttributeName" => "AttributeValue",
    },
    streaming_configuration: {
      streaming_endpoint_arn: "ChatStreamingEndpointARN", # required
    },
  },
})

Response structure


resp.initial_contact_id #=> String
resp.new_chat_created #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :source_id (required, String) —

    External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.

  • :destination_id (required, String) —

    Chat system identifier, used in part to uniquely identify chat. This is associated with the Connect Customer instance and flow to be used to start chats. For Server Migration Service, this is the phone number destination of inbound Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.

  • :subtype (String) —

    Classification of a channel. This is used in part to uniquely identify chat.

    Valid value: ["connect:sms", connect:"WhatsApp"]

  • :event (required, Types::ChatEvent) —

    Chat integration event payload

  • :new_session_details (Types::NewSessionDetails) —

    Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.

Returns:

See Also:



23649
23650
23651
23652
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23649

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

#send_outbound_email(params = {}) ⇒ Struct

Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Connect Customer outbound campaigns.

Only the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API.

Examples:

Request syntax with placeholder values


resp = client.send_outbound_email({
  instance_id: "InstanceId", # required
  from_email_address: { # required
    email_address: "EmailAddress", # required
    display_name: "EmailAddressDisplayName",
  },
  destination_email_address: { # required
    email_address: "EmailAddress", # required
    display_name: "EmailAddressDisplayName",
  },
  additional_recipients: {
    cc_email_addresses: [
      {
        email_address: "EmailAddress", # required
        display_name: "EmailAddressDisplayName",
      },
    ],
  },
  email_message: { # required
    message_source_type: "TEMPLATE", # required, accepts TEMPLATE, RAW
    templated_message_config: {
      knowledge_base_id: "MessageTemplateKnowledgeBaseId", # required
      message_template_id: "MessageTemplateId", # required
      template_attributes: { # required
        custom_attributes: {
          "AttributeName" => "AttributeValue",
        },
        customer_profile_attributes: "CustomerProfileAttributesSerialized",
      },
    },
    raw_message: {
      subject: "OutboundSubject", # required
      body: "Body", # required
      content_type: "EmailMessageContentType", # required
    },
  },
  traffic_type: "GENERAL", # required, accepts GENERAL, CAMPAIGN
  source_campaign: {
    campaign_id: "CampaignId",
    outbound_request_id: "OutboundRequestId",
  },
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :from_email_address (required, Types::EmailAddressInfo) —

    The email address to be used for sending email.

  • :destination_email_address (required, Types::EmailAddressInfo) —

    The email address to send the email to.

  • :additional_recipients (Types::OutboundAdditionalRecipients) —

    The additional recipients address of the email in CC.

  • :email_message (required, Types::OutboundEmailContent) —

    The email message body to be sent to the newly created email.

  • :traffic_type (required, String) —

    Denotes the class of traffic.

    Only the CAMPAIGN traffic type is supported.

  • :source_campaign (Types::SourceCampaign) —

    A Campaign object need for Campaign traffic type.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



23762
23763
23764
23765
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23762

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

#send_outbound_web_notification(params = {}) ⇒ Struct

Sends an outbound web notification to a customer's web browser for outbound campaigns. For more information about outbound campaigns, see Set up Connect Customer outbound campaigns.

Only the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API.

Examples:

Request syntax with placeholder values


resp = client.send_outbound_web_notification({
  instance_id: "InstanceId", # required
  client_token: "ClientToken",
  browser_id: "WebBrowserId", # required
  session_id: "WebSessionId", # required
  expires_at: Time.now, # required
  source: { # required
    source_campaign: { # required
      campaign_id: "CampaignId",
      outbound_request_id: "OutboundRequestId",
    },
  },
  destination: { # required
    widget_id: "WidgetId", # required
    profile_id: "CustomerProfileId", # required
  },
  content: { # required
    type: "WIDGET_VIEW", # required, accepts WIDGET_VIEW, WIDGET_ACTION
    view_arn: "ViewArn",
    attributes: {
      recommender_config: {
        domain_name: "PersonalizeDomainName", # required
        recommender_name: "RecommenderName", # required
        context: {
          "RecommenderContextKey" => "RecommenderContextValue",
        },
      },
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :browser_id (required, String) —

    A unique identifier for the customer's web browser instance to which the notification is being sent.

  • :session_id (required, String) —

    A unique identifier for the customer's web session to which the notification is being sent.

  • :expires_at (required, Time, DateTime, Date, Integer, String) —

    The timestamp, in Unix epoch time format, at which the web notification expires. After this time, the notification is no longer delivered to the customer's browser.

  • :source (required, Types::WebNotificationSource) —

    The source of the web notification. A SourceCampaign object identifies the campaign and outbound request that triggered this notification.

  • :destination (required, Types::WidgetDestination) —

    The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.

  • :content (required, Types::WebNotificationContent) —

    The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



23867
23868
23869
23870
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23867

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

#start_attached_file_upload(params = {}) ⇒ Types::StartAttachedFileUploadResponse

Provides a pre-signed Amazon S3 URL in response for uploading your content.

You may only use this API to upload attachments to a Connect Customer Case, Connect Customer Email, or Connect Customer Task.

Examples:

Request syntax with placeholder values


resp = client.start_attached_file_upload({
  client_token: "ClientToken",
  instance_id: "InstanceId", # required
  file_name: "FileName", # required
  file_size_in_bytes: 1, # required
  url_expiry_in_seconds: 1,
  file_use_case_type: "CONTACT_ANALYSIS", # required, accepts CONTACT_ANALYSIS, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT, EMAIL_MESSAGE_REDACTED, EMAIL_MESSAGE_PLAIN_TEXT_REDACTED, ATTACHMENT, VOICE_RECORDING
  associated_resource_arn: "ARN", # required
  created_by: {
    connect_user_arn: "ARN",
    aws_identity_arn: "ARN",
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.file_arn #=> String
resp.file_id #=> String
resp.creation_time #=> String
resp.file_status #=> String, one of "APPROVED", "REJECTED", "PROCESSING", "FAILED"
resp.created_by.connect_user_arn #=> String
resp.created_by.aws_identity_arn #=> String
resp.upload_url_metadata.url #=> String
resp.upload_url_metadata.url_expiry #=> String
resp.upload_url_metadata.headers_to_include #=> Hash
resp.upload_url_metadata.headers_to_include["UrlMetadataSignedHeadersKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :instance_id (required, String) —

    The unique identifier of the Connect Customer instance.

  • :file_name (required, String) —

    A case-sensitive name of the attached file being uploaded.

  • :file_size_in_bytes (required, Integer) —

    The size of the attached file in bytes.

  • :url_expiry_in_seconds (Integer) —

    Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.

  • :file_use_case_type (required, String) —

    The use case for the file.

    Only ATTACHMENTS are supported.

  • :associated_resource_arn (required, String) —

    The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task.

    This value must be a valid ARN.

  • :created_by (Types::CreatedByInfo) —

    Represents the identity that created the file.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Returns:

See Also:



23981
23982
23983
23984
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23981

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

#start_chat_contact(params = {}) ⇒ Types::StartChatContactResponse

Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Connect Customer Participant Service.

When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

A 429 error occurs in the following situations:

  • API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.

  • The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.

For more information about chat, see the following topics in the Connect Customer Administrator Guide:

Examples:

Request syntax with placeholder values


resp = client.start_chat_contact({
  instance_id: "InstanceId", # required
  contact_flow_id: "ContactFlowId", # required
  attributes: {
    "AttributeName" => "AttributeValue",
  },
  participant_details: { # required
    display_name: "DisplayName", # required
  },
  participant_configuration: {
    response_mode: "INCREMENTAL", # accepts INCREMENTAL, COMPLETE
  },
  initial_message: {
    content_type: "ChatContentType", # required
    content: "ChatContent", # required
  },
  client_token: "ClientToken",
  chat_duration_in_minutes: 1,
  supported_messaging_content_types: ["SupportedMessagingContentType"],
  persistent_chat: {
    rehydration_type: "ENTIRE_PAST_SESSION", # accepts ENTIRE_PAST_SESSION, FROM_SEGMENT
    source_contact_id: "ContactId",
  },
  related_contact_id: "ContactId",
  segment_attributes: {
    "SegmentAttributeName" => {
      value_string: "SegmentAttributeValueString",
      value_map: {
        "SegmentAttributeName" => {
          # recursive SegmentAttributeValue
        },
      },
      value_integer: 1,
      value_list: [
        {
          # recursive SegmentAttributeValue
        },
      ],
      value_arn: "SegmentAttributeValueString",
    },
  },
  customer_id: "CustomerIdNonEmpty",
  disconnect_on_customer_exit: ["AGENT"], # accepts AGENT
})

Response structure


resp.contact_id #=> String
resp.participant_id #=> String
resp.participant_token #=> String
resp.continued_from_contact_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_id (required, String) —

    The identifier of the flow for initiating the chat. To see the ContactFlowId in the Connect Customer admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

  • :attributes (Hash<String,String>) —

    A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows just like any other contact attributes.

    There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

  • :participant_details (required, Types::ParticipantDetails) —

    Information identifying the participant.

  • :participant_configuration (Types::ParticipantConfiguration) —

    The configuration of the participant.

  • :initial_message (Types::ChatMessage) —

    The initial message to be sent to the newly created chat.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :chat_duration_in_minutes (Integer) —

    The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

  • :supported_messaging_content_types (Array<String>) —

    The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response.

    Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response].

    The type application/vnd.amazonaws.connect.message.interactive is required to use the Show view flow block.

  • :persistent_chat (Types::PersistentChat) —

    Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.

  • :related_contact_id (String) —

    The unique identifier for an Connect Customer contact. This identifier is related to the chat starting.

    You cannot provide data for both RelatedContactId and PersistentChat.

  • :segment_attributes (Hash<String,Types::SegmentAttributeValue>) —

    A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.

    Attribute keys can include only alphanumeric, -, and _.

    This field can be used to show channel subtype, such as connect:Guide.

    The types application/vnd.amazonaws.connect.message.interactive and application/vnd.amazonaws.connect.message.interactive.response must be present in the SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as {"valueString" : "connect:Guide" }.

  • :customer_id (String) —

    The customer's identification number. For example, the CustomerId may be a customer number from your CRM.

  • :disconnect_on_customer_exit (Array<String>) —

    A list of participant types to automatically disconnect when the end customer ends the chat session, allowing them to continue through disconnect flows such as surveys or feedback forms.

Returns:

See Also:



24211
24212
24213
24214
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24211

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

#start_contact_conversational_analytics_job(params = {}) ⇒ Types::StartContactConversationalAnalyticsJobResponse

Starts a Contact Lens post-call analytics job for the specified contact. This API runs Conversational Analytics post-contact analysis on a voice recording that is already attached to the contact, generating transcription, sentiment analysis, redaction, and summarization results based on the provided configuration.

A voice recording must already be attached to the contact before calling this API. Use CreateAttachedFile to attach a recording from an S3 source URI.

For example, you can call CreateContact, then CreateAttachedFile, then StartContactConversationalAnalyticsJob to create a contact, attach a recording, and run post-call analytics.

Examples:

Request syntax with placeholder values


resp = client.start_contact_conversational_analytics_job({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  analytics_modes: ["PostContact"], # required, accepts PostContact, RealTime, ContactLens, AutomatedInteraction
  analytics_configuration: { # required
    language_configuration: { # required
      language_locale: "LanguageLocale",
    },
    redaction_configuration: { # required
      behavior: "Enable", # required, accepts Enable, Disable
      policy: "None", # required, accepts None, RedactedOnly, RedactedAndOriginal
      entities: ["Entity"],
      mask_mode: "PII", # accepts PII, EntityType
    },
    sentiment_configuration: { # required
      behavior: "Enable", # required, accepts Enable, Disable
    },
    summary_configuration: { # required
      summary_modes: ["PostContact"], # required, accepts PostContact, AutomatedInteraction, ContactChain
    },
    rules_configuration: { # required
      behavior: "Enable", # accepts Enable, Disable
    },
  },
  client_token: "ClientToken",
})

Response structure


resp.instance_id #=> String
resp.contact_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer.

  • :analytics_modes (required, Array<String>) —

    The analytics modes to run for the contact. Valid values: PostContact.

  • :analytics_configuration (required, Types::AnalyticsConfiguration) —

    The configuration for the conversational analytics job.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Returns:

See Also:



24303
24304
24305
24306
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24303

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

#start_contact_evaluation(params = {}) ⇒ Types::StartContactEvaluationResponse

Starts an empty evaluation in the specified Connect Customer instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.

Evaluations created through the public API do not contain answer values suggested from automation.

Examples:

Request syntax with placeholder values


resp = client.start_contact_evaluation({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  evaluation_form_id: "ResourceId", # required
  auto_evaluation_configuration: {
    enabled: false, # required
  },
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.evaluation_id #=> String
resp.evaluation_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer.

  • :evaluation_form_id (required, String) —

    The unique identifier for the evaluation form.

  • :auto_evaluation_configuration (Types::AutoEvaluationConfiguration) —

    Whether automated evaluations are enabled.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

See Also:



24383
24384
24385
24386
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24383

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

#start_contact_media_processing(params = {}) ⇒ Struct

Enables in-flight message processing for an ongoing chat session. Message processing will stay active for the rest of the chat, even if an individual contact segment ends.

Examples:

Request syntax with placeholder values


resp = client.start_contact_media_processing({
  instance_id: "InstanceId",
  contact_id: "ContactId",
  processor_arn: "ARN",
  failure_mode: "DELIVER_UNPROCESSED_MESSAGE", # accepts DELIVER_UNPROCESSED_MESSAGE, DO_NOT_DELIVER_UNPROCESSED_MESSAGE
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (String) —

    The identifier of the contact.

  • :processor_arn (String) —

    The Amazon Resource Name (ARN) of the Lambda processor. You can find the Amazon Resource Name of the lambda in the lambda console.

  • :failure_mode (String) —

    The desired behavior for failed message processing.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



24425
24426
24427
24428
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24425

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

#start_contact_recording(params = {}) ⇒ Struct

Starts recording the contact:

  • If the API is called before the agent joins the call, recording starts when the agent joins the call.

  • If the API is called after the agent joins the call, recording starts at the time of the API call.

StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

You can use this API to override the recording behavior configured in the Set recording behavior block.

Only voice recordings are supported at this time.

Examples:

Request syntax with placeholder values


resp = client.start_contact_recording({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  initial_contact_id: "ContactId", # required
  voice_recording_configuration: { # required
    voice_recording_track: "FROM_AGENT", # accepts FROM_AGENT, TO_AGENT, ALL
    ivr_recording_track: "ALL", # accepts ALL
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact.

  • :initial_contact_id (required, String) —

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

  • :voice_recording_configuration (required, Types::VoiceRecordingConfiguration) —

    The person being recorded.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



24490
24491
24492
24493
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24490

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

#start_contact_streaming(params = {}) ⇒ Types::StartContactStreamingResponse

Initiates real-time message streaming for a new chat contact.

For more information about message streaming, see Enable real-time chat message streaming in the Connect Customer Administrator Guide.

For more information about chat, see the following topics in the Connect Customer Administrator Guide:

Examples:

Request syntax with placeholder values


resp = client.start_contact_streaming({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  chat_streaming_configuration: { # required
    streaming_endpoint_arn: "ChatStreamingEndpointARN", # required
  },
  client_token: "ClientToken", # required
})

Response structure


resp.streaming_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

  • :chat_streaming_configuration (required, Types::ChatStreamingConfiguration) —

    The streaming configuration, such as the Amazon SNS streaming endpoint.

  • :client_token (required, String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



24567
24568
24569
24570
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24567

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

#start_email_contact(params = {}) ⇒ Types::StartEmailContactResponse

Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created.

Examples:

Request syntax with placeholder values


resp = client.start_email_contact({
  instance_id: "InstanceId", # required
  from_email_address: { # required
    email_address: "EmailAddress", # required
    display_name: "EmailAddressDisplayName",
  },
  destination_email_address: "EmailAddress", # required
  description: "Description",
  references: {
    "ReferenceKey" => {
      value: "ReferenceValue",
      type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT, EMAIL_MESSAGE_PLAIN_TEXT_REDACTED, EMAIL_MESSAGE_REDACTED
      status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
      arn: "ReferenceArn",
      status_reason: "ReferenceStatusReason",
    },
  },
  name: "Name",
  email_message: { # required
    message_source_type: "RAW", # required, accepts RAW
    raw_message: {
      subject: "InboundSubject", # required
      body: "Body", # required
      content_type: "EmailMessageContentType", # required
      headers: {
        "REFERENCES" => "EmailHeaderValue",
      },
    },
  },
  additional_recipients: {
    to_addresses: [
      {
        email_address: "EmailAddress", # required
        display_name: "EmailAddressDisplayName",
      },
    ],
    cc_addresses: [
      {
        email_address: "EmailAddress", # required
        display_name: "EmailAddressDisplayName",
      },
    ],
  },
  attachments: [
    {
      file_name: "FileName", # required
      s3_url: "PreSignedAttachmentUrl", # required
    },
  ],
  contact_flow_id: "ContactFlowId",
  related_contact_id: "ContactId",
  attributes: {
    "AttributeName" => "AttributeValue",
  },
  segment_attributes: {
    "SegmentAttributeName" => {
      value_string: "SegmentAttributeValueString",
      value_map: {
        "SegmentAttributeName" => {
          # recursive SegmentAttributeValue
        },
      },
      value_integer: 1,
      value_list: [
        {
          # recursive SegmentAttributeValue
        },
      ],
      value_arn: "SegmentAttributeValueString",
    },
  },
  client_token: "ClientToken",
})

Response structure


resp.contact_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :from_email_address (required, Types::EmailAddressInfo) —

    The email address of the customer.

  • :destination_email_address (required, String) —

    The email address associated with the Connect Customer instance.

  • :description (String) —

    A description of the email contact.

  • :references (Hash<String,Types::Reference>) —

    A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE. EMAIL | EMAIL_MESSAGE |ATTACHMENT are not a supported reference type during email creation.

  • :name (String) —

    The name of a email that is shown to an agent in the Contact Control Panel (CCP).

  • :email_message (required, Types::InboundEmailContent) —

    The email message body to be sent to the newly created email.

  • :additional_recipients (Types::InboundAdditionalRecipients) —

    The additional recipients address of the email.

  • :attachments (Array<Types::EmailAttachment>) —

    List of S3 presigned URLs of email attachments and their file name.

  • :contact_flow_id (String) —

    The identifier of the flow for initiating the emails. To see the ContactFlowId in the Connect Customer admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

  • :related_contact_id (String) —

    The contactId that is related to this contact. Linking emails together by using RelatedContactID copies over contact attributes from the related email contact to the new email contact. All updates to user-defined attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.

  • :attributes (Hash<String,String>) —

    A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and can be accessed in flows just like any other contact attributes.

    There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

  • :segment_attributes (Hash<String,Types::SegmentAttributeValue>) —

    A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.

    Attribute keys can include only alphanumeric, -, and _.

    This field can be used to show channel subtype, such as connect:Guide.

    To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger":135}}}}.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



24758
24759
24760
24761
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24758

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

#start_evaluation_form_validation(params = {}) ⇒ Types::StartEvaluationFormValidationResponse

Starts an asynchronous validation process for an evaluation form version in the specified Connect Customer instance. The validation first performs structural checks on the form content (such as verifying required fields, valid scoring configuration, and correct conditional logic), then asynchronously analyzes questions configured for generative AI evaluation against a set of best practices. Use GetEvaluationFormValidation to retrieve the status and results once the validation completes.

Examples:

Request syntax with placeholder values


resp = client.start_evaluation_form_validation({
  instance_id: "InstanceId", # required
  evaluation_form_id: "ResourceId", # required
  evaluation_form_version: 1, # required
})

Response structure


resp.evaluation_form_id #=> String
resp.evaluation_form_arn #=> String
resp.evaluation_form_version #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :evaluation_form_id (required, String) —

    The unique identifier for the evaluation form.

  • :evaluation_form_version (required, Integer) —

    The version of the evaluation form to validate.

Returns:

See Also:



24814
24815
24816
24817
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24814

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

#start_outbound_chat_contact(params = {}) ⇒ Types::StartOutboundChatContactResponse

Initiates a new outbound SMS or WhatsApp contact to a customer. Response of this API provides the ContactId of the outbound SMS or WhatsApp contact created.

SourceEndpoint only supports Endpoints with CONNECT_PHONENUMBER_ARN as Type and DestinationEndpoint only supports Endpoints with TELEPHONE_NUMBER as Type. ContactFlowId initiates the flow to manage the new contact created.

This API can be used to initiate outbound SMS or WhatsApp contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS or WhatsApp contact by using the StartOutboundChatContact Flow Action.

For more information about using SMS or WhatsApp in Connect Customer, see the following topics in the Connect Customer Administrator Guide:

Examples:

Request syntax with placeholder values


resp = client.start_outbound_chat_contact({
  source_endpoint: { # required
    type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN, EMAIL_ADDRESS
    address: "EndpointAddress",
  },
  destination_endpoint: { # required
    type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN, EMAIL_ADDRESS
    address: "EndpointAddress",
  },
  instance_id: "InstanceId", # required
  segment_attributes: { # required
    "SegmentAttributeName" => {
      value_string: "SegmentAttributeValueString",
      value_map: {
        "SegmentAttributeName" => {
          # recursive SegmentAttributeValue
        },
      },
      value_integer: 1,
      value_list: [
        {
          # recursive SegmentAttributeValue
        },
      ],
      value_arn: "SegmentAttributeValueString",
    },
  },
  attributes: {
    "AttributeName" => "AttributeValue",
  },
  contact_flow_id: "ContactFlowId", # required
  chat_duration_in_minutes: 1,
  participant_details: {
    display_name: "DisplayName", # required
  },
  initial_system_message: {
    content_type: "ChatContentType", # required
    content: "ChatContent", # required
  },
  initial_templated_system_message: {
    knowledge_base_id: "MessageTemplateKnowledgeBaseId", # required
    message_template_id: "MessageTemplateId", # required
    template_attributes: { # required
      custom_attributes: {
        "AttributeName" => "AttributeValue",
      },
      customer_profile_attributes: "CustomerProfileAttributesSerialized",
    },
  },
  related_contact_id: "ContactId",
  supported_messaging_content_types: ["SupportedMessagingContentType"],
  client_token: "ClientToken",
})

Response structure


resp.contact_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :source_endpoint (required, Types::Endpoint) —

    Information about the endpoint.

  • :destination_endpoint (required, Types::Endpoint) —

    Information about the endpoint.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :segment_attributes (required, Hash<String,Types::SegmentAttributeValue>) —

    A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.

    • Attribute keys can include only alphanumeric, -, and _.

    • This field can be used to show channel subtype, such as connect:SMS and connect:WhatsApp.

  • :attributes (Hash<String,String>) —

    A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and can be accessed in flows just like any other contact attributes.

  • :contact_flow_id (required, String) —

    The identifier of the flow for the call. To see the ContactFlowId in the Connect Customer console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

    • arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/123ec456-a007-89c0-1234-xxxxxxxxxxxx

    ^

  • :chat_duration_in_minutes (Integer) —

    The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

  • :participant_details (Types::ParticipantDetails) —

    The customer's details.

  • :initial_system_message (Types::ChatMessage) —

    A chat message.

  • :initial_templated_system_message (Types::TemplatedMessageConfig) —

    Information about template message configuration.

  • :related_contact_id (String) —

    The unique identifier for an Connect Customer contact. This identifier is related to the contact starting.

  • :supported_messaging_content_types (Array<String>) —

    The supported chat message content types. Supported types are:

    • text/plain

    • text/markdown

    • application/json, application/vnd.amazonaws.connect.message.interactive

    • application/vnd.amazonaws.connect.message.interactive.response

    Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain:

    • [text/plain, text/markdown, application/json]

    • [text/markdown, text/plain]

    • [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



25013
25014
25015
25016
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25013

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

#start_outbound_email_contact(params = {}) ⇒ Types::StartOutboundEmailContactResponse

Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.

Examples:

Request syntax with placeholder values


resp = client.start_outbound_email_contact({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  from_email_address: {
    email_address: "EmailAddress", # required
    display_name: "EmailAddressDisplayName",
  },
  destination_email_address: { # required
    email_address: "EmailAddress", # required
    display_name: "EmailAddressDisplayName",
  },
  additional_recipients: {
    cc_email_addresses: [
      {
        email_address: "EmailAddress", # required
        display_name: "EmailAddressDisplayName",
      },
    ],
  },
  email_message: { # required
    message_source_type: "TEMPLATE", # required, accepts TEMPLATE, RAW
    templated_message_config: {
      knowledge_base_id: "MessageTemplateKnowledgeBaseId", # required
      message_template_id: "MessageTemplateId", # required
      template_attributes: { # required
        custom_attributes: {
          "AttributeName" => "AttributeValue",
        },
        customer_profile_attributes: "CustomerProfileAttributesSerialized",
      },
    },
    raw_message: {
      subject: "OutboundSubject", # required
      body: "Body", # required
      content_type: "EmailMessageContentType", # required
    },
  },
  client_token: "ClientToken",
})

Response structure


resp.contact_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer.

  • :from_email_address (Types::EmailAddressInfo) —

    The email address associated with the Connect Customer instance.

  • :destination_email_address (required, Types::EmailAddressInfo) —

    The email address of the customer.

  • :additional_recipients (Types::OutboundAdditionalRecipients) —

    The additional recipients address of email in CC.

  • :email_message (required, Types::OutboundEmailContent) —

    The email message body to be sent to the newly created email.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



25111
25112
25113
25114
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25111

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

#start_outbound_voice_contact(params = {}) ⇒ Types::StartOutboundVoiceContactResponse

Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId).

Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.

Dialing timeout for this operation can be configured with the “RingTimeoutInSeconds” parameter. If not specified, the default dialing timeout will be 60 seconds which means if the call is not connected within 60 seconds, it fails.

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Connect Customer Service Quotas in the Connect Customer Administrator Guide.

Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Connect Customer campaigns.

For Preview dialing mode, only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API with OutboundStrategy.

Examples:

Request syntax with placeholder values


resp = client.start_outbound_voice_contact({
  name: "Name",
  description: "Description",
  references: {
    "ReferenceKey" => {
      value: "ReferenceValue",
      type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT, EMAIL_MESSAGE_PLAIN_TEXT_REDACTED, EMAIL_MESSAGE_REDACTED
      status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
      arn: "ReferenceArn",
      status_reason: "ReferenceStatusReason",
    },
  },
  related_contact_id: "ContactId",
  destination_phone_number: "PhoneNumber", # required
  contact_flow_id: "ContactFlowId", # required
  instance_id: "InstanceId", # required
  client_token: "ClientToken",
  source_phone_number: "PhoneNumber",
  queue_id: "QueueId",
  attributes: {
    "AttributeName" => "AttributeValue",
  },
  answer_machine_detection_config: {
    enable_answer_machine_detection: false,
    await_answer_machine_prompt: false,
  },
  campaign_id: "CampaignId",
  traffic_type: "GENERAL", # accepts GENERAL, CAMPAIGN
  outbound_strategy: {
    type: "AGENT_FIRST", # required, accepts AGENT_FIRST
    config: {
      agent_first: {
        preview: {
          post_accept_timeout_config: { # required
            duration_in_seconds: 1, # required
          },
          allowed_user_actions: ["CALL"], # required, accepts CALL, DISCARD
        },
      },
    },
  },
  ring_timeout_in_seconds: 1,
})

Response structure


resp.contact_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).

  • :description (String) —

    A description of the voice contact that appears in the agent's snapshot in the CCP logs. For more information about CCP logs, see Download and review CCP logs in the Connect Customer Administrator Guide.

  • :references (Hash<String,Types::Reference>) —

    A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during voice contact creation.

  • :related_contact_id (String) —

    The contactId that is related to this contact. Linking voice, task, or chat by using RelatedContactID copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.

  • :destination_phone_number (required, String) —

    The phone number of the customer, in E.164 format.

  • :contact_flow_id (required, String) —

    The identifier of the flow for the outbound call. To see the ContactFlowId in the Connect Customer admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :source_phone_number (String) —

    The phone number associated with the Connect Customer instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

  • :queue_id (String) —

    The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, you must specify a source phone number.

  • :attributes (Hash<String,String>) —

    A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and can be accessed in flows just like any other contact attributes.

    There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

  • :answer_machine_detection_config (Types::AnswerMachineDetectionConfig) —

    Configuration of the answering machine detection for this outbound call.

  • :campaign_id (String) —

    The campaign identifier of the outbound communication.

  • :traffic_type (String) —

    Denotes the class of traffic. Calls with different traffic types are handled differently by Connect Customer. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.

  • :outbound_strategy (Types::OutboundStrategy) —

    Information about the outbound strategy.

  • :ring_timeout_in_seconds (Integer) —

    The maximum time the outbound call will wait for the destination to answer the call, in seconds

Returns:

See Also:



25317
25318
25319
25320
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25317

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

#start_screen_sharing(params = {}) ⇒ Struct

Starts screen sharing for a contact. For more information about screen sharing, see Set up in-app, web, video calling, and screen sharing capabilities in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.start_screen_sharing({
  client_token: "ClientToken",
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



25368
25369
25370
25371
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25368

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

#start_task_contact(params = {}) ⇒ Types::StartTaskContactResponse

Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Connect Customer in the Connect Customer Administrator Guide.

When using PreviousContactId and RelatedContactId input parameters, note the following:

  • PreviousContactId

    • Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.

    • There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId.

  • RelatedContactId

    • Copies contact attributes from the related task contact to the new contact.

    • Any update on attributes in a new task contact does not update attributes on previous contact.

    • There’s no limit on the number of task contacts that can be created that use the same RelatedContactId.

In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Connect Customer cannot identify the unique flow to run when the task is created.

A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Connect Customer service quotas in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.start_task_contact({
  instance_id: "InstanceId", # required
  previous_contact_id: "ContactId",
  contact_flow_id: "ContactFlowId",
  attributes: {
    "AttributeName" => "AttributeValue",
  },
  name: "Name", # required
  references: {
    "ReferenceKey" => {
      value: "ReferenceValue",
      type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT, EMAIL_MESSAGE_PLAIN_TEXT_REDACTED, EMAIL_MESSAGE_REDACTED
      status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
      arn: "ReferenceArn",
      status_reason: "ReferenceStatusReason",
    },
  },
  description: "Description",
  client_token: "ClientToken",
  scheduled_time: Time.now,
  task_template_id: "TaskTemplateId",
  quick_connect_id: "QuickConnectId",
  related_contact_id: "ContactId",
  segment_attributes: {
    "SegmentAttributeName" => {
      value_string: "SegmentAttributeValueString",
      value_map: {
        "SegmentAttributeName" => {
          # recursive SegmentAttributeValue
        },
      },
      value_integer: 1,
      value_list: [
        {
          # recursive SegmentAttributeValue
        },
      ],
      value_arn: "SegmentAttributeValueString",
    },
  },
  attachments: [
    {
      file_name: "FileName", # required
      s3_url: "PreSignedAttachmentUrl", # required
    },
  ],
})

Response structure


resp.contact_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :previous_contact_id (String) —

    The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same PreviousContactID will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.

  • :contact_flow_id (String) —

    The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Connect Customer admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

  • :attributes (Hash<String,String>) —

    A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and can be accessed in flows just like any other contact attributes.

    There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

  • :name (required, String) —

    The name of a task that is shown to an agent in the Contact Control Panel (CCP).

  • :references (Hash<String,Types::Reference>) —

    A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.

  • :description (String) —

    A description of the task that is shown to an agent in the Contact Control Panel (CCP).

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :scheduled_time (Time, DateTime, Date, Integer, String) —

    The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

  • :task_template_id (String) —

    A unique identifier for the task template. For more information about task templates, see Create task templates in the Connect Customer Administrator Guide.

  • :quick_connect_id (String) —

    The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.

  • :related_contact_id (String) —

    The contactId that is related to this contact. Linking tasks together by using RelatedContactID copies over contact attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using PreviousContactID. There are no limits to the number of contacts that can be linked by using RelatedContactId.

  • :segment_attributes (Hash<String,Types::SegmentAttributeValue>) —

    A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.

    Attribute keys can include only alphanumeric, -, and _.

    This field can be used to set Contact Expiry as a duration in minutes and set a UserId for the User who created a task.

    To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}.

    To set the created by user, a valid AgentResourceId must be supplied, with SegmentAttributes like { "connect:CreatedByUser" { "ValueString": "arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}}}.

  • :attachments (Array<Types::TaskAttachment>) —

    List of S3 presigned URLs of task attachments and their file name. You can have a maximum of 5 attachments per task.

Returns:

See Also:



25605
25606
25607
25608
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25605

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

#start_test_case_execution(params = {}) ⇒ Types::StartTestCaseExecutionResponse

Starts executing a published test case.

Examples:

Request syntax with placeholder values


resp = client.start_test_case_execution({
  instance_id: "InstanceId", # required
  test_case_id: "TestCaseId", # required
  client_token: "ClientToken",
})

Response structure


resp.test_case_execution_id #=> String
resp.test_case_id #=> String
resp.status #=> String, one of "INITIATED", "PASSED", "FAILED", "IN_PROGRESS", "STOPPED"

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance.

  • :test_case_id (required, String) —

    The identifier of the test case to execute.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



25655
25656
25657
25658
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25655

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

#start_web_rtc_contact(params = {}) ⇒ Types::StartWebRTCContactResponse

Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Connect Customer instance (specified as InstanceId).

Examples:

Request syntax with placeholder values


resp = client.start_web_rtc_contact({
  attributes: {
    "AttributeName" => "AttributeValue",
  },
  client_token: "ClientToken",
  contact_flow_id: "ContactFlowId", # required
  instance_id: "InstanceId", # required
  allowed_capabilities: {
    customer: {
      video: "SEND", # accepts SEND
      screen_share: "SEND", # accepts SEND
    },
    agent: {
      video: "SEND", # accepts SEND
      screen_share: "SEND", # accepts SEND
    },
  },
  participant_details: { # required
    display_name: "DisplayName", # required
  },
  related_contact_id: "ContactId",
  references: {
    "ReferenceKey" => {
      value: "ReferenceValue",
      type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT, EMAIL_MESSAGE_PLAIN_TEXT_REDACTED, EMAIL_MESSAGE_REDACTED
      status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
      arn: "ReferenceArn",
      status_reason: "ReferenceStatusReason",
    },
  },
  description: "Description",
})

Response structure


resp.connection_data.attendee.attendee_id #=> String
resp.connection_data.attendee.join_token #=> String
resp.connection_data.meeting.media_region #=> String
resp.connection_data.meeting.media_placement.audio_host_url #=> String
resp.connection_data.meeting.media_placement.audio_fallback_url #=> String
resp.connection_data.meeting.media_placement.signaling_url #=> String
resp.connection_data.meeting.media_placement.turn_control_url #=> String
resp.connection_data.meeting.media_placement.event_ingestion_url #=> String
resp.connection_data.meeting.meeting_features.audio.echo_reduction #=> String, one of "AVAILABLE", "UNAVAILABLE"
resp.connection_data.meeting.meeting_id #=> String
resp.contact_id #=> String
resp.participant_id #=> String
resp.participant_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :attributes (Hash<String,String>) —

    A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and can be accessed in flows just like any other contact attributes.

    There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, -, and _ characters.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :contact_flow_id (required, String) —

    The identifier of the flow for the call. To see the ContactFlowId in the Connect Customer admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :allowed_capabilities (Types::AllowedCapabilities) —

    Information about the video sharing capabilities of the participants (customer, agent).

  • :participant_details (required, Types::ParticipantDetails) —

    The customer's details.

  • :related_contact_id (String) —

    The unique identifier for an Connect Customer contact. This identifier is related to the contact starting.

  • :references (Hash<String,Types::Reference>) —

    A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.

  • :description (String) —

    A description of the task that is shown to an agent in the Contact Control Panel (CCP).

Returns:

See Also:



25790
25791
25792
25793
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25790

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

#stop_contact(params = {}) ⇒ Struct

Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:

  • DISCONNECT

  • TRANSFER

  • QUEUE_TRANSFER

  • EXTERNAL_OUTBOUND

  • MONITOR

Chat and task contacts can be terminated in any state, regardless of initiation method.

Examples:

Request syntax with placeholder values


resp = client.stop_contact({
  contact_id: "ContactId", # required
  instance_id: "InstanceId", # required
  disconnect_reason: {
    code: "DisconnectReasonCode",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    The ID of the contact.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :disconnect_reason (Types::DisconnectReason) —

    The reason a contact can be disconnected. Only Connect Customer outbound campaigns can provide this field. For a list and description of all the possible disconnect reasons by channel (including outbound campaign voice contacts) see DisconnectReason under ContactTraceRecord in the Connect Customer Administrator Guide.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



25850
25851
25852
25853
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25850

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

#stop_contact_media_processing(params = {}) ⇒ Struct

Stops in-flight message processing for an ongoing chat session.

Examples:

Request syntax with placeholder values


resp = client.stop_contact_media_processing({
  instance_id: "InstanceId",
  contact_id: "ContactId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (String) —

    The identifier of the contact.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



25881
25882
25883
25884
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25881

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

#stop_contact_recording(params = {}) ⇒ Struct

Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.

Only voice recordings are supported at this time.

Examples:

Request syntax with placeholder values


resp = client.stop_contact_recording({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  initial_contact_id: "ContactId", # required
  contact_recording_type: "AGENT", # accepts AGENT, IVR, SCREEN
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact.

  • :initial_contact_id (required, String) —

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

  • :contact_recording_type (String) —

    The type of recording being operated on.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



25929
25930
25931
25932
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25929

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

#stop_contact_streaming(params = {}) ⇒ Struct

Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.

Examples:

Request syntax with placeholder values


resp = client.stop_contact_streaming({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  streaming_id: "StreamingId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.

  • :streaming_id (required, String) —

    The identifier of the streaming configuration enabled.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



25970
25971
25972
25973
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25970

def stop_contact_streaming(params = {}, options = {})
  req = build_request(:stop_contact_streaming, params)
  req.send_request(options)
end

#stop_test_case_execution(params = {}) ⇒ Struct

Stops a running test execution.

Examples:

Request syntax with placeholder values


resp = client.stop_test_case_execution({
  instance_id: "InstanceId", # required
  test_case_execution_id: "TestCaseExecutionId", # required
  test_case_id: "TestCaseId", # required
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance.

  • :test_case_execution_id (required, String) —

    The identifier of the test case execution to stop.

  • :test_case_id (required, String) —

    The identifier of the test case.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



26014
26015
26016
26017
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26014

def stop_test_case_execution(params = {}, options = {})
  req = build_request(:stop_test_case_execution, params)
  req.send_request(options)
end

#submit_contact_evaluation(params = {}) ⇒ Types::SubmitContactEvaluationResponse

Submits a contact evaluation in the specified Connect Customer instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({}) to the question identifier.

If a contact evaluation is already in submitted state, this operation will trigger a resubmission.

Examples:

Request syntax with placeholder values


resp = client.submit_contact_evaluation({
  instance_id: "InstanceId", # required
  evaluation_id: "ResourceId", # required
  answers: {
    "ResourceId" => {
      value: {
        string_value: "EvaluationAnswerDataStringValue",
        numeric_value: 1.0,
        string_values: ["EvaluationAnswerDataStringValue"],
        date_time_value: "ISO8601Datetime",
        not_applicable: false,
      },
    },
  },
  notes: {
    "ResourceId" => {
      value: "EvaluationNoteString",
    },
  },
  submitted_by: {
    connect_user_arn: "ARN",
  },
})

Response structure


resp.evaluation_id #=> String
resp.evaluation_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :evaluation_id (required, String) —

    A unique identifier for the contact evaluation.

  • :answers (Hash<String,Types::EvaluationAnswerInput>) —

    A map of question identifiers to answer value.

  • :notes (Hash<String,Types::EvaluationNote>) —

    A map of question identifiers to note value.

  • :submitted_by (Types::EvaluatorUserUnion) —

    The ID of the user who submitted the contact evaluation.

Returns:

See Also:



26089
26090
26091
26092
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26089

def submit_contact_evaluation(params = {}, options = {})
  req = build_request(:submit_contact_evaluation, params)
  req.send_request(options)
end

#suspend_contact_recording(params = {}) ⇒ Struct

When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call (IVR or agent), screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.

The period of time that the recording is suspended is filled with silence in the final recording.

Voice (IVR, agent) and screen recordings are supported.

Examples:

Request syntax with placeholder values


resp = client.suspend_contact_recording({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  initial_contact_id: "ContactId", # required
  contact_recording_type: "AGENT", # accepts AGENT, IVR, SCREEN
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact.

  • :initial_contact_id (required, String) —

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

  • :contact_recording_type (String) —

    The type of recording being operated on.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



26144
26145
26146
26147
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26144

def suspend_contact_recording(params = {}, options = {})
  req = build_request(:suspend_contact_recording, params)
  req.send_request(options)
end

#tag_contact(params = {}) ⇒ Struct

Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Connect Customer usage.

Examples:

Request syntax with placeholder values


resp = client.tag_contact({
  contact_id: "ContactId", # required
  instance_id: "InstanceId", # required
  tags: { # required
    "ContactTagKey" => "ContactTagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :tags (required, Hash<String,String>) —

    The tags to be assigned to the contact resource. For example, { "Tags": "key2":"value2" }.

    Authorization is not supported by this tag.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



26192
26193
26194
26195
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26192

def tag_contact(params = {}, options = {})
  req = build_request(:tag_contact, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds the specified tags to the specified resource.

Some of the supported resource types are agents, routing profiles, queues, quick connects, flows, agent statuses, hours of operation, phone numbers, security profiles, task templates, and custom metrics. For a complete list, see Tagging resources in Connect Customer.

For sample policies that use tags, see Connect Customer Identity-Based Policy Examples in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ARN", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tags (required, Hash<String,String>) —

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



26236
26237
26238
26239
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26236

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#transfer_contact(params = {}) ⇒ Types::TransferContactResponse

Transfers TASK or EMAIL contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.

Note the following requirements:

  • Transfer is only supported for TASK and EMAIL contacts.

  • Do not use both QueueId and UserId in the same call.

  • The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.

  • The TransferContact API can be called only on active contacts.

  • A contact cannot be transferred more than 11 times.

Examples:

Request syntax with placeholder values


resp = client.transfer_contact({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  queue_id: "QueueId",
  user_id: "AgentResourceId",
  contact_flow_id: "ContactFlowId", # required
  client_token: "ClientToken",
})

Response structure


resp.contact_id #=> String
resp.contact_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer.

  • :queue_id (String) —

    The identifier for the queue.

  • :user_id (String) —

    The identifier for the user. This can be the ID or the ARN of the user.

  • :contact_flow_id (required, String) —

    The identifier of the flow.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



26320
26321
26322
26323
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26320

def transfer_contact(params = {}, options = {})
  req = build_request(:transfer_contact, params)
  req.send_request(options)
end

#untag_contact(params = {}) ⇒ Struct

Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Connect Customer usage.

Examples:

Request syntax with placeholder values


resp = client.untag_contact({
  contact_id: "ContactId", # required
  instance_id: "InstanceId", # required
  tag_keys: ["ContactTagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :tag_keys (required, Array<String>) —

    A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



26362
26363
26364
26365
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26362

def untag_contact(params = {}, options = {})
  req = build_request(:untag_contact, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the specified tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ARN", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tag_keys (required, Array<String>) —

    The tag keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



26388
26389
26390
26391
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26388

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_agent_status(params = {}) ⇒ Struct

Updates agent status.

Examples:

Request syntax with placeholder values


resp = client.update_agent_status({
  instance_id: "InstanceId", # required
  agent_status_id: "AgentStatusId", # required
  name: "AgentStatusName",
  description: "UpdateAgentStatusDescription",
  state: "ENABLED", # accepts ENABLED, DISABLED
  display_order: 1,
  reset_order_number: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :agent_status_id (required, String) —

    The identifier of the agent status.

  • :name (String) —

    The name of the agent status.

  • :description (String) —

    The description of the agent status.

  • :state (String) —

    The state of the agent status.

  • :display_order (Integer) —

    The display order of the agent status.

  • :reset_order_number (Boolean) —

    A number indicating the reset order of the agent status.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



26439
26440
26441
26442
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26439

def update_agent_status(params = {}, options = {})
  req = build_request(:update_agent_status, params)
  req.send_request(options)
end

#update_attached_files_configuration(params = {}) ⇒ Types::UpdateAttachedFilesConfigurationResponse

Updates the attached files configuration for the specified Connect Customer instance and attachment scope.

If no instance-specific configuration exists, this operation creates one. Partial updates are supported—only specified fields are updated, while unspecified fields retain their current values.

Examples:

Request syntax with placeholder values


resp = client.update_attached_files_configuration({
  instance_id: "InstanceId", # required
  attachment_scope: "EMAIL", # required, accepts EMAIL, CHAT, CASE, TASK
  maximum_size_limit_in_bytes: 1,
  extension_configuration: {
    allowed_extensions: [ # required
      {
        extension: "FileExtension", # required
      },
    ],
  },
})

Response structure


resp.instance_id #=> String
resp.attachment_scope #=> String, one of "EMAIL", "CHAT", "CASE", "TASK"
resp.maximum_size_limit_in_bytes #=> Integer
resp.extension_configuration.allowed_extensions #=> Array
resp.extension_configuration.allowed_extensions[0].extension #=> String
resp.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :attachment_scope (required, String) —

    The scope of the attachment. Valid values are EMAIL, CHAT, CASE, and TASK.

  • :maximum_size_limit_in_bytes (Integer) —

    The maximum size limit for attached files in bytes. The minimum value is 1 and the maximum value is 104857600 (100 MB).

  • :extension_configuration (Types::ExtensionConfiguration) —

    The configuration for allowed file extensions.

Returns:

See Also:



26506
26507
26508
26509
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26506

def update_attached_files_configuration(params = {}, options = {})
  req = build_request(:update_attached_files_configuration, params)
  req.send_request(options)
end

#update_authentication_profile(params = {}) ⇒ Struct

This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support.

Updates the selected authentication profile.

Examples:

Request syntax with placeholder values


resp = client.update_authentication_profile({
  authentication_profile_id: "AuthenticationProfileId", # required
  instance_id: "InstanceId", # required
  name: "AuthenticationProfileName",
  description: "AuthenticationProfileDescription",
  allowed_ips: ["IpCidr"],
  blocked_ips: ["IpCidr"],
  periodic_session_duration: 1,
  session_inactivity_duration: 1,
  session_inactivity_handling_enabled: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :authentication_profile_id (required, String) —

    A unique identifier for the authentication profile.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (String) —

    The name for the authentication profile.

  • :description (String) —

    The description for the authentication profile.

  • :allowed_ips (Array<String>) —

    A list of IP address range strings that are allowed to access the instance. For more information on how to configure IP addresses, seeConfigure session timeouts in the Connect Customer Administrator Guide.

  • :blocked_ips (Array<String>) —

    A list of IP address range strings that are blocked from accessing the instance. For more information on how to configure IP addresses, For more information on how to configure IP addresses, see Configure IP-based access control in the Connect Customer Administrator Guide.

  • :periodic_session_duration (Integer) —

    The short lived session duration configuration for users logged in to Connect Customer, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, For more information on how to configure IP addresses, see Configure session timeouts in the Connect Customer Administrator Guide.

  • :session_inactivity_duration (Integer) —

    The period, in minutes, before an agent is automatically signed out of the contact center when they go inactive.

  • :session_inactivity_handling_enabled (Boolean) —

    Determines if automatic logout on user inactivity is enabled.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



26593
26594
26595
26596
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26593

def update_authentication_profile(params = {}, options = {})
  req = build_request(:update_authentication_profile, params)
  req.send_request(options)
end

#update_contact(params = {}) ⇒ Struct

This API is in preview release for Connect Customer and is subject to change.

Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

You can add or update user-defined contact information for both ongoing and completed contacts.

Examples:

Request syntax with placeholder values


resp = client.update_contact({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  name: "Name",
  description: "Description",
  references: {
    "ReferenceKey" => {
      value: "ReferenceValue",
      type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT, EMAIL_MESSAGE_PLAIN_TEXT_REDACTED, EMAIL_MESSAGE_REDACTED
      status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
      arn: "ReferenceArn",
      status_reason: "ReferenceStatusReason",
    },
  },
  segment_attributes: {
    "SegmentAttributeName" => {
      value_string: "SegmentAttributeValueString",
      value_map: {
        "SegmentAttributeName" => {
          # recursive SegmentAttributeValue
        },
      },
      value_integer: 1,
      value_list: [
        {
          # recursive SegmentAttributeValue
        },
      ],
      value_arn: "SegmentAttributeValueString",
    },
  },
  queue_info: {
    id: "QueueId",
  },
  user_info: {
    user_id: "AgentResourceId",
  },
  customer_endpoint: {
    type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN, EMAIL_ADDRESS
    address: "EndpointAddress",
  },
  system_endpoint: {
    type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN, EMAIL_ADDRESS
    address: "EndpointAddress",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

  • :name (String) —

    The name of the contact.

  • :description (String) —

    The description of the contact.

  • :references (Hash<String,Types::Reference>) —

    Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

  • :segment_attributes (Hash<String,Types::SegmentAttributeValue>) —

    A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.

    Attribute keys can include only alphanumeric, -, and _.

    This field can be used to show channel subtype, such as connect:Guide.

    Contact Expiry, and user-defined attributes (String - String) that are defined in predefined attributes, can be updated by using the UpdateContact API.

  • :queue_info (Types::QueueInfoInput) —

    Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Connect Customer Contact Lens integration in the Connect Customer Administrator Guide.

  • :user_info (Types::UserInfo) —

    Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Connect Customer Contact Lens integration in the Connect Customer Administrator Guide.

  • :customer_endpoint (Types::Endpoint) —

    The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see Connect Customer Contact Lens integration in the Connect Customer Administrator Guide.

  • :system_endpoint (Types::Endpoint) —

    External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see Connect Customer Contact Lens integration in the Connect Customer Administrator Guide.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



26744
26745
26746
26747
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26744

def update_contact(params = {}, options = {})
  req = build_request(:update_contact, params)
  req.send_request(options)
end

#update_contact_attributes(params = {}) ⇒ Struct

Creates or updates user-defined contact attributes associated with the specified contact.

You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Connect Customer. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.

Contact attributes are available in Connect Customer for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.update_contact_attributes({
  initial_contact_id: "ContactId", # required
  instance_id: "InstanceId", # required
  attributes: { # required
    "AttributeName" => "AttributeValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :initial_contact_id (required, String) —

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :attributes (required, Hash<String,String>) —

    The Connect Customer attributes. These attributes can be accessed in flows just like any other contact attributes.

    You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

    In the Set contact attributes block, when the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:

    • Remove unnecessary attributes by setting their values to empty.

    • If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see Flow block: Set contact attributes in the Connect Customer Administrator Guide.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



26825
26826
26827
26828
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26825

def update_contact_attributes(params = {}, options = {})
  req = build_request(:update_contact_attributes, params)
  req.send_request(options)
end

#update_contact_evaluation(params = {}) ⇒ Types::UpdateContactEvaluationResponse

Updates details about a contact evaluation in the specified Connect Customer instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}) to the question identifier.

Examples:

Request syntax with placeholder values


resp = client.update_contact_evaluation({
  instance_id: "InstanceId", # required
  evaluation_id: "ResourceId", # required
  answers: {
    "ResourceId" => {
      value: {
        string_value: "EvaluationAnswerDataStringValue",
        numeric_value: 1.0,
        string_values: ["EvaluationAnswerDataStringValue"],
        date_time_value: "ISO8601Datetime",
        not_applicable: false,
      },
    },
  },
  notes: {
    "ResourceId" => {
      value: "EvaluationNoteString",
    },
  },
  updated_by: {
    connect_user_arn: "ARN",
  },
})

Response structure


resp.evaluation_id #=> String
resp.evaluation_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :evaluation_id (required, String) —

    A unique identifier for the contact evaluation.

  • :answers (Hash<String,Types::EvaluationAnswerInput>) —

    A map of question identifiers to answer value.

  • :notes (Hash<String,Types::EvaluationNote>) —

    A map of question identifiers to note value.

  • :updated_by (Types::EvaluatorUserUnion) —

    The ID of the user who updated the contact evaluation.

Returns:

See Also:



26896
26897
26898
26899
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26896

def update_contact_evaluation(params = {}, options = {})
  req = build_request(:update_contact_evaluation, params)
  req.send_request(options)
end

#update_contact_flow_content(params = {}) ⇒ Struct

Updates the specified flow.

You can also create and update flows using the Connect Customer Flow language.

Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.

Examples:

Request syntax with placeholder values


resp = client.update_contact_flow_content({
  instance_id: "InstanceId", # required
  contact_flow_id: "ContactFlowId", # required
  content: "ContactFlowContent", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance.

  • :contact_flow_id (required, String) —

    The identifier of the flow.

  • :content (required, String) —

    The JSON string that represents the content of the flow. For an example, see Example flow in Connect Customer Flow language.

    Length Constraints: Minimum length of 1. Maximum length of 256000.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



26945
26946
26947
26948
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26945

def update_contact_flow_content(params = {}, options = {})
  req = build_request(:update_contact_flow_content, params)
  req.send_request(options)
end

#update_contact_flow_metadata(params = {}) ⇒ Struct

Updates metadata about specified flow.

Examples:

Request syntax with placeholder values


resp = client.update_contact_flow_metadata({
  instance_id: "InstanceId", # required
  contact_flow_id: "ContactFlowId", # required
  name: "ContactFlowName",
  description: "ContactFlowDescription",
  contact_flow_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_id (required, String) —

    The identifier of the flow.

  • :name (String) —

    The name of the flow.

  • :description (String) —

    The description of the flow.

  • :contact_flow_state (String) —

    The state of flow.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



26988
26989
26990
26991
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26988

def update_contact_flow_metadata(params = {}, options = {})
  req = build_request(:update_contact_flow_metadata, params)
  req.send_request(options)
end

#update_contact_flow_module_alias(params = {}) ⇒ Struct

Updates a specific Aliases metadata, including the version it’s tied to, it’s name, and description.

Examples:

Request syntax with placeholder values


resp = client.update_contact_flow_module_alias({
  instance_id: "InstanceIdOrArn", # required
  contact_flow_module_id: "ContactFlowModuleId", # required
  alias_id: "ResourceId", # required
  name: "ContactFlowModuleName",
  description: "ContactFlowModuleDescription",
  contact_flow_module_version: 1,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_module_id (required, String) —

    The identifier of the flow module.

  • :alias_id (required, String) —

    The identifier of the alias.

  • :name (String) —

    The name of the alias.

  • :description (String) —

    The description of the alias.

  • :contact_flow_module_version (Integer) —

    The version of the flow module.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



27036
27037
27038
27039
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27036

def update_contact_flow_module_alias(params = {}, options = {})
  req = build_request(:update_contact_flow_module_alias, params)
  req.send_request(options)
end

#update_contact_flow_module_content(params = {}) ⇒ Struct

Updates specified flow module for the specified Connect Customer instance.

Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.

Examples:

Request syntax with placeholder values


resp = client.update_contact_flow_module_content({
  instance_id: "InstanceId", # required
  contact_flow_module_id: "ContactFlowModuleId", # required
  content: "ContactFlowModuleContent",
  settings: "FlowModuleSettings",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_module_id (required, String) —

    The identifier of the flow module.

  • :content (String) —

    The JSON string that represents the content of the flow. For an example, see Example flow in Connect Customer Flow language.

  • :settings (String) —

    Serialized JSON string of the flow module Settings schema.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



27086
27087
27088
27089
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27086

def update_contact_flow_module_content(params = {}, options = {})
  req = build_request(:update_contact_flow_module_content, params)
  req.send_request(options)
end

#update_contact_flow_module_metadata(params = {}) ⇒ Struct

Updates metadata about specified flow module.

Examples:

Request syntax with placeholder values


resp = client.update_contact_flow_module_metadata({
  instance_id: "InstanceId", # required
  contact_flow_module_id: "ContactFlowModuleId", # required
  name: "ContactFlowModuleName",
  description: "ContactFlowModuleDescription",
  state: "ACTIVE", # accepts ACTIVE, ARCHIVED
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_flow_module_id (required, String) —

    The identifier of the flow module.

  • :name (String) —

    The name of the flow module.

  • :description (String) —

    The description of the flow module.

  • :state (String) —

    The state of flow module.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



27129
27130
27131
27132
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27129

def update_contact_flow_module_metadata(params = {}, options = {})
  req = build_request(:update_contact_flow_module_metadata, params)
  req.send_request(options)
end

#update_contact_flow_name(params = {}) ⇒ Struct

The name of the flow.

You can also create and update flows using the Connect Customer Flow language.

Examples:

Request syntax with placeholder values


resp = client.update_contact_flow_name({
  instance_id: "InstanceId", # required
  contact_flow_id: "ContactFlowId", # required
  name: "ContactFlowName",
  description: "ContactFlowDescription",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance.

  • :contact_flow_id (required, String) —

    The identifier of the flow.

  • :name (String) —

    The name of the flow.

  • :description (String) —

    The description of the flow.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



27170
27171
27172
27173
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27170

def update_contact_flow_name(params = {}, options = {})
  req = build_request(:update_contact_flow_name, params)
  req.send_request(options)
end

#update_contact_routing_data(params = {}) ⇒ Struct

Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.

Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.

Examples:

Request syntax with placeholder values


resp = client.update_contact_routing_data({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  queue_time_adjustment_seconds: 1,
  queue_priority: 1,
  routing_criteria: {
    steps: [
      {
        expiry: {
          duration_in_seconds: 1,
        },
        expression: {
          attribute_condition: {
            name: "PredefinedAttributeName",
            value: "ProficiencyValue",
            proficiency_level: 1.0,
            range: {
              min_proficiency_level: 1.0,
              max_proficiency_level: 1.0,
            },
            match_criteria: {
              agents_criteria: {
                agent_ids: ["AgentId"],
              },
            },
            comparison_operator: "ComparisonOperator",
          },
          and_expression: [
            {
              # recursive Expression
            },
          ],
          or_expression: [
            {
              # recursive Expression
            },
          ],
          not_attribute_condition: {
            name: "PredefinedAttributeName",
            value: "ProficiencyValue",
            proficiency_level: 1.0,
            range: {
              min_proficiency_level: 1.0,
              max_proficiency_level: 1.0,
            },
            match_criteria: {
              agents_criteria: {
                agent_ids: ["AgentId"],
              },
            },
            comparison_operator: "ComparisonOperator",
          },
        },
      },
    ],
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer.

  • :queue_time_adjustment_seconds (Integer) —

    The number of seconds to add or subtract from the contact's routing age. Contacts are routed to agents on a first-come, first-serve basis. This means that changing their amount of time in queue compared to others also changes their position in queue.

  • :queue_priority (Integer) —

    Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2.

  • :routing_criteria (Types::RoutingCriteriaInput) —

    Updates the routing criteria on the contact. These properties can be used to change how a contact is routed within the queue.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



27289
27290
27291
27292
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27289

def update_contact_routing_data(params = {}, options = {})
  req = build_request(:update_contact_routing_data, params)
  req.send_request(options)
end

#update_contact_schedule(params = {}) ⇒ Struct

Updates the scheduled time of a task contact that is already scheduled.

Examples:

Request syntax with placeholder values


resp = client.update_contact_schedule({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  scheduled_time: Time.now, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact.

  • :scheduled_time (required, Time, DateTime, Date, Integer, String) —

    The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



27327
27328
27329
27330
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27327

def update_contact_schedule(params = {}, options = {})
  req = build_request(:update_contact_schedule, params)
  req.send_request(options)
end

#update_contact_task_template(params = {}) ⇒ Struct

Updates the task template association on an existing task contact. You can update the task template on a contact before assignment to support tasks that are created without a template (for example Rules or disconnect flows) or change the agent interaction form to represent the latest task data (for example an initial request that was submitted as a refund gets updated to an account cancellation and requires a new template).

This operation can only be used with task contacts that are in progress and not connected to an agent. A task template can be updated a maximum of 5 times per contact.

The task's references must be compatible with the fields of the target task template. If the target template has a required field, the task must have a corresponding reference with a matching name and compatible type. The following task template field types map to reference types:

  • TEXT, TEXT_AREA, BOOLEAN, and SINGLE_SELECT map to references of type STRING.

  • NUMBER maps to references of type NUMBER.

  • DATE_TIME maps to references of type DATE.

  • URL maps to references of type URL.

  • EMAIL maps to references of type EMAIL.

References corresponding to TEXT fields must be fewer than 512 characters. TEXT_AREA fields must be fewer than 4,096 characters. BOOLEAN fields must have a value of true or false.

An InvalidRequestException occurs when UpdateContactTaskTemplate is called on a connected or terminated task, when it is called on non-task contacts, and when the task contact already uses the provided task template. A PropertyValidationException occurs when the task's references conflict with the task template's fields, for example if the task is missing a reference that matches a required field, or if the task has a reference that matches a required field's name but not its datatype.

Examples:

Request syntax with placeholder values


resp = client.update_contact_task_template({
  instance_id: "InstanceId", # required
  task_template_id: "TaskTemplateId", # required
  contact_id: "ContactId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :task_template_id (required, String) —

    A unique identifier for the task template. For more information about task templates, see Task templates in the Connect Customer Administrator Guide.

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



27413
27414
27415
27416
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27413

def update_contact_task_template(params = {}, options = {})
  req = build_request(:update_contact_task_template, params)
  req.send_request(options)
end

#update_data_table_attribute(params = {}) ⇒ Types::UpdateDataTableAttributeResponse

Updates all properties for an attribute using all properties from CreateDataTableAttribute. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided. System managed attributes are not mutable by customers. Changing an attribute's validation does not invalidate existing values since validation only runs when values are created or updated.

Examples:

Request syntax with placeholder values


resp = client.update_data_table_attribute({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
  attribute_name: "DataTableName", # required
  name: "DataTableName", # required
  value_type: "TEXT", # required, accepts TEXT, NUMBER, BOOLEAN, TEXT_LIST, NUMBER_LIST
  description: "DataTableDescription",
  primary: false,
  validation: {
    min_length: 1,
    max_length: 1,
    min_values: 1,
    max_values: 1,
    ignore_case: false,
    minimum: 1.0,
    maximum: 1.0,
    exclusive_minimum: 1.0,
    exclusive_maximum: 1.0,
    multiple_of: 1.0,
    enum: {
      strict: false,
      values: ["String"],
    },
  },
})

Response structure


resp.name #=> String
resp.lock_version.data_table #=> String
resp.lock_version.attribute #=> String
resp.lock_version.primary_values #=> String
resp.lock_version.value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table. Must also accept the table ARN with or without a version alias.

  • :attribute_name (required, String) —

    The current name of the attribute to update. Used as an identifier since attribute names can be changed.

  • :name (required, String) —

    The new name for the attribute. Must conform to Connect human readable string specification and be unique within the data table.

  • :value_type (required, String) —

    The updated value type for the attribute. When changing value types, existing values are not deleted but may return default values if incompatible.

  • :description (String) —

    The updated description for the attribute.

  • :primary (Boolean) —

    Whether the attribute should be treated as a primary key. Converting to primary attribute requires existing values to maintain uniqueness.

  • :validation (Types::Validation) —

    The updated validation rules for the attribute. Changes do not affect existing values until they are modified.

Returns:

See Also:



27501
27502
27503
27504
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27501

def update_data_table_attribute(params = {}, options = {})
  req = build_request(:update_data_table_attribute, params)
  req.send_request(options)
end

#update_data_table_metadata(params = {}) ⇒ Types::UpdateDataTableMetadataResponse

Updates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable.

Examples:

Request syntax with placeholder values


resp = client.update_data_table_metadata({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
  name: "DataTableName", # required
  description: "DataTableDescription",
  value_lock_level: "NONE", # required, accepts NONE, DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE
  time_zone: "TimeZone", # required
})

Response structure


resp.lock_version.data_table #=> String
resp.lock_version.attribute #=> String
resp.lock_version.primary_values #=> String
resp.lock_version.value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the version is provided as part of the identifier or ARN, the version must be $LATEST. Providing any other alias fails with an error.

  • :name (required, String) —

    The updated name for the data table. Must conform to Connect human readable string specification and have 1-127 characters. Must be unique for the instance using case-insensitive comparison.

  • :description (String) —

    The updated description for the data table. Must conform to Connect human readable string specification and have 0-250 characters.

  • :value_lock_level (required, String) —

    The updated value lock level for the data table. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE.

  • :time_zone (required, String) —

    The updated IANA timezone identifier to use when resolving time based dynamic values.

Returns:

See Also:



27564
27565
27566
27567
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27564

def update_data_table_metadata(params = {}, options = {})
  req = build_request(:update_data_table_metadata, params)
  req.send_request(options)
end

#update_data_table_primary_values(params = {}) ⇒ Types::UpdateDataTablePrimaryValuesResponse

Updates the primary values for a record. This operation affects all existing values that are currently associated to the record and its primary values. Users that have restrictions on attributes and/or primary values are not authorized to use this endpoint. The combination of new primary values must be unique within the table.

Examples:

Request syntax with placeholder values


resp = client.update_data_table_primary_values({
  instance_id: "InstanceId", # required
  data_table_id: "DataTableId", # required
  primary_values: [ # required
    {
      attribute_name: "DataTableName", # required
      value: "String", # required
    },
  ],
  new_primary_values: [ # required
    {
      attribute_name: "DataTableName", # required
      value: "String", # required
    },
  ],
  lock_version: { # required
    data_table: "String",
    attribute: "String",
    primary_values: "String",
    value: "String",
  },
})

Response structure


resp.lock_version.data_table #=> String
resp.lock_version.attribute #=> String
resp.lock_version.primary_values #=> String
resp.lock_version.value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The unique identifier for the Amazon Connect instance.

  • :data_table_id (required, String) —

    The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the version is provided as part of the identifier or ARN, the version must be one of the two available system managed aliases, $SAVED or $LATEST.

  • :primary_values (required, Array<Types::PrimaryValue>) —

    The current primary values for the record. Required and must include values for all primary attributes. Fails if the table has primary attributes and some primary values are omitted.

  • :new_primary_values (required, Array<Types::PrimaryValue>) —

    The new primary values for the record. Required and must include values for all primary attributes. The combination must be unique within the table.

  • :lock_version (required, Types::DataTableLockVersion) —

    The lock version information required for optimistic locking to prevent concurrent modifications.

Returns:

See Also:



27638
27639
27640
27641
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27638

def update_data_table_primary_values(params = {}, options = {})
  req = build_request(:update_data_table_primary_values, params)
  req.send_request(options)
end

#update_email_address_metadata(params = {}) ⇒ Types::UpdateEmailAddressMetadataResponse

Updates an email address metadata. For more information about email addresses, see Create email addresses in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.update_email_address_metadata({
  instance_id: "InstanceId", # required
  email_address_id: "EmailAddressId", # required
  description: "Description",
  display_name: "EmailAddressDisplayName",
  client_token: "ClientToken",
})

Response structure


resp.email_address_id #=> String
resp.email_address_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :email_address_id (required, String) —

    The identifier of the email address.

  • :description (String) —

    The description of the email address.

  • :display_name (String) —

    The display name of email address.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Returns:

See Also:



27702
27703
27704
27705
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27702

def update_email_address_metadata(params = {}, options = {})
  req = build_request(:update_email_address_metadata, params)
  req.send_request(options)
end

#update_evaluation_form(params = {}) ⇒ Types::UpdateEvaluationFormResponse

Updates details about a specific evaluation form version in the specified Connect Customer instance. Question and section identifiers cannot be duplicated within the same evaluation form.

This operation does not support partial updates. Instead it does a full update of evaluation form content.

Examples:

Request syntax with placeholder values


resp = client.update_evaluation_form({
  instance_id: "InstanceId", # required
  evaluation_form_id: "ResourceId", # required
  evaluation_form_version: 1, # required
  create_new_version: false,
  title: "EvaluationFormTitle", # required
  description: "EvaluationFormDescription",
  items: [ # required
    {
      section: {
        title: "EvaluationFormSectionTitle", # required
        ref_id: "ReferenceId", # required
        instructions: "EvaluationFormQuestionInstructions",
        items: { # required
          # recursive EvaluationFormItemsList
        },
        weight: 1.0,
        is_excluded_from_scoring: false,
        score_thresholds: [
          {
            performance_category: "NEEDS_IMPROVEMENT", # required, accepts NEEDS_IMPROVEMENT, EXCEEDS_EXPECTATIONS
            min_score_percentage: 1.0,
            max_score_percentage: 1.0,
          },
        ],
      },
      question: {
        title: "EvaluationFormQuestionTitle", # required
        instructions: "EvaluationFormQuestionInstructions",
        ref_id: "ReferenceId", # required
        not_applicable_enabled: false,
        question_type: "TEXT", # required, accepts TEXT, SINGLESELECT, NUMERIC, MULTISELECT, DATETIME
        question_type_properties: {
          numeric: {
            min_value: 1, # required
            max_value: 1, # required
            options: [
              {
                min_value: 1, # required
                max_value: 1, # required
                score: 1,
                automatic_fail: false,
                automatic_fail_configuration: {
                  target_section: "ReferenceId",
                },
                points_configuration: {
                  point_value: 1, # required
                  is_bonus: false,
                },
              },
            ],
            automation: {
              property_value: {
                label: "OVERALL_CUSTOMER_SENTIMENT_SCORE", # required, accepts OVERALL_CUSTOMER_SENTIMENT_SCORE, OVERALL_AGENT_SENTIMENT_SCORE, CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT, CUSTOMER_SENTIMENT_SCORE_WITH_AGENT, NON_TALK_TIME, NON_TALK_TIME_PERCENTAGE, NUMBER_OF_INTERRUPTIONS, CONTACT_DURATION, AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME, LONGEST_HOLD_DURATION, NUMBER_OF_HOLDS, AGENT_INTERACTION_AND_HOLD_DURATION
              },
              answer_source: {
                source_type: "CONTACT_LENS_DATA", # required, accepts CONTACT_LENS_DATA, GEN_AI
              },
            },
          },
          single_select: {
            options: [ # required
              {
                ref_id: "ReferenceId", # required
                text: "EvaluationFormSingleSelectQuestionOptionText", # required
                score: 1,
                automatic_fail: false,
                automatic_fail_configuration: {
                  target_section: "ReferenceId",
                },
                points_configuration: {
                  point_value: 1, # required
                  is_bonus: false,
                },
              },
            ],
            display_as: "DROPDOWN", # accepts DROPDOWN, RADIO
            automation: {
              options: [
                {
                  rule_category: {
                    category: "SingleSelectQuestionRuleCategoryAutomationLabel", # required
                    condition: "PRESENT", # required, accepts PRESENT, NOT_PRESENT
                    option_ref_id: "ReferenceId", # required
                  },
                },
              ],
              default_option_ref_id: "ReferenceId",
              answer_source: {
                source_type: "CONTACT_LENS_DATA", # required, accepts CONTACT_LENS_DATA, GEN_AI
              },
            },
          },
          text: {
            automation: {
              answer_source: {
                source_type: "CONTACT_LENS_DATA", # required, accepts CONTACT_LENS_DATA, GEN_AI
              },
            },
          },
          multi_select: {
            options: [ # required
              {
                ref_id: "ReferenceId", # required
                text: "EvaluationFormMultiSelectQuestionOptionText", # required
                score: 1,
                automatic_fail: false,
                automatic_fail_configuration: {
                  target_section: "ReferenceId",
                },
                points_configuration: {
                  point_value: 1, # required
                  is_bonus: false,
                },
              },
            ],
            display_as: "DROPDOWN", # accepts DROPDOWN, CHECKBOX
            automation: {
              options: [
                {
                  rule_category: {
                    category: "MultiSelectQuestionRuleCategoryAutomationLabel", # required
                    condition: "PRESENT", # required, accepts PRESENT, NOT_PRESENT
                    option_ref_ids: ["ReferenceId"], # required
                  },
                },
              ],
              default_option_ref_ids: ["ReferenceId"],
              answer_source: {
                source_type: "CONTACT_LENS_DATA", # required, accepts CONTACT_LENS_DATA, GEN_AI
              },
            },
          },
        },
        enablement: {
          condition: { # required
            operands: [ # required
              {
                expression: {
                  source: { # required
                    type: "QUESTION_REF_ID", # required, accepts QUESTION_REF_ID
                    ref_id: "ReferenceId",
                  },
                  values: [ # required
                    {
                      type: "OPTION_REF_ID", # required, accepts OPTION_REF_ID
                      ref_id: "ReferenceId",
                    },
                  ],
                  comparator: "IN", # required, accepts IN, NOT_IN, ALL_IN, EXACT
                },
                condition: {
                  # recursive EvaluationFormItemEnablementCondition
                },
              },
            ],
            operator: "OR", # accepts OR, AND
          },
          action: "DISABLE", # required, accepts DISABLE, ENABLE
          default_action: "DISABLE", # accepts DISABLE, ENABLE
        },
        weight: 1.0,
        scoring_configuration: {
          points_configuration: {
            max_point_value: 1,
            min_point_value: 1,
            is_bonus: false,
          },
          is_excluded_from_scoring: false,
          score_thresholds: [
            {
              performance_category: "NEEDS_IMPROVEMENT", # required, accepts NEEDS_IMPROVEMENT, EXCEEDS_EXPECTATIONS
              min_score_percentage: 1.0,
              max_score_percentage: 1.0,
            },
          ],
        },
      },
    },
  ],
  scoring_strategy: {
    mode: "QUESTION_ONLY", # required, accepts QUESTION_ONLY, SECTION_ONLY, POINTS_BASED
    status: "ENABLED", # required, accepts ENABLED, DISABLED
    score_thresholds: [
      {
        performance_category: "NEEDS_IMPROVEMENT", # required, accepts NEEDS_IMPROVEMENT, EXCEEDS_EXPECTATIONS
        min_score_percentage: 1.0,
        max_score_percentage: 1.0,
      },
    ],
  },
  auto_evaluation_configuration: {
    enabled: false, # required
  },
  review_configuration: {
    review_notification_recipients: [ # required
      {
        type: "USER_ID", # required, accepts USER_ID
        value: { # required
          user_id: "ResourceId",
        },
      },
    ],
    eligibility_days: 1,
  },
  as_draft: false,
  client_token: "ClientToken",
  target_configuration: {
    contact_interaction_type: "AGENT", # required, accepts AGENT, AUTOMATED, CUSTOMER
  },
  language_configuration: {
    form_language: "de-DE", # accepts de-DE, en-US, es-ES, fr-FR, it-IT, pt-BR, ja-JP, ko-KR, zh-CN, ms-MY
  },
})

Response structure


resp.evaluation_form_id #=> String
resp.evaluation_form_arn #=> String
resp.evaluation_form_version #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :evaluation_form_id (required, String) —

    The unique identifier for the evaluation form.

  • :evaluation_form_version (required, Integer) —

    A version of the evaluation form to update.

  • :create_new_version (Boolean) —

    A flag indicating whether the operation must create a new version.

  • :title (required, String) —

    A title of the evaluation form.

  • :description (String) —

    The description of the evaluation form.

  • :items (required, Array<Types::EvaluationFormItem>) —

    Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

  • :scoring_strategy (Types::EvaluationFormScoringStrategy) —

    A scoring strategy of the evaluation form.

  • :auto_evaluation_configuration (Types::EvaluationFormAutoEvaluationConfiguration) —

    Whether automated evaluations are enabled.

  • :review_configuration (Types::EvaluationReviewConfiguration) —

    Configuration for evaluation review settings of the evaluation form.

  • :as_draft (Boolean) —

    A boolean flag indicating whether to update evaluation form to draft state.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :target_configuration (Types::EvaluationFormTargetConfiguration) —

    Configuration that specifies the target for the evaluation form.

  • :language_configuration (Types::EvaluationFormLanguageConfiguration) —

    Configuration for language settings of the evaluation form.

Returns:

See Also:



28007
28008
28009
28010
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28007

def update_evaluation_form(params = {}, options = {})
  req = build_request(:update_evaluation_form, params)
  req.send_request(options)
end

#update_hours_of_operation(params = {}) ⇒ Struct

Updates the hours of operation.

Examples:

Request syntax with placeholder values


resp = client.update_hours_of_operation({
  instance_id: "InstanceId", # required
  hours_of_operation_id: "HoursOfOperationId", # required
  name: "CommonNameLength127",
  description: "UpdateHoursOfOperationDescription",
  time_zone: "TimeZone",
  config: [
    {
      day: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
      start_time: { # required
        hours: 1, # required
        minutes: 1, # required
      },
      end_time: { # required
        hours: 1, # required
        minutes: 1, # required
      },
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :hours_of_operation_id (required, String) —

    The identifier of the hours of operation.

  • :name (String) —

    The name of the hours of operation.

  • :description (String) —

    The description of the hours of operation.

  • :time_zone (String) —

    The time zone of the hours of operation.

  • :config (Array<Types::HoursOfOperationConfig>) —

    Configuration information of the hours of operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



28066
28067
28068
28069
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28066

def update_hours_of_operation(params = {}, options = {})
  req = build_request(:update_hours_of_operation, params)
  req.send_request(options)
end

#update_hours_of_operation_override(params = {}) ⇒ Struct

Update the hours of operation override.

Examples:

Request syntax with placeholder values


resp = client.update_hours_of_operation_override({
  instance_id: "InstanceId", # required
  hours_of_operation_id: "HoursOfOperationId", # required
  hours_of_operation_override_id: "HoursOfOperationOverrideId", # required
  name: "CommonHumanReadableName",
  description: "CommonHumanReadableDescription",
  config: [
    {
      day: "SUNDAY", # accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
      start_time: {
        hours: 1, # required
        minutes: 1, # required
      },
      end_time: {
        hours: 1, # required
        minutes: 1, # required
      },
    },
  ],
  effective_from: "HoursOfOperationOverrideYearMonthDayDateFormat",
  effective_till: "HoursOfOperationOverrideYearMonthDayDateFormat",
  recurrence_config: {
    recurrence_pattern: { # required
      frequency: "WEEKLY", # required, accepts WEEKLY, MONTHLY, YEARLY
      interval: 1, # required
      by_month: [1],
      by_month_day: [1],
      by_weekday_occurrence: [1],
    },
  },
  override_type: "STANDARD", # accepts STANDARD, OPEN, CLOSED
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance.

  • :hours_of_operation_id (required, String) —

    The identifier for the hours of operation.

  • :hours_of_operation_override_id (required, String) —

    The identifier for the hours of operation override.

  • :name (String) —

    The name of the hours of operation override.

  • :description (String) —

    The description of the hours of operation override.

  • :config (Array<Types::HoursOfOperationOverrideConfig>) —

    Configuration information for the hours of operation override: day, start time, and end time.

  • :effective_from (String) —

    The date from when the hours of operation override would be effective.

  • :effective_till (String) —

    The date until the hours of operation override is effective.

  • :recurrence_config (Types::RecurrenceConfig) —

    Configuration for a recurring event.

  • :override_type (String) —

    Whether the override will be defined as a standard or as a recurring event.

    For more information about how override types are applied, see Build your list of overrides in the Administrator Guide.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



28153
28154
28155
28156
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28153

def update_hours_of_operation_override(params = {}, options = {})
  req = build_request(:update_hours_of_operation_override, params)
  req.send_request(options)
end

#update_instance_attribute(params = {}) ⇒ Struct

This API is in preview release for Connect Customer and is subject to change.

Updates the value for the specified attribute type.

Examples:

Request syntax with placeholder values


resp = client.update_instance_attribute({
  instance_id: "InstanceId", # required
  attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA, MULTI_PARTY_CONFERENCE, HIGH_VOLUME_OUTBOUND, ENHANCED_CONTACT_MONITORING, ENHANCED_CHAT_MONITORING, MULTI_PARTY_CHAT_CONFERENCE, MESSAGE_STREAMING
  value: "InstanceAttributeValue", # required
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :attribute_type (required, String) —

    The type of attribute.

    Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.

    If you set the attribute type as MESSAGE_STREAMING, you need to update the Lex bot alias resource based policy to include the lex:RecognizeMessageAsync action for the connect instance ARN resource.

  • :value (required, String) —

    The value for the attribute. Maximum character limit is 100.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



28218
28219
28220
28221
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28218

def update_instance_attribute(params = {}, options = {})
  req = build_request(:update_instance_attribute, params)
  req.send_request(options)
end

#update_instance_storage_config(params = {}) ⇒ Struct

This API is in preview release for Connect Customer and is subject to change.

Updates an existing configuration for a resource type. This API is idempotent.

Examples:

Request syntax with placeholder values


resp = client.update_instance_storage_config({
  instance_id: "InstanceId", # required
  association_id: "AssociationId", # required
  resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, ATTACHMENTS, CONTACT_EVALUATIONS, SCREEN_RECORDINGS, REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS, REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS, EMAIL_MESSAGES
  storage_config: { # required
    association_id: "AssociationId",
    storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
    s3_config: {
      bucket_name: "BucketName", # required
      bucket_prefix: "Prefix", # required
      encryption_config: {
        encryption_type: "KMS", # required, accepts KMS
        key_id: "KeyId", # required
      },
    },
    kinesis_video_stream_config: {
      prefix: "Prefix", # required
      retention_period_hours: 1, # required
      encryption_config: { # required
        encryption_type: "KMS", # required, accepts KMS
        key_id: "KeyId", # required
      },
    },
    kinesis_stream_config: {
      stream_arn: "ARN", # required
    },
    kinesis_firehose_config: {
      firehose_arn: "ARN", # required
    },
  },
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :association_id (required, String) —

    The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

  • :resource_type (required, String) —

    A valid resource type.

  • :storage_config (required, Types::InstanceStorageConfig) —

    The storage configuration for the instance.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



28301
28302
28303
28304
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28301

def update_instance_storage_config(params = {}, options = {})
  req = build_request(:update_instance_storage_config, params)
  req.send_request(options)
end

#update_metric_content(params = {}) ⇒ Struct

Updates the calculation, unit, and/or trend indicator of an existing metric in the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.update_metric_content({
  instance_id: "InstanceId", # required
  metric_id: "MetricId", # required
  metric_calculation: {
    calculation_components: [ # required
      {
        alias: "ComponentAlias", # required
        metric_name: "MetricName",
        metric_id: "MetricId",
        metric_filters: [
          {
            metric_filter_key: "MetricFilterKey", # required
            negate: false,
            number_condition: {
              comparison: "LESSER", # required, accepts LESSER, LESSER_OR_EQUAL, GREATER, GREATER_OR_EQUAL
              values: [1.0], # required
            },
            string_condition: {
              comparison: "MATCHES_ANY", # required, accepts MATCHES_ANY, MATCHES_NONE
              values: ["String"], # required
            },
            boolean_condition: {
              comparison: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
            },
          },
        ],
      },
    ],
    calculation: "CalculationExpression", # required
  },
  unit: "INTEGER", # accepts INTEGER, DOUBLE, PERCENT, SECONDS
  positive_trend_indicator: "POSITIVE", # accepts POSITIVE, NEGATIVE, NEUTRAL
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :metric_id (required, String) —

    The identifier of the metric to update. Adding the $SAVED qualifier will update the saved version of the metric. Adding $LATEST or omitting a qualifier will update the published version.

  • :metric_calculation (Types::MetricCalculation) —

    The updated calculation definition for the metric.

  • :unit (String) —

    The updated display unit for the metric.

  • :positive_trend_indicator (String) —

    How an increase in the metric value should be interpreted. Valid values: POSITIVE, NEUTRAL, NEGATIVE.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



28374
28375
28376
28377
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28374

def update_metric_content(params = {}, options = {})
  req = build_request(:update_metric_content, params)
  req.send_request(options)
end

#update_metric_metadata(params = {}) ⇒ Struct

Updates the name and/or description of an existing metric in the specified Connect Customer instance.

Examples:

Request syntax with placeholder values


resp = client.update_metric_metadata({
  instance_id: "InstanceId", # required
  metric_id: "MetricId", # required
  name: "MetricName",
  description: "MetricDescription",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :metric_id (required, String) —

    The identifier of the metric to update. Adding the $SAVED qualifier will update the saved version of the metric. Adding $LATEST or omitting a qualifier will update the published version.

  • :name (String) —

    The updated name of the metric.

  • :description (String) —

    The updated description of the metric.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



28416
28417
28418
28419
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28416

def update_metric_metadata(params = {}, options = {})
  req = build_request(:update_metric_metadata, params)
  req.send_request(options)
end

#update_notification_content(params = {}) ⇒ Struct

Updates the localized content of an existing notification. This operation applies to all users for whom the notification was sent.

Examples:

Request syntax with placeholder values


resp = client.update_notification_content({
  instance_id: "InstanceId", # required
  notification_id: "NotificationId", # required
  content: { # required
    "en_US" => "LocalizedString",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :notification_id (required, String) —

    The unique identifier for the notification to update.

  • :content (required, Hash<String,String>) —

    The updated localized content of the notification. A map of locale codes and values. Maximum 500 characters per locale.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



28455
28456
28457
28458
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28455

def update_notification_content(params = {}, options = {})
  req = build_request(:update_notification_content, params)
  req.send_request(options)
end

#update_participant_authentication(params = {}) ⇒ Struct

Instructs Connect Customer to resume the authentication process. The subsequent actions depend on the request body contents:

  • If a code is provided: Connect retrieves the identity information from Amazon Cognito and imports it into Connect Customer Profiles.

  • If an error is provided: The error branch of the Authenticate Customer block is executed.

The API returns a success response to acknowledge the request. However, the interaction and exchange of identity information occur asynchronously after the response is returned.

Examples:

Request syntax with placeholder values


resp = client.update_participant_authentication({
  state: "ParticipantToken", # required
  instance_id: "InstanceId", # required
  code: "AuthorizationCode",
  error: "AuthenticationError",
  error_description: "AuthenticationErrorDescription",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :state (required, String) —

    The state query parameter that was provided by Cognito in the redirectUri. This will also match the state parameter provided in the AuthenticationUrl from the GetAuthenticationUrl response.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :code (String) —

    The code query parameter provided by Cognito in the redirectUri.

  • :error (String) —

    The error query parameter provided by Cognito in the redirectUri.

  • :error_description (String) —

    The error_description parameter provided by Cognito in the redirectUri.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



28519
28520
28521
28522
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28519

def update_participant_authentication(params = {}, options = {})
  req = build_request(:update_participant_authentication, params)
  req.send_request(options)
end

#update_participant_role_config(params = {}) ⇒ Struct

Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:

  • Customer idle timeout

  • Customer auto-disconnect timeout

  • Agent idle timeout

  • Agent auto-disconnect timeout

For more information about how chat timeouts work, see Set up chat timeouts for human participants.

Examples:

Request syntax with placeholder values


resp = client.update_participant_role_config({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  channel_configuration: { # required
    chat: {
      participant_timer_config_list: [ # required
        {
          participant_role: "CUSTOMER", # required, accepts CUSTOMER, AGENT
          timer_type: "IDLE", # required, accepts IDLE, DISCONNECT_NONCUSTOMER
          timer_value: { # required
            participant_timer_action: "Unset", # accepts Unset
            participant_timer_duration_in_minutes: 1,
          },
        },
      ],
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :contact_id (required, String) —

    The identifier of the contact in this instance of Connect Customer.

  • :channel_configuration (required, Types::UpdateParticipantRoleConfigChannelInfo) —

    The Connect Customer channel you want to configure.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



28584
28585
28586
28587
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28584

def update_participant_role_config(params = {}, options = {})
  req = build_request(:update_participant_role_config, params)
  req.send_request(options)
end

#update_phone_number(params = {}) ⇒ Types::UpdatePhoneNumberResponse

Updates your claimed phone number from its current Connect Customer instance or traffic distribution group to another Connect Customer instance or traffic distribution group in the same Amazon Web Services Region.

After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.

You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.

Examples:

Request syntax with placeholder values


resp = client.update_phone_number({
  phone_number_id: "PhoneNumberId", # required
  target_arn: "ARN",
  instance_id: "InstanceId",
  client_token: "ClientToken",
})

Response structure


resp.phone_number_id #=> String
resp.phone_number_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    A unique identifier for the phone number.

  • :target_arn (String) —

    The Amazon Resource Name (ARN) for Connect Customer instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.

  • :instance_id (String) —

    The identifier of the Connect Customer instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



28662
28663
28664
28665
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28662

def update_phone_number(params = {}, options = {})
  req = build_request(:update_phone_number, params)
  req.send_request(options)
end

#update_phone_number_metadata(params = {}) ⇒ Struct

Updates a phone number’s metadata.

To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.

Examples:

Request syntax with placeholder values


resp = client.update_phone_number_metadata({
  phone_number_id: "PhoneNumberId", # required
  phone_number_description: "PhoneNumberDescription",
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    The Amazon Resource Name (ARN) or resource ID of the phone number.

  • :phone_number_description (String) —

    The description of the phone number.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



28709
28710
28711
28712
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28709

def update_phone_number_metadata(params = {}, options = {})
  req = build_request(:update_phone_number_metadata, params)
  req.send_request(options)
end

#update_predefined_attribute(params = {}) ⇒ Struct

Updates a predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value.

For the predefined attributes per instance quota, see Connect Customer quotas.

Use cases

Following are common uses cases for this API:

  • Update routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.

  • Update an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see Use contact segment attributes.

Endpoints: See Connect Customer endpoints and quotas.

Examples:

Request syntax with placeholder values


resp = client.update_predefined_attribute({
  instance_id: "InstanceId", # required
  name: "PredefinedAttributeName", # required
  values: {
    string_list: ["PredefinedAttributeStringValue"],
  },
  purposes: ["PredefinedAttributePurposeName"],
  attribute_configuration: {
    enable_value_validation_on_association: false,
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    The name of the predefined attribute.

  • :values (Types::PredefinedAttributeValues) —

    The values of the predefined attribute.

  • :purposes (Array<String>) —

    Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Connect Customer admin website.

  • :attribute_configuration (Types::InputPredefinedAttributeConfiguration) —

    Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Connect Customer admin website.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



28784
28785
28786
28787
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28784

def update_predefined_attribute(params = {}, options = {})
  req = build_request(:update_predefined_attribute, params)
  req.send_request(options)
end

#update_prompt(params = {}) ⇒ Types::UpdatePromptResponse

Updates a prompt.

Examples:

Request syntax with placeholder values


resp = client.update_prompt({
  instance_id: "InstanceId", # required
  prompt_id: "PromptId", # required
  name: "CommonNameLength127",
  description: "PromptDescription",
  s3_uri: "S3Uri",
})

Response structure


resp.prompt_arn #=> String
resp.prompt_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :prompt_id (required, String) —

    A unique identifier for the prompt.

  • :name (String) —

    The name of the prompt.

  • :description (String) —

    A description of the prompt.

  • :s3_uri (String) —

    The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.

Returns:

See Also:



28841
28842
28843
28844
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28841

def update_prompt(params = {}, options = {})
  req = build_request(:update_prompt, params)
  req.send_request(options)
end

#update_queue_hours_of_operation(params = {}) ⇒ Struct

Updates the hours of operation for the specified queue.

Examples:

Request syntax with placeholder values


resp = client.update_queue_hours_of_operation({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  hours_of_operation_id: "HoursOfOperationId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :queue_id (required, String) —

    The identifier for the queue.

  • :hours_of_operation_id (required, String) —

    The identifier for the hours of operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



28876
28877
28878
28879
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28876

def update_queue_hours_of_operation(params = {}, options = {})
  req = build_request(:update_queue_hours_of_operation, params)
  req.send_request(options)
end

#update_queue_max_contacts(params = {}) ⇒ Struct

Updates the maximum number of contacts allowed in a queue before it is considered full.

Examples:

Request syntax with placeholder values


resp = client.update_queue_max_contacts({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  max_contacts: 1,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :queue_id (required, String) —

    The identifier for the queue.

  • :max_contacts (Integer) —

    The maximum number of contacts that can be in the queue before it is considered full.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



28913
28914
28915
28916
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28913

def update_queue_max_contacts(params = {}, options = {})
  req = build_request(:update_queue_max_contacts, params)
  req.send_request(options)
end

#update_queue_name(params = {}) ⇒ Struct

Updates the name and description of a queue. At least Name or Description must be provided.

Examples:

Request syntax with placeholder values


resp = client.update_queue_name({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  name: "CommonNameLength127",
  description: "QueueDescription",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :queue_id (required, String) —

    The identifier for the queue.

  • :name (String) —

    The name of the queue.

  • :description (String) —

    The description of the queue.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



28953
28954
28955
28956
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28953

def update_queue_name(params = {}, options = {})
  req = build_request(:update_queue_name, params)
  req.send_request(options)
end

#update_queue_outbound_caller_config(params = {}) ⇒ Struct

Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.

  • If the phone number is claimed to a traffic distribution group that was created in the same Region as the Connect Customer instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

  • Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.

  • If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.

Examples:

Request syntax with placeholder values


resp = client.update_queue_outbound_caller_config({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  outbound_caller_config: { # required
    outbound_caller_id_name: "OutboundCallerIdName",
    outbound_caller_id_number_id: "PhoneNumberId",
    outbound_flow_id: "ContactFlowId",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :queue_id (required, String) —

    The identifier for the queue.

  • :outbound_caller_config (required, Types::OutboundCallerConfig) —

    The outbound caller ID name, number, and outbound whisper flow.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



29020
29021
29022
29023
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29020

def update_queue_outbound_caller_config(params = {}, options = {})
  req = build_request(:update_queue_outbound_caller_config, params)
  req.send_request(options)
end

#update_queue_outbound_email_config(params = {}) ⇒ Struct

Updates the outbound email address Id for a specified queue.

Examples:

Request syntax with placeholder values


resp = client.update_queue_outbound_email_config({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  outbound_email_config: { # required
    outbound_email_address_id: "EmailAddressId",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :queue_id (required, String) —

    The identifier for the queue.

  • :outbound_email_config (required, Types::OutboundEmailConfig) —

    The outbound email address ID for a specified queue.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



29057
29058
29059
29060
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29057

def update_queue_outbound_email_config(params = {}, options = {})
  req = build_request(:update_queue_outbound_email_config, params)
  req.send_request(options)
end

#update_queue_status(params = {}) ⇒ Struct

Updates the status of the queue.

Examples:

Request syntax with placeholder values


resp = client.update_queue_status({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  status: "ENABLED", # required, accepts ENABLED, DISABLED
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :queue_id (required, String) —

    The identifier for the queue.

  • :status (required, String) —

    The status of the queue.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



29092
29093
29094
29095
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29092

def update_queue_status(params = {}, options = {})
  req = build_request(:update_queue_status, params)
  req.send_request(options)
end

#update_quick_connect_config(params = {}) ⇒ Struct

Updates the configuration settings for the specified quick connect.

Examples:

Request syntax with placeholder values


resp = client.update_quick_connect_config({
  instance_id: "InstanceId", # required
  quick_connect_id: "QuickConnectId", # required
  quick_connect_config: { # required
    quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER, FLOW
    user_config: {
      user_id: "UserId", # required
      contact_flow_id: "ContactFlowId", # required
    },
    queue_config: {
      queue_id: "QueueId", # required
      contact_flow_id: "ContactFlowId", # required
    },
    phone_config: {
      phone_number: "PhoneNumber", # required
    },
    flow_config: {
      contact_flow_id: "ContactFlowId", # required
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :quick_connect_id (required, String) —

    The identifier for the quick connect.

  • :quick_connect_config (required, Types::QuickConnectConfig) —

    Information about the configuration settings for the quick connect.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



29143
29144
29145
29146
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29143

def update_quick_connect_config(params = {}, options = {})
  req = build_request(:update_quick_connect_config, params)
  req.send_request(options)
end

#update_quick_connect_name(params = {}) ⇒ Struct

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

Examples:

Request syntax with placeholder values


resp = client.update_quick_connect_name({
  instance_id: "InstanceId", # required
  quick_connect_id: "QuickConnectId", # required
  name: "QuickConnectName",
  description: "UpdateQuickConnectDescription",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :quick_connect_id (required, String) —

    The identifier for the quick connect.

  • :name (String) —

    The name of the quick connect.

  • :description (String) —

    The description of the quick connect.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



29184
29185
29186
29187
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29184

def update_quick_connect_name(params = {}, options = {})
  req = build_request(:update_quick_connect_name, params)
  req.send_request(options)
end

#update_routing_profile_agent_availability_timer(params = {}) ⇒ Struct

Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

Examples:

Request syntax with placeholder values


resp = client.update_routing_profile_agent_availability_timer({
  instance_id: "InstanceId", # required
  routing_profile_id: "RoutingProfileId", # required
  agent_availability_timer: "TIME_SINCE_LAST_ACTIVITY", # required, accepts TIME_SINCE_LAST_ACTIVITY, TIME_SINCE_LAST_INBOUND
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :routing_profile_id (required, String) —

    The identifier of the routing profile.

  • :agent_availability_timer (required, String) —

    Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



29223
29224
29225
29226
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29223

def update_routing_profile_agent_availability_timer(params = {}, options = {})
  req = build_request(:update_routing_profile_agent_availability_timer, params)
  req.send_request(options)
end

#update_routing_profile_concurrency(params = {}) ⇒ Struct

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

Examples:

Request syntax with placeholder values


resp = client.update_routing_profile_concurrency({
  instance_id: "InstanceId", # required
  routing_profile_id: "RoutingProfileId", # required
  media_concurrencies: [ # required
    {
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      concurrency: 1, # required
      cross_channel_behavior: {
        behavior_type: "ROUTE_CURRENT_CHANNEL_ONLY", # required, accepts ROUTE_CURRENT_CHANNEL_ONLY, ROUTE_ANY_CHANNEL
      },
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :routing_profile_id (required, String) —

    The identifier of the routing profile.

  • :media_concurrencies (required, Array<Types::MediaConcurrency>) —

    The channels that agents can handle in the Contact Control Panel (CCP).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



29268
29269
29270
29271
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29268

def update_routing_profile_concurrency(params = {}, options = {})
  req = build_request(:update_routing_profile_concurrency, params)
  req.send_request(options)
end

#update_routing_profile_default_outbound_queue(params = {}) ⇒ Struct

Updates the default outbound queue of a routing profile.

Examples:

Request syntax with placeholder values


resp = client.update_routing_profile_default_outbound_queue({
  instance_id: "InstanceId", # required
  routing_profile_id: "RoutingProfileId", # required
  default_outbound_queue_id: "QueueId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :routing_profile_id (required, String) —

    The identifier of the routing profile.

  • :default_outbound_queue_id (required, String) —

    The identifier for the default outbound queue.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



29303
29304
29305
29306
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29303

def update_routing_profile_default_outbound_queue(params = {}, options = {})
  req = build_request(:update_routing_profile_default_outbound_queue, params)
  req.send_request(options)
end

#update_routing_profile_name(params = {}) ⇒ Struct

Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.

Examples:

Request syntax with placeholder values


resp = client.update_routing_profile_name({
  instance_id: "InstanceId", # required
  routing_profile_id: "RoutingProfileId", # required
  name: "RoutingProfileName",
  description: "RoutingProfileDescription",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :routing_profile_id (required, String) —

    The identifier of the routing profile.

  • :name (String) —

    The name of the routing profile. Must not be more than 127 characters.

  • :description (String) —

    The description of the routing profile. Must not be more than 250 characters.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



29345
29346
29347
29348
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29345

def update_routing_profile_name(params = {}, options = {})
  req = build_request(:update_routing_profile_name, params)
  req.send_request(options)
end

#update_routing_profile_queues(params = {}) ⇒ Struct

Updates the properties associated with a set of queues for a routing profile.

Examples:

Request syntax with placeholder values


resp = client.update_routing_profile_queues({
  instance_id: "InstanceId", # required
  routing_profile_id: "RoutingProfileId", # required
  queue_configs: [ # required
    {
      queue_reference: { # required
        queue_id: "QueueId", # required
        channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      },
      priority: 1, # required
      delay: 1, # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :routing_profile_id (required, String) —

    The identifier of the routing profile.

  • :queue_configs (required, Array<Types::RoutingProfileQueueConfig>) —

    The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



29392
29393
29394
29395
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29392

def update_routing_profile_queues(params = {}, options = {})
  req = build_request(:update_routing_profile_queues, params)
  req.send_request(options)
end

#update_rule(params = {}) ⇒ Struct

Updates a rule for the specified Connect Customer instance.

Use the Rules Function language to code conditions for the rule.

Examples:

Request syntax with placeholder values


resp = client.update_rule({
  rule_id: "RuleId", # required
  instance_id: "InstanceId", # required
  name: "RuleName", # required
  function: "RuleFunction", # required
  actions: [ # required
    {
      action_type: "CREATE_TASK", # required, accepts CREATE_TASK, ASSIGN_CONTACT_CATEGORY, GENERATE_EVENTBRIDGE_EVENT, SEND_NOTIFICATION, CREATE_CASE, UPDATE_CASE, ASSIGN_SLA, END_ASSOCIATED_TASKS, SUBMIT_AUTO_EVALUATION
      task_action: {
        name: "TaskNameExpression", # required
        description: "TaskDescriptionExpression",
        contact_flow_id: "ContactFlowId", # required
        references: {
          "ReferenceKey" => {
            value: "ReferenceValue",
            type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT, EMAIL_MESSAGE_PLAIN_TEXT_REDACTED, EMAIL_MESSAGE_REDACTED
            status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
            arn: "ReferenceArn",
            status_reason: "ReferenceStatusReason",
          },
        },
      },
      event_bridge_action: {
        name: "EventBridgeActionName", # required
      },
      assign_contact_category_action: {
      },
      send_notification_action: {
        delivery_method: "EMAIL", # required, accepts EMAIL
        subject: "Subject",
        content: "Content", # required
        content_type: "PLAIN_TEXT", # required, accepts PLAIN_TEXT
        recipient: { # required
          user_tags: {
            "String" => "String",
          },
          user_ids: ["UserId"],
        },
        exclusion: {
          user_tags: {
            "String" => "String",
          },
          user_ids: ["UserId"],
        },
      },
      create_case_action: {
        fields: [ # required
          {
            id: "FieldValueId", # required
            value: { # required
              boolean_value: false,
              double_value: 1.0,
              empty_value: {
              },
              string_value: "FieldStringValue",
            },
          },
        ],
        template_id: "TemplateId", # required
      },
      update_case_action: {
        fields: [ # required
          {
            id: "FieldValueId", # required
            value: { # required
              boolean_value: false,
              double_value: 1.0,
              empty_value: {
              },
              string_value: "FieldStringValue",
            },
          },
        ],
      },
      assign_sla_action: {
        sla_assignment_type: "CASES", # required, accepts CASES
        case_sla_configuration: {
          name: "SlaName", # required
          type: "CaseField", # required, accepts CaseField
          field_id: "FieldValueId",
          target_field_values: [
            {
              boolean_value: false,
              double_value: 1.0,
              empty_value: {
              },
              string_value: "FieldStringValue",
            },
          ],
          target_sla_minutes: 1, # required
        },
      },
      end_associated_tasks_action: {
      },
      submit_auto_evaluation_action: {
        evaluation_form_id: "EvaluationFormId", # required
      },
    },
  ],
  publish_status: "DRAFT", # required, accepts DRAFT, PUBLISHED
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_id (required, String) —

    A unique identifier for the rule.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (required, String) —

    The name of the rule. You can change the name only if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

  • :function (required, String) —

    The conditions of the rule.

  • :actions (required, Array<Types::RuleAction>) —

    A list of actions to be run when the rule is triggered.

  • :publish_status (required, String) —

    The publish status of the rule.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



29541
29542
29543
29544
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29541

def update_rule(params = {}, options = {})
  req = build_request(:update_rule, params)
  req.send_request(options)
end

#update_security_profile(params = {}) ⇒ Struct

Updates a security profile.

For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

Examples:

Request syntax with placeholder values


resp = client.update_security_profile({
  description: "SecurityProfileDescription",
  permissions: ["SecurityProfilePermission"],
  security_profile_id: "SecurityProfileId", # required
  instance_id: "InstanceId", # required
  allowed_access_control_tags: {
    "SecurityProfilePolicyKey" => "SecurityProfilePolicyValue",
  },
  tag_restricted_resources: ["TagRestrictedResourceName"],
  applications: [
    {
      namespace: "Namespace",
      application_permissions: ["Permission"],
      type: "MCP", # accepts MCP, THIRD_PARTY_APPLICATION
    },
  ],
  hierarchy_restricted_resources: ["HierarchyRestrictedResourceName"],
  allowed_access_control_hierarchy_group_id: "HierarchyGroupId",
  allowed_flow_modules: [
    {
      type: "MCP", # accepts MCP
      flow_module_id: "FlowModuleId",
    },
  ],
  granular_access_control_configuration: {
    data_table_access_control_configuration: {
      primary_attribute_access_control_configuration: {
        primary_attribute_values: [
          {
            access_type: "ALLOW", # accepts ALLOW
            attribute_name: "PrimaryAttributeContextKeyName",
            values: ["IAMRestrictedPrimaryValue"],
          },
        ],
      },
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    The description of the security profile.

  • :permissions (Array<String>) —

    The permissions granted to a security profile. For a list of valid permissions, see List of security profile permissions.

  • :security_profile_id (required, String) —

    The identifier for the security profle.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :allowed_access_control_tags (Hash<String,String>) —

    The list of tags that a security profile uses to restrict access to resources in Connect Customer.

  • :tag_restricted_resources (Array<String>) —

    The list of resources that a security profile applies tag restrictions to in Connect Customer.

  • :applications (Array<Types::Application>) —

    A list of the third-party application's metadata.

  • :hierarchy_restricted_resources (Array<String>) —

    The list of resources that a security profile applies hierarchy restrictions to in Connect Customer. Following are acceptable ResourceNames: User.

  • :allowed_access_control_hierarchy_group_id (String) —

    The identifier of the hierarchy group that a security profile uses to restrict access to resources in Connect Customer.

  • :allowed_flow_modules (Array<Types::FlowModule>) —

    A list of Flow Modules an AI Agent can invoke as a tool

  • :granular_access_control_configuration (Types::GranularAccessControlConfiguration) —

    The granular access control configuration for the security profile, including data table permissions.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



29654
29655
29656
29657
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29654

def update_security_profile(params = {}, options = {})
  req = build_request(:update_security_profile, params)
  req.send_request(options)
end

#update_task_template(params = {}) ⇒ Types::UpdateTaskTemplateResponse

Updates details about a specific task template in the specified Connect Customer instance. This operation does not support partial updates. Instead it does a full update of template content.

Examples:

Request syntax with placeholder values


resp = client.update_task_template({
  task_template_id: "TaskTemplateId", # required
  instance_id: "InstanceId", # required
  name: "TaskTemplateName",
  description: "TaskTemplateDescription",
  contact_flow_id: "ContactFlowId",
  self_assign_flow_id: "ContactFlowId",
  constraints: {
    required_fields: [
      {
        id: {
          name: "TaskTemplateFieldName",
        },
      },
    ],
    read_only_fields: [
      {
        id: {
          name: "TaskTemplateFieldName",
        },
      },
    ],
    invisible_fields: [
      {
        id: {
          name: "TaskTemplateFieldName",
        },
      },
    ],
  },
  defaults: {
    default_field_values: [
      {
        id: {
          name: "TaskTemplateFieldName",
        },
        default_value: "TaskTemplateFieldValue",
      },
    ],
  },
  status: "ACTIVE", # accepts ACTIVE, INACTIVE
  fields: [
    {
      id: { # required
        name: "TaskTemplateFieldName",
      },
      description: "TaskTemplateFieldDescription",
      type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL, SELF_ASSIGN, EXPIRY_DURATION
      single_select_options: ["TaskTemplateSingleSelectOption"],
    },
  ],
})

Response structure


resp.instance_id #=> String
resp.id #=> String
resp.arn #=> String
resp.name #=> String
resp.description #=> String
resp.contact_flow_id #=> String
resp.self_assign_flow_id #=> String
resp.constraints.required_fields #=> Array
resp.constraints.required_fields[0].id.name #=> String
resp.constraints.read_only_fields #=> Array
resp.constraints.read_only_fields[0].id.name #=> String
resp.constraints.invisible_fields #=> Array
resp.constraints.invisible_fields[0].id.name #=> String
resp.defaults.default_field_values #=> Array
resp.defaults.default_field_values[0].id.name #=> String
resp.defaults.default_field_values[0].default_value #=> String
resp.fields #=> Array
resp.fields[0].id.name #=> String
resp.fields[0].description #=> String
resp.fields[0].type #=> String, one of "NAME", "DESCRIPTION", "SCHEDULED_TIME", "QUICK_CONNECT", "URL", "NUMBER", "TEXT", "TEXT_AREA", "DATE_TIME", "BOOLEAN", "SINGLE_SELECT", "EMAIL", "SELF_ASSIGN", "EXPIRY_DURATION"
resp.fields[0].single_select_options #=> Array
resp.fields[0].single_select_options[0] #=> String
resp.status #=> String, one of "ACTIVE", "INACTIVE"
resp.last_modified_time #=> Time
resp.created_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_template_id (required, String) —

    A unique identifier for the task template.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :name (String) —

    The name of the task template.

  • :description (String) —

    The description of the task template.

  • :contact_flow_id (String) —

    The identifier of the flow that runs by default when a task is created by referencing this template.

    Although this parameter is marked as optional, the request must contain either a ContactFlowId or a field of type QUICK_CONNECT.

  • :self_assign_flow_id (String) —

    The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.

  • :constraints (Types::TaskTemplateConstraints) —

    Constraints that are applicable to the fields listed. Although this parameter is marked as optional in the API model, the service requires it when calling CreateTaskTemplate or UpdateTaskTemplate. The RequiredFields array must contain at least one element, and the field of type NAME must be included in RequiredFields.

  • :defaults (Types::TaskTemplateDefaults) —

    The default values for fields when a task is created by referencing this template.

  • :status (String) —

    Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

    Although this parameter is marked as optional, the service requires it when calling UpdateTaskTemplate.

  • :fields (Array<Types::TaskTemplateField>) —

    Fields that are part of the template.

    The request must contain exactly one field of type NAME. This field must also be listed in the RequiredFields array within the Constraints parameter.

Returns:

See Also:



29821
29822
29823
29824
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29821

def update_task_template(params = {}, options = {})
  req = build_request(:update_task_template, params)
  req.send_request(options)
end

#update_test_case(params = {}) ⇒ Struct

Updates any of the metadata for a test case, such as the name, description, and status or content of an existing test case. This API doesn't allow customers to update the tags of the test case resource for the specified Amazon Connect instance.

Examples:

Request syntax with placeholder values


resp = client.update_test_case({
  instance_id: "InstanceIdOrArn", # required
  test_case_id: "TestCaseId", # required
  content: "TestCaseContent",
  entry_point: {
    type: "VOICE_CALL", # accepts VOICE_CALL, CHAT
    voice_call_entry_point_parameters: {
      source_phone_number: "PhoneNumber",
      destination_phone_number: "PhoneNumber",
      flow_id: "ContactFlowId",
    },
    chat_entry_point_parameters: {
      flow_id: "ContactFlowId",
    },
  },
  initialization_data: "TestCaseInitializationData",
  name: "TestCaseName",
  description: "TestCaseDescription",
  status: "PUBLISHED", # accepts PUBLISHED, SAVED
  last_modified_time: Time.now,
  last_modified_region: "RegionName",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance.

  • :test_case_id (required, String) —

    The identifier of the test case to update.

  • :content (String) —

    The JSON string that represents the content of the test.

  • :entry_point (Types::TestCaseEntryPoint) —

    Defines the starting point for your test.

  • :initialization_data (String) —

    Defines the test attributes for precise data representation.

  • :name (String) —

    The name of the test case.

  • :description (String) —

    The description of the test case.

  • :status (String) —

    Indicates the test status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. The SAVED status does not initiate validation of the content.

  • :last_modified_time (Time, DateTime, Date, Integer, String) —

    The time at which the resource was last modified.

  • :last_modified_region (String) —

    The region in which the resource was last modified

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



29894
29895
29896
29897
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29894

def update_test_case(params = {}, options = {})
  req = build_request(:update_test_case, params)
  req.send_request(options)
end

#update_traffic_distribution(params = {}) ⇒ Struct

Updates the traffic distribution for a given traffic distribution group.

When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure they can handle the calls in the other Region. If you don't shift the agents, voice calls will go to the shifted Region but there won't be any agents available to receive the calls.

The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Connect Customer Administrator Guide.

Important things to know

  • Invoke the UpdateTrafficDistribution API in the region that should handle traffic.

^

Examples:

Request syntax with placeholder values


resp = client.update_traffic_distribution({
  id: "TrafficDistributionGroupIdOrArn", # required
  telephony_config: {
    distributions: [ # required
      {
        region: "AwsRegion", # required
        percentage: 1, # required
      },
    ],
  },
  sign_in_config: {
    distributions: [ # required
      {
        region: "AwsRegion", # required
        enabled: false, # required
      },
    ],
  },
  agent_config: {
    distributions: [ # required
      {
        region: "AwsRegion", # required
        percentage: 1, # required
      },
    ],
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

  • :telephony_config (Types::TelephonyConfig) —

    The distribution of traffic between the instance and its replica(s).

  • :sign_in_config (Types::SignInConfig) —

    The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).

  • :agent_config (Types::AgentConfig) —

    The distribution of agents between the instance and its replica(s).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



29985
29986
29987
29988
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29985

def update_traffic_distribution(params = {}, options = {})
  req = build_request(:update_traffic_distribution, params)
  req.send_request(options)
end

#update_user_config(params = {}) ⇒ Struct

Updates the configuration settings for the specified user, including per-channel auto-accept and after contact work (ACW) timeout settings.

This operation replaces the UpdateUserPhoneConfig API. While UpdateUserPhoneConfig applies the same ACW timeout to all channels, UpdateUserConfig allows you to set different auto-accept and ACW timeout values for each channel type.

Examples:

Request syntax with placeholder values


resp = client.update_user_config({
  auto_accept_configs: [
    {
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      auto_accept: false, # required
      agent_first_callback_auto_accept: false,
    },
  ],
  after_contact_work_configs: [
    {
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      after_contact_work_config: { # required
        after_contact_work_time_limit: 1,
      },
      agent_first_callback_after_contact_work_config: {
        after_contact_work_time_limit: 1,
      },
    },
  ],
  phone_number_configs: [
    {
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
      phone_number: "SensitivePhoneNumber",
    },
  ],
  persistent_connection_configs: [
    {
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      persistent_connection: false, # required
    },
  ],
  voice_enhancement_configs: [
    {
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
      voice_enhancement_mode: "VOICE_ISOLATION", # required, accepts VOICE_ISOLATION, NOISE_SUPPRESSION, NONE
    },
  ],
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_accept_configs (Array<Types::AutoAcceptConfig>) —

    The list of auto-accept configuration settings for each channel. When auto-accept is enabled for a channel, available agents are automatically connected to contacts from that channel without needing to manually accept. Auto-accept connects agents to contacts in less than one second.

  • :after_contact_work_configs (Array<Types::AfterContactWorkConfigPerChannel>) —

    The list of after contact work (ACW) timeout configuration settings for each channel. ACW timeout specifies how many seconds agents have for after contact work, such as entering notes about the contact. The minimum setting is 1 second, and the maximum is 2,000,000 seconds (24 days). Enter 0 for an indefinite amount of time, meaning agents must manually choose to end ACW.

  • :phone_number_configs (Array<Types::PhoneNumberConfig>) —

    The list of phone number configuration settings for each channel.

  • :persistent_connection_configs (Array<Types::PersistentConnectionConfig>) —

    The list of persistent connection configuration settings for each channel.

  • :voice_enhancement_configs (Array<Types::VoiceEnhancementConfig>) —

    The list of voice enhancement configuration settings for each channel.

  • :user_id (required, String) —

    The identifier of the user account.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



30086
30087
30088
30089
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30086

def update_user_config(params = {}, options = {})
  req = build_request(:update_user_config, params)
  req.send_request(options)
end

#update_user_hierarchy(params = {}) ⇒ Struct

Assigns the specified hierarchy group to the specified user.

Examples:

Request syntax with placeholder values


resp = client.update_user_hierarchy({
  hierarchy_group_id: "HierarchyGroupId",
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :hierarchy_group_id (String) —

    The identifier of the hierarchy group.

  • :user_id (required, String) —

    The identifier of the user account.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



30121
30122
30123
30124
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30121

def update_user_hierarchy(params = {}, options = {})
  req = build_request(:update_user_hierarchy, params)
  req.send_request(options)
end

#update_user_hierarchy_group_name(params = {}) ⇒ Struct

Updates the name of the user hierarchy group.

Examples:

Request syntax with placeholder values


resp = client.update_user_hierarchy_group_name({
  name: "HierarchyGroupName", # required
  hierarchy_group_id: "HierarchyGroupId", # required
  instance_id: "InstanceId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the hierarchy group. Must not be more than 100 characters.

  • :hierarchy_group_id (required, String) —

    The identifier of the hierarchy group.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



30156
30157
30158
30159
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30156

def update_user_hierarchy_group_name(params = {}, options = {})
  req = build_request(:update_user_hierarchy_group_name, params)
  req.send_request(options)
end

#update_user_hierarchy_structure(params = {}) ⇒ Struct

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

Examples:

Request syntax with placeholder values


resp = client.update_user_hierarchy_structure({
  hierarchy_structure: { # required
    level_one: {
      name: "HierarchyLevelName", # required
    },
    level_two: {
      name: "HierarchyLevelName", # required
    },
    level_three: {
      name: "HierarchyLevelName", # required
    },
    level_four: {
      name: "HierarchyLevelName", # required
    },
    level_five: {
      name: "HierarchyLevelName", # required
    },
  },
  instance_id: "InstanceId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :hierarchy_structure (required, Types::HierarchyStructureUpdate) —

    The hierarchy levels to update.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



30204
30205
30206
30207
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30204

def update_user_hierarchy_structure(params = {}, options = {})
  req = build_request(:update_user_hierarchy_structure, params)
  req.send_request(options)
end

#update_user_identity_info(params = {}) ⇒ Struct

Updates the identity information for the specified user.

We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Connect Customer Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.update_user_identity_info({
  identity_info: { # required
    first_name: "AgentFirstName",
    last_name: "AgentLastName",
    email: "Email",
    secondary_email: "Email",
    mobile: "PhoneNumber",
  },
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identity_info (required, Types::UserIdentityInfo) —

    The identity information for the user.

  • :user_id (required, String) —

    The identifier of the user account.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



30257
30258
30259
30260
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30257

def update_user_identity_info(params = {}, options = {})
  req = build_request(:update_user_identity_info, params)
  req.send_request(options)
end

#update_user_notification_status(params = {}) ⇒ Struct

Updates the status of a notification for a specific user, such as marking it as read or hidden. Users can only update notification status for notifications that have been sent to them. READ status deprioritizes the notification and greys it out, while HIDDEN status removes it from the notification widget.

Examples:

Request syntax with placeholder values


resp = client.update_user_notification_status({
  instance_id: "InstanceId", # required
  notification_id: "NotificationId", # required
  user_id: "UserId", # required
  status: "READ", # required, accepts READ, UNREAD, HIDDEN
  last_modified_time: Time.now,
  last_modified_region: "RegionName",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :notification_id (required, String) —

    The unique identifier for the notification.

  • :user_id (required, String) —

    The identifier of the user whose notification status is being updated.

  • :status (required, String) —

    The new status for the notification. Valid values are READ, UNREAD, and HIDDEN.

  • :last_modified_time (Time, DateTime, Date, Integer, String) —

    The timestamp when the notification status was last modified. Used for cross-region replication and optimistic locking.

  • :last_modified_region (String) —

    The AWS Region where the notification status was last modified. Used for cross-region replication.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



30311
30312
30313
30314
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30311

def update_user_notification_status(params = {}, options = {})
  req = build_request(:update_user_notification_status, params)
  req.send_request(options)
end

#update_user_phone_config(params = {}) ⇒ Struct

Updates the phone configuration settings for the specified user.

We recommend using the UpdateUserConfig API, which supports additional functionality that is not available in the UpdateUserPhoneConfig API, such as voice enhancement settings and per-channel configuration for auto-accept and After Contact Work (ACW) timeouts. In comparison, the UpdateUserPhoneConfig API will always set the same ACW timeouts to all channels the user handles.

Examples:

Request syntax with placeholder values


resp = client.update_user_phone_config({
  phone_config: { # required
    phone_type: "SOFT_PHONE", # accepts SOFT_PHONE, DESK_PHONE
    auto_accept: false,
    after_contact_work_time_limit: 1,
    desk_phone_number: "SensitivePhoneNumber",
    persistent_connection: false,
  },
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :phone_config (required, Types::UserPhoneConfig) —

    Information about phone configuration settings for the user.

  • :user_id (required, String) —

    The identifier of the user account.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



30365
30366
30367
30368
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30365

def update_user_phone_config(params = {}, options = {})
  req = build_request(:update_user_phone_config, params)
  req.send_request(options)
end

#update_user_proficiencies(params = {}) ⇒ Struct

Updates the properties associated with the proficiencies of a user.

Examples:

Request syntax with placeholder values


resp = client.update_user_proficiencies({
  instance_id: "InstanceId", # required
  user_id: "UserId", # required
  user_proficiencies: [ # required
    {
      attribute_name: "PredefinedAttributeName", # required
      attribute_value: "PredefinedAttributeStringValue", # required
      level: 1.0, # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :user_id (required, String) —

    The identifier of the user account.

  • :user_proficiencies (required, Array<Types::UserProficiency>) —

    The proficiencies to be updated for the user. Proficiencies must first be associated to the user. You can do this using AssociateUserProficiencies API.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



30404
30405
30406
30407
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30404

def update_user_proficiencies(params = {}, options = {})
  req = build_request(:update_user_proficiencies, params)
  req.send_request(options)
end

#update_user_routing_profile(params = {}) ⇒ Struct

Assigns the specified routing profile to the specified user.

Examples:

Request syntax with placeholder values


resp = client.update_user_routing_profile({
  routing_profile_id: "RoutingProfileId", # required
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :routing_profile_id (required, String) —

    The identifier of the routing profile for the user.

  • :user_id (required, String) —

    The identifier of the user account.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



30439
30440
30441
30442
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30439

def update_user_routing_profile(params = {}, options = {})
  req = build_request(:update_user_routing_profile, params)
  req.send_request(options)
end

#update_user_security_profiles(params = {}) ⇒ Struct

Assigns the specified security profiles to the specified user.

Examples:

Request syntax with placeholder values


resp = client.update_user_security_profiles({
  security_profile_ids: ["SecurityProfileId"], # required
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :security_profile_ids (required, Array<String>) —

    The identifiers of the security profiles for the user.

  • :user_id (required, String) —

    The identifier of the user account.

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



30474
30475
30476
30477
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30474

def update_user_security_profiles(params = {}, options = {})
  req = build_request(:update_user_security_profiles, params)
  req.send_request(options)
end

#update_view_content(params = {}) ⇒ Types::UpdateViewContentResponse

Updates the view content of the given view identifier in the specified Connect Customer instance.

It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED. Note that the $SAVED alias' content will always be updated, but the $LATEST alias' content will only be updated if Status is PUBLISHED.

Examples:

Request syntax with placeholder values


resp = client.update_view_content({
  instance_id: "ViewsInstanceId", # required
  view_id: "ViewId", # required
  status: "PUBLISHED", # required, accepts PUBLISHED, SAVED
  content: { # required
    template: "ViewTemplate",
    actions: ["ViewAction"],
  },
})

Response structure


resp.view.id #=> String
resp.view.arn #=> String
resp.view.name #=> String
resp.view.status #=> String, one of "PUBLISHED", "SAVED"
resp.view.type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
resp.view.description #=> String
resp.view.version #=> Integer
resp.view.version_description #=> String
resp.view.content.input_schema #=> String
resp.view.content.template #=> String
resp.view.content.actions #=> Array
resp.view.content.actions[0] #=> String
resp.view.tags #=> Hash
resp.view.tags["TagKey"] #=> String
resp.view.created_time #=> Time
resp.view.last_modified_time #=> Time
resp.view.view_content_sha_256 #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

  • :view_id (required, String) —

    The identifier of the view. Both ViewArn and ViewId can be used.

  • :status (required, String) —

    Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

  • :content (required, Types::ViewInputContent) —

    View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.

    The total uncompressed content has a maximum file size of 400kB.

Returns:

See Also:



30545
30546
30547
30548
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30545

def update_view_content(params = {}, options = {})
  req = build_request(:update_view_content, params)
  req.send_request(options)
end

#update_view_metadata(params = {}) ⇒ Struct

Updates the view metadata. Note that either Name or Description must be provided.

Examples:

Request syntax with placeholder values


resp = client.update_view_metadata({
  instance_id: "ViewsInstanceId", # required
  view_id: "ViewId", # required
  name: "ViewName",
  description: "ViewDescription",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

  • :view_id (required, String) —

    The identifier of the view. Both ViewArn and ViewId can be used.

  • :name (String) —

    The name of the view.

  • :description (String) —

    The description of the view.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



30581
30582
30583
30584
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30581

def update_view_metadata(params = {}, options = {})
  req = build_request(:update_view_metadata, params)
  req.send_request(options)
end

#update_workspace_metadata(params = {}) ⇒ Struct

Updates the metadata of a workspace, such as its name and description.

Examples:

Request syntax with placeholder values


resp = client.update_workspace_metadata({
  instance_id: "InstanceId", # required
  workspace_id: "WorkspaceId", # required
  name: "WorkspaceName",
  description: "WorkspaceDescription",
  title: "WorkspaceTitle",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :workspace_id (required, String) —

    The identifier of the workspace.

  • :name (String) —

    The name of the workspace.

  • :description (String) —

    The description of the workspace.

  • :title (String) —

    The title displayed for the workspace.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



30624
30625
30626
30627
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30624

def update_workspace_metadata(params = {}, options = {})
  req = build_request(:update_workspace_metadata, params)
  req.send_request(options)
end

#update_workspace_page(params = {}) ⇒ Struct

Updates the configuration of a page in a workspace, including the associated view and input data.

Examples:

Request syntax with placeholder values


resp = client.update_workspace_page({
  instance_id: "InstanceId", # required
  workspace_id: "WorkspaceId", # required
  page: "Page", # required
  new_page: "Page",
  resource_arn: "ARN",
  slug: "Slug",
  input_data: "InputData",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :workspace_id (required, String) —

    The identifier of the workspace.

  • :page (required, String) —

    The current page identifier.

  • :new_page (String) —

    The new page identifier, if changing the page name.

  • :resource_arn (String) —

    The Amazon Resource Name (ARN) of the view to associate with the page.

  • :slug (String) —

    The URL-friendly identifier for the page.

  • :input_data (String) —

    A JSON string containing input parameters for the view.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



30676
30677
30678
30679
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30676

def update_workspace_page(params = {}, options = {})
  req = build_request(:update_workspace_page, params)
  req.send_request(options)
end

#update_workspace_theme(params = {}) ⇒ Struct

Updates the theme configuration for a workspace, including colors and styling.

Examples:

Request syntax with placeholder values


resp = client.update_workspace_theme({
  instance_id: "InstanceId", # required
  workspace_id: "WorkspaceId", # required
  theme: {
    light: {
      palette: {
        header: {
          background: "ThemeString",
          text: "ThemeString",
          text_hover: "ThemeString",
          invert_actions_colors: false,
        },
        navigation: {
          background: "ThemeString",
          text_background_hover: "ThemeString",
          text_background_active: "ThemeString",
          text: "ThemeString",
          text_hover: "ThemeString",
          text_active: "ThemeString",
          invert_actions_colors: false,
        },
        canvas: {
          container_background: "ThemeString",
          page_background: "ThemeString",
          active_background: "ThemeString",
        },
        primary: {
          default: "ThemeString",
          active: "ThemeString",
          contrast_text: "ThemeString",
        },
      },
      images: {
        logo: {
          default: "ThemeImageLink",
          favicon: "ThemeImageLink",
        },
      },
      typography: {
        font_family: {
          default: "Arial", # accepts Arial, Courier New, Georgia, Times New Roman, Trebuchet, Verdana
        },
      },
    },
    dark: {
      palette: {
        header: {
          background: "ThemeString",
          text: "ThemeString",
          text_hover: "ThemeString",
          invert_actions_colors: false,
        },
        navigation: {
          background: "ThemeString",
          text_background_hover: "ThemeString",
          text_background_active: "ThemeString",
          text: "ThemeString",
          text_hover: "ThemeString",
          text_active: "ThemeString",
          invert_actions_colors: false,
        },
        canvas: {
          container_background: "ThemeString",
          page_background: "ThemeString",
          active_background: "ThemeString",
        },
        primary: {
          default: "ThemeString",
          active: "ThemeString",
          contrast_text: "ThemeString",
        },
      },
      images: {
        logo: {
          default: "ThemeImageLink",
          favicon: "ThemeImageLink",
        },
      },
      typography: {
        font_family: {
          default: "Arial", # accepts Arial, Courier New, Georgia, Times New Roman, Trebuchet, Verdana
        },
      },
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :workspace_id (required, String) —

    The identifier of the workspace.

  • :theme (Types::WorkspaceTheme) —

    The theme configuration, including color schemes and visual styles.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



30793
30794
30795
30796
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30793

def update_workspace_theme(params = {}, options = {})
  req = build_request(:update_workspace_theme, params)
  req.send_request(options)
end

#update_workspace_visibility(params = {}) ⇒ Struct

Updates the visibility setting of a workspace, controlling whether it is available to all users, assigned users only, or none.

Examples:

Request syntax with placeholder values


resp = client.update_workspace_visibility({
  instance_id: "InstanceId", # required
  workspace_id: "WorkspaceId", # required
  visibility: "ALL", # required, accepts ALL, ASSIGNED, NONE
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • :workspace_id (required, String) —

    The identifier of the workspace.

  • :visibility (required, String) —

    The visibility setting for the workspace. Valid values are: ALL (available to all users), ASSIGNED (available only to assigned users and routing profiles), and NONE (not visible to any users).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



30831
30832
30833
30834
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30831

def update_workspace_visibility(params = {}, options = {})
  req = build_request(:update_workspace_visibility, params)
  req.send_request(options)
end