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 default value if no retry mode is provided.

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

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

  • :sdk_ua_app_id (String) —

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

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

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

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

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling 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.



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

def initialize(*args)
  super
end

Instance Method Details

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

Activates an evaluation form in the specified Amazon Connect 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 Amazon Connect 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:



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

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 Amazon Connect 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 Amazon Connect 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 Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

Returns:

See Also:



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

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 Amazon Connect and is subject to change.

Associates an approved origin to an Amazon Connect 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 Amazon Connect 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:



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

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 Amazon Connect and is subject to change.

Allows the specified Amazon Connect 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 Amazon Connect 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:



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

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, and task contacts. It does not support voice contacts.

  • 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 Amazon Connect quotas in the Amazon Connect Administrator Guide.

Endpoints: See Amazon Connect 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 Amazon Connect 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 Amazon Connect.

  • :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:



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

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 Amazon Connect 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 Amazon Connect 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:



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

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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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:



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

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 Amazon Connect 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:



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

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

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

This API is in preview release for Amazon Connect 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 Amazon Connect 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:



1083
1084
1085
1086
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1083

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 Amazon Connect and is subject to change.

Allows the specified Amazon Connect 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 Amazon Connect 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:



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

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 Amazon Connect and is subject to change.

Allows the specified Amazon Connect 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 Amazon Connect 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:



1186
1187
1188
1189
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1186

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 Amazon Connect 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 Amazon Connect 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:



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

def associate_phone_number_contact_flow(params = {}, options = {})
  req = build_request(:associate_phone_number_contact_flow, 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 Amazon Connect 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:



1268
1269
1270
1271
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1268

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 Amazon Connect 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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1323
1324
1325
1326
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1323

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 Amazon Connect 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 Amazon Connect 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:



1377
1378
1379
1380
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1377

def associate_security_key(params = {}, options = {})
  req = build_request(:associate_security_key, 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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1416
1417
1418
1419
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1416

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 Amazon Connect 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:



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

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

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

Associates a list of analytics datasets for a given Amazon Connect 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 Amazon Connect 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 Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

Returns:

See Also:



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

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

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

Removes a list of analytics datasets associated with a given Amazon Connect 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 Amazon Connect 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 Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

Returns:

See Also:



1559
1560
1561
1562
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1559

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 "EMAIL_MESSAGE", "ATTACHMENT"
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 and Email.

    This value must be a valid ARN.

Returns:

See Also:



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

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 Amazon Connect 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:



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

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 Amazon Connect 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 Amazon Connect. 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 Amazon Connect 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:



1779
1780
1781
1782
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1779

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

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

Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect 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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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:



1894
1895
1896
1897
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1894

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 Amazon 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 and Email.

    This value must be a valid ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1935
1936
1937
1938
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1935

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 Amazon Connect 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 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 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:



1994
1995
1996
1997
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1994

def create_agent_status(params = {}, options = {})
  req = build_request(:create_agent_status, 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
      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 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.**

  • :related_contact_id (String) —

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

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

    A custom key-value pair using an attribute map. The attributes are standard Amazon Connect 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 Amazon Connect 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 Amazon Connect Contact Lens with external voice systems in the Amazon Connect Administrator Guide.

Returns:

See Also:



2187
2188
2189
2190
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2187

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 Amazon Connect instance.

You can also create and update flows using the Amazon Connect 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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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:



2269
2270
2271
2272
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2269

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 Amazon Connect 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 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 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 Amazon Connect 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:



2353
2354
2355
2356
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2353

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 Amazon Connect 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:



2405
2406
2407
2408
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2405

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 Amazon Connect 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:



2454
2455
2456
2457
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2454

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 Amazon Connect 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:



2512
2513
2514
2515
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2512

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

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

Create new email address in the specified Amazon Connect instance. For more information about email addresses, see Create email addresses in the Amazon Connect 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 Amazon Connect 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:



2584
2585
2586
2587
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2584

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 Amazon Connect 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,
      },
      question: {
        title: "EvaluationFormQuestionTitle", # required
        instructions: "EvaluationFormQuestionInstructions",
        ref_id: "ReferenceId", # required
        not_applicable_enabled: false,
        question_type: "TEXT", # required, accepts TEXT, SINGLESELECT, NUMERIC
        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",
                },
              },
            ],
            automation: {
              property_value: {
                label: "OVERALL_CUSTOMER_SENTIMENT_SCORE", # required, accepts OVERALL_CUSTOMER_SENTIMENT_SCORE, OVERALL_AGENT_SENTIMENT_SCORE, 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",
                },
              },
            ],
            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
              },
            },
          },
        },
        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
                },
                condition: {
                  # recursive EvaluationFormItemEnablementCondition
                },
              },
            ],
            operator: "OR", # accepts OR, AND
          },
          action: "DISABLE", # required, accepts DISABLE, ENABLE
          default_action: "DISABLE", # accepts DISABLE, ENABLE
        },
        weight: 1.0,
      },
    },
  ],
  scoring_strategy: {
    mode: "QUESTION_ONLY", # required, accepts QUESTION_ONLY, SECTION_ONLY
    status: "ENABLED", # required, accepts ENABLED, DISABLED
  },
  auto_evaluation_configuration: {
    enabled: false, # required
  },
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

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 Amazon Connect 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.**

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

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

Returns:

See Also:



2779
2780
2781
2782
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2779

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
      },
    },
  ],
  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 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 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.

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

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

Returns:

See Also:



2851
2852
2853
2854
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2851

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 Amazon Connect 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
})

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 Amazon Connect 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.

Returns:

See Also:



2917
2918
2919
2920
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2917

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 Amazon Connect and is subject to change.

Initiates an Amazon Connect 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 Amazon Connect.

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

Amazon Connect 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 Amazon Connect 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:



2997
2998
2999
3000
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2997

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 Amazon Connect 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
  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 Amazon Connect 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 Amazon Connect 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:



3070
3071
3072
3073
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3070

def create_integration_association(params = {}, options = {})
  req = build_request(:create_integration_association, 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 Amazon Connect 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 Amazon Connect. 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:



3150
3151
3152
3153
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3150

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 Amazon Connect 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 Amazon Connect 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, Amazon Connect 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:



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

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 Amazon Connect instance. A predefined attribute is made up of a name and a value.

For the predefined attributes per instance quota, see Amazon Connect 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 Amazon Connect 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 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 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 Amazon Connect 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 Amazon Connect admin website.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3347
3348
3349
3350
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3347

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 Amazon Connect 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 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 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:



3414
3415
3416
3417
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3414

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 Amazon Connect for mobile chat in the Amazon Connect 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:



3488
3489
3490
3491
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3488

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 Amazon Connect instance.

  • If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect 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"],
  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 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 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.

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

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

Returns:

See Also:



3593
3594
3595
3596
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3593

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 Amazon Connect 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
    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
    },
  },
  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 Amazon Connect 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:



3661
3662
3663
3664
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3661

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 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 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 Amazon Connect 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 Amazon Connect service quotas.

  • :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:



3778
3779
3780
3781
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3778

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 Amazon Connect 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, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit, OnMetricDataUpdate, OnCaseCreate, OnCaseUpdate, OnSlaBreach
    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
            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 Amazon Connect 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:



3949
3950
3951
3952
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3949

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 Amazon Connect 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"],
    },
  ],
  hierarchy_restricted_resources: ["HierarchyRestrictedResourceName"],
  allowed_access_control_hierarchy_group_id: "HierarchyGroupId",
})

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 Amazon Connect 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 Amazon Connect.

  • :tag_restricted_resources (Array<String>) —

    The list of resources that a security profile applies tag restrictions to in Amazon Connect. For a list of Amazon Connect resources that you can tag, see Add tags to resources in Amazon Connect in the Amazon Connect Administrator Guide.

  • :applications (Array<Types::Application>) —

    A list of third-party applications 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 Amazon Connect. 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 Amazon Connect.

Returns:

See Also:



4058
4059
4060
4061
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4058

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 Amazon Connect 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 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 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.

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

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

  • :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:



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

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

#create_traffic_distribution_group(params = {}) ⇒ Types::CreateTrafficDistributionGroupResponse

Creates a traffic distribution group given an Amazon Connect 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 Amazon Connect 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 Amazon Connect 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:



4265
4266
4267
4268
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4265

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 Amazon Connect 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:



4317
4318
4319
4320
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4317

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 Amazon Connect instance.

Certain UserIdentityInfo parameters are required in some situations. For example, Email, FirstName and LastName are required if you are using Amazon Connect or SAML for identity management.

For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect 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: { # required
    phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
    auto_accept: false,
    after_contact_work_time_limit: 1,
    desk_phone_number: "PhoneNumber",
    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
  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 Amazon Connect 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 (required, Types::UserPhoneConfig) —

    The phone settings for the user.

  • :directory_user_id (String) —

    The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect 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 Amazon Connect when Amazon Connect 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 Amazon Connect 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:



4441
4442
4443
4444
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4441

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 Amazon Connect 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:



4494
4495
4496
4497
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4494

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 Amazon Connect 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:



4585
4586
4587
4588
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4585

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 Amazon Connect 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:



4649
4650
4651
4652
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4649

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 Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect 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 Amazon Connect 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:



4740
4741
4742
4743
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4740

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

#deactivate_evaluation_form(params = {}) ⇒ Types::DeactivateEvaluationFormResponse

Deactivates an evaluation form in the specified Amazon Connect 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 Amazon Connect 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:



4788
4789
4790
4791
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4788

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. Cases are the only current supported resource.

    This value must be a valid ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4830
4831
4832
4833
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4830

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

#delete_contact_evaluation(params = {}) ⇒ Struct

Deletes a contact evaluation in the specified Amazon Connect 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 Amazon Connect 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:



4861
4862
4863
4864
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4861

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 Amazon Connect 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 Amazon Connect 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:



4892
4893
4894
4895
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4892

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 Amazon Connect 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:



4923
4924
4925
4926
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4923

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 Amazon Connect 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:



4959
4960
4961
4962
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4959

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 Amazon Connect 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:



4994
4995
4996
4997
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4994

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 Amazon Connect 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:



5029
5030
5031
5032
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5029

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

#delete_email_address(params = {}) ⇒ Struct

Deletes email address from the specified Amazon Connect 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 Amazon Connect 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:



5060
5061
5062
5063
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5060

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 Amazon Connect 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 Amazon Connect 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:



5101
5102
5103
5104
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5101

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 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 for the hours of operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5132
5133
5134
5135
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5132

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 Amazon Connect 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 Amazon Connect 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:



5163
5164
5165
5166
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5163

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 Amazon Connect and is subject to change.

Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide.

Amazon Connect 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 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.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5220
5221
5222
5223
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5220

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 Amazon Connect 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 Amazon Connect 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:



5253
5254
5255
5256
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5253

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

#delete_predefined_attribute(params = {}) ⇒ Struct

Deletes a predefined attribute from the specified Amazon Connect 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 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 predefined attribute.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5281
5282
5283
5284
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5281

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 Amazon Connect 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:



5312
5313
5314
5315
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5312

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 Amazon Connect instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5347
5348
5349
5350
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5347

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 Amazon Connect 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:



5378
5379
5380
5381
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5378

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 Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect 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 Amazon Connect 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:



5427
5428
5429
5430
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5427

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 Amazon Connect 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:



5458
5459
5460
5461
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5458

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 Amazon Connect 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 Amazon Connect 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:



5489
5490
5491
5492
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5489

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 Amazon Connect 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:



5520
5521
5522
5523
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5520

def delete_security_profile(params = {}, options = {})
  req = build_request(:delete_security_profile, 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 Amazon Connect 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:



5551
5552
5553
5554
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5551

def delete_task_template(params = {}, options = {})
  req = build_request(:delete_task_template, 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 Amazon Connect 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:



5583
5584
5585
5586
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5583

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 Amazon Connect 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:



5618
5619
5620
5621
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5618

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 Amazon Connect instance.

For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect 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 Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect 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 Amazon Connect 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:



5671
5672
5673
5674
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5671

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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5703
5704
5705
5706
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5703

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 Amazon Connect 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:



5731
5732
5733
5734
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5731

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 Amazon Connect 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:



5762
5763
5764
5765
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5762

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 Amazon Connect 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:



5803
5804
5805
5806
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5803

def delete_vocabulary(params = {}, options = {})
  req = build_request(:delete_vocabulary, 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 Amazon Connect 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:



5850
5851
5852
5853
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5850

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

#describe_authentication_profile(params = {}) ⇒ Types::DescribeAuthenticationProfileResponse

This API is in preview release for Amazon Connect 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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



5906
5907
5908
5909
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5906

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 Amazon Connect 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 Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.

Endpoints: See Amazon Connect 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.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.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.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>

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.

  • :contact_id (required, String) —

    The identifier of the contact.

Returns:

See Also:



6149
6150
6151
6152
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6149

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 Amazon Connect 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.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.answers #=> Hash
resp.evaluation.answers["ResourceId"].value.string_value #=> String
resp.evaluation.answers["ResourceId"].value.numeric_value #=> Float
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.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.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"
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.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].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"
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.automation.property_value.label #=> String, one of "OVERALL_CUSTOMER_SENTIMENT_SCORE", "OVERALL_AGENT_SENTIMENT_SCORE", "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.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.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"
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.scoring_strategy.mode #=> String, one of "QUESTION_ONLY", "SECTION_ONLY"
resp.evaluation_form.scoring_strategy.status #=> String, one of "ENABLED", "DISABLED"
resp.evaluation_form.auto_evaluation_configuration.enabled #=> Boolean

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.

  • :evaluation_id (required, String) —

    A unique identifier for the contact evaluation.

Returns:

See Also:



6292
6293
6294
6295
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6292

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 Amazon Connect 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 Amazon Connect instance.

  • :contact_flow_id (required, String) —

    The identifier of the flow.

Returns:

See Also:



6358
6359
6360
6361
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6358

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 Amazon Connect 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:



6413
6414
6415
6416
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6413

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 Amazon Connect 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:



6462
6463
6464
6465
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6462

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

#describe_email_address(params = {}) ⇒ Types::DescribeEmailAddressResponse

Describe email address form the specified Amazon Connect 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 Amazon Connect 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:



6517
6518
6519
6520
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6517

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 Amazon Connect 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].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"
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.automation.property_value.label #=> String, one of "OVERALL_CUSTOMER_SENTIMENT_SCORE", "OVERALL_AGENT_SENTIMENT_SCORE", "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.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.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"
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.scoring_strategy.mode #=> String, one of "QUESTION_ONLY", "SECTION_ONLY"
resp.evaluation_form.scoring_strategy.status #=> String, one of "ENABLED", "DISABLED"
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.tags #=> Hash
resp.evaluation_form.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.

  • :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:



6622
6623
6624
6625
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6622

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.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 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 for the hours of operation.

Returns:

See Also:



6673
6674
6675
6676
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6673

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

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect 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:



6721
6722
6723
6724
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6721

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 Amazon Connect 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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



6783
6784
6785
6786
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6783

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 Amazon Connect 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
})

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"
resp.attribute.value #=> 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.

  • :attribute_type (required, String) —

    The type of attribute.

Returns:

See Also:



6824
6825
6826
6827
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6824

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 Amazon Connect 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 Amazon Connect 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:



6881
6882
6883
6884
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6881

def describe_instance_storage_config(params = {}, options = {})
  req = build_request(:describe_instance_storage_config, 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 Amazon Connect 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:



6932
6933
6934
6935
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6932

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 Amazon Connect 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 Amazon Connect quotas.

Endpoints: See Amazon Connect 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 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 predefined attribute.

Returns:

See Also:



6996
6997
6998
6999
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6996

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 Amazon Connect 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:



7040
7041
7042
7043
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7040

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 Amazon Connect 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:



7091
7092
7093
7094
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7091

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"
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.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 Amazon Connect 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:



7141
7142
7143
7144
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7141

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 Amazon Connect 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:



7211
7212
7213
7214
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7211

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 Amazon Connect 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", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate", "OnContactEvaluationSubmit", "OnMetricDataUpdate", "OnCaseCreate", "OnCaseUpdate", "OnSlaBreach"
resp.rule.trigger_event_source.integration_association_id #=> String
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"
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 Amazon Connect 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:



7304
7305
7306
7307
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7304

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 Amazon Connect 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

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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



7366
7367
7368
7369
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7366

def describe_security_profile(params = {}, options = {})
  req = build_request(:describe_security_profile, 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:



7405
7406
7407
7408
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7405

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 Amazon Connect 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.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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



7470
7471
7472
7473
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7470

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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



7539
7540
7541
7542
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7539

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 Amazon Connect 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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



7597
7598
7599
7600
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7597

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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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:



7659
7660
7661
7662
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7659

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 Amazon Connect 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:



7705
7706
7707
7708
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7705

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

#disassociate_analytics_data_set(params = {}) ⇒ Struct

Removes the dataset ID associated with a given Amazon Connect 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 Amazon Connect 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 Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7744
7745
7746
7747
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7744

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 Amazon Connect and is subject to change.

Revokes access to integrated applications from Amazon Connect.

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 Amazon Connect 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:



7792
7793
7794
7795
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7792

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 Amazon Connect 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 Amazon Connect 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:



7850
7851
7852
7853
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7850

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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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:



7978
7979
7980
7981
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7978

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 Amazon Connect 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:



8019
8020
8021
8022
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8019

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

#disassociate_instance_storage_config(params = {}) ⇒ Struct

This API is in preview release for Amazon Connect 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 Amazon Connect 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:



8073
8074
8075
8076
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8073

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 Amazon Connect 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 Amazon Connect 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:



8123
8124
8125
8126
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8123

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 Amazon Connect 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 Amazon Connect 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:



8177
8178
8179
8180
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8177

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 Amazon Connect 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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



8220
8221
8222
8223
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8220

def disassociate_phone_number_contact_flow(params = {}, options = {})
  req = build_request(:disassociate_phone_number_contact_flow, 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 Amazon Connect 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:



8255
8256
8257
8258
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8255

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 Amazon Connect 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:



8309
8310
8311
8312
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8309

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 Amazon Connect 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 Amazon Connect 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:



8358
8359
8360
8361
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8358

def disassociate_security_key(params = {}, options = {})
  req = build_request(:disassociate_security_key, 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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



8397
8398
8399
8400
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8397

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 Amazon Connect 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:



8433
8434
8435
8436
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8433

def disassociate_user_proficiencies(params = {}, options = {})
  req = build_request(:disassociate_user_proficiencies, 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 Amazon Connect 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:



8471
8472
8473
8474
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8471

def dismiss_user_contact(params = {}, options = {})
  req = build_request(:dismiss_user_contact, 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 "EMAIL_MESSAGE", "ATTACHMENT"
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 Amazon Connect 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 and Email.

    This value must be a valid ARN.

Returns:

See Also:



8547
8548
8549
8550
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8547

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 Amazon Connect instance.

  • :initial_contact_id (required, String) —

    The identifier of the initial contact.

Returns:

See Also:



8580
8581
8582
8583
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8580

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 the position of the contact in the queue.

Use cases

Following are common uses cases for position in queue:

  • Understand the expected wait experience of a contact.

  • Inform customers of their position in queue and potentially offer a callback.

  • Make data-driven routing decisions between primary and alternative queues.

  • Enhance queue visibility and leverage agent proficiencies to streamline contact routing.

Important things to know

  • The only way to retrieve the position of the contact in queue is by using this API. You can't retrieve the position by using flows and attributes.

  • For more information, see the Position in queue metric in the Amazon Connect Administrator Guide.

Endpoints: See Amazon Connect 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: "POSITION_IN_QUEUE", # required, accepts POSITION_IN_QUEUE
    },
  ],
})

Response structure


resp.metric_results #=> Array
resp.metric_results[0].name #=> String, one of "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 Amazon Connect 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 Amazon Connect.

  • :metrics (required, Array<Types::ContactMetricInfo>) —

    A list of contact-level metrics to retrieve.

Returns:

See Also:



8662
8663
8664
8665
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8662

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 Amazon Connect instance.

For a description of each metric, see Metrics definitions in the Amazon Connect 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"],
  },
  groupings: ["QUEUE"], # accepts QUEUE, CHANNEL, ROUTING_PROFILE, ROUTING_STEP_EXPRESSION, AGENT_STATUS
  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
      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
      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].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"
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 Amazon Connect 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

    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 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 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 and unit for each metric. The following metrics are available. For a description of all the metrics, see Metrics definitions in the Amazon Connect Administrator Guide.

    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

    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:



8971
8972
8973
8974
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8971

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 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.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 Amazon Connect 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:



9084
9085
9086
9087
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9084

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.time_zone #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect 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:



9132
9133
9134
9135
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9132

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

#get_federation_token(params = {}) ⇒ Types::GetFederationTokenResponse

Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.

For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect 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 Amazon Connect

Examples:

Request syntax with placeholder values


resp = client.get_federation_token({
  instance_id: "InstanceId", # required
})

Response structure


resp.credentials.access_token #=> String
resp.credentials.access_token_expiration #=> Time
resp.credentials.refresh_token #=> String
resp.credentials.refresh_token_expiration #=> Time
resp. #=> String
resp.user_arn #=> String
resp.user_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.

Returns:

See Also:



9193
9194
9195
9196
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9193

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 Amazon Connect 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:



9244
9245
9246
9247
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9244

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 Amazon Connect instance.

For a description of each historical metric, see Metrics definitions in the Amazon Connect 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"],
  },
  groupings: ["QUEUE"], # accepts QUEUE, CHANNEL, ROUTING_PROFILE, ROUTING_STEP_EXPRESSION, AGENT_STATUS
  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].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 Amazon Connect 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 Amazon Connect 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:



9636
9637
9638
9639
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9636

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 Amazon Connect 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 Amazon Connect 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"],
    },
  ],
  groupings: ["GroupingV2"],
  metrics: [ # required
    {
      name: "MetricNameV2",
      threshold: [
        {
          comparison: "ResourceArnOrId",
          threshold_value: 1.0,
        },
      ],
      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_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 Amazon Connect 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 Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect 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>) —

    The filters to apply to returned metrics. You can filter on the following resources:

    • Agents

    • Campaigns

    • Channels

    • Feature

    • Queues

    • Routing profiles

    • Routing step expression

    • User hierarchy groups

    At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.

    For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement.

    To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator Guide.

    Note the following limits:

    • Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: AGENT | 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 | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE | CAMPAIGN_EXCLUDED_EVENT_TYPE | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | EVALUATION_FORM | EVALUATION_SECTION | EVALUATION_QUESTION | 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 | INITIATION_METHOD | INVOKING_RESOURCE_PUBLISHED_TIMESTAMP | INVOKING_RESOURCE_TYPE | PARENT_FLOWS_RESOURCE_ID | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | QUEUE | Q_CONNECT_ENABLED |

    • Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation 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 3 channel filters.

      contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.

      connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key.

      ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.

      Q_CONNECT_ENABLED. TRUE and FALSE are the only valid filterValues for the Q_CONNECT_ENABLED filter key.

      • TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.

      • FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow This filter is available only for contact record-driven metrics.

      Campaign ARNs are valid filterValues for the CAMPAIGN filter key.

  • :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 | 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 | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE | CAMPAIGN_EXCLUDED_EVENT_TYPE | CAMPAIGN_EXECUTION_TIMESTAMP | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | 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 | PARENT_FLOWS_RESOURCE_ID | Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION

    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, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Metrics definition in the Amazon Connect Administrator Guide.

    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, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression

    UI name: Average handle time

    Feature is a valid filter but not a valid grouping.

    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 delivery mode.

    Unit: Count

    Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE

    Valid groupings and filters: Campaign

    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, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile

    UI name: Delivery attempts

    Campaign Delivery EventType filter and grouping are only available for SMS and Email 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, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile

    UI name: Delivery attempt disposition rate

    Campaign Delivery Event Type filter and grouping are only available for SMS and Email 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:



11529
11530
11531
11532
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11529

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 Amazon Connect 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:



11570
11571
11572
11573
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11570

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 Amazon Connect 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 Amazon Connect 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:



11652
11653
11654
11655
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11652

def get_task_template(params = {}, options = {})
  req = build_request(:get_task_template, 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:



11698
11699
11700
11701
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11698

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 Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect 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 Amazon Connect 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:



11795
11796
11797
11798
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11795

def import_phone_number(params = {}, options = {})
  req = build_request(:import_phone_number, 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 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.

  • :agent_status_types (Array<String>) —

    Available agent status types.

Returns:

See Also:



11852
11853
11854
11855
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11852

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 Amazon Connect 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 Amazon Connect 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:



11907
11908
11909
11910
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11907

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 Amazon Connect 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 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:



11955
11956
11957
11958
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11955

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 Amazon Connect 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 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:



12007
12008
12009
12010
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12007

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 Amazon Connect 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 Amazon Connect.

  • :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:



12066
12067
12068
12069
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12066

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

#list_authentication_profiles(params = {}) ⇒ Types::ListAuthenticationProfilesResponse

This API is in preview release for Amazon Connect 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 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_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 Amazon Connect 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:



12124
12125
12126
12127
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12124

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 Amazon Connect 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 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.

  • :lex_version (required, String) —

    The version of Amazon Lex or Amazon Lex V2.

Returns:

See Also:



12183
12184
12185
12186
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12183

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

#list_contact_evaluations(params = {}) ⇒ Types::ListContactEvaluationsResponse

Lists contact evaluations in the specified 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_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"
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].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.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.

  • :contact_id (required, String) —

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

  • :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:



12251
12252
12253
12254
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12251

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 Amazon Connect 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:



12309
12310
12311
12312
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12309

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 Amazon Connect 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:



12364
12365
12366
12367
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12364

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 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_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 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.

  • :contact_flow_module_state (String) —

    The state of the flow module.

Returns:

See Also:



12420
12421
12422
12423
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12420

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 Amazon Connect 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 Amazon Connect 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:



12471
12472
12473
12474
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12471

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 Amazon Connect instance.

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

For more information about flows, see Flows in the Amazon Connect 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 Amazon Connect 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:



12541
12542
12543
12544
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12541

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 Amazon Connect 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
  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].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 Amazon Connect 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:



12616
12617
12618
12619
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12616

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

#list_default_vocabularies(params = {}) ⇒ Types::ListDefaultVocabulariesResponse

Lists the default vocabularies for the specified 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_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 Amazon Connect 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:



12678
12679
12680
12681
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12678

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

#list_evaluation_form_versions(params = {}) ⇒ Types::ListEvaluationFormVersionsResponse

Lists versions of an evaluation form in the specified 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_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 Amazon Connect 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:



12739
12740
12741
12742
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12739

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 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_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 Amazon Connect 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:



12797
12798
12799
12800
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12797

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 Amazon Connect 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:



12851
12852
12853
12854
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12851

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.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 Amazon Connect 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:



12914
12915
12916
12917
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12914

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 Amazon Connect instance.

For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect 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 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. The default MaxResult size is 100.

Returns:

See Also:



12975
12976
12977
12978
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12975

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 Amazon Connect 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"
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 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:



13028
13029
13030
13031
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13028

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 Amazon Connect 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 Amazon Connect 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:



13095
13096
13097
13098
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13095

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 Amazon Connect 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:



13149
13150
13151
13152
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13149

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 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_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
  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"
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 Amazon Connect 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:



13213
13214
13215
13216
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13213

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 Amazon Connect 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 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:



13265
13266
13267
13268
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13265

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 Amazon Connect 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 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. If no value is specified, the default is 10.

Returns:

See Also:



13324
13325
13326
13327
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13324

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

#list_phone_numbers(params = {}) ⇒ Types::ListPhoneNumbersResponse

Provides information about the phone numbers for the specified Amazon Connect instance.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect 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 Amazon Connect 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:



13419
13420
13421
13422
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13419

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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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 Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.

  • :instance_id (String) —

    The identifier of the Amazon Connect 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 Amazon Connect instances belonging to your account in the same AWS 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:



13521
13522
13523
13524
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13521

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 Amazon Connect 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 Amazon Connect quotas.

Endpoints: See Amazon Connect 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 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:



13590
13591
13592
13593
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13590

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 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_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 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. The default MaxResult size is 100.

Returns:

See Also:



13639
13640
13641
13642
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13639

def list_prompts(params = {}, options = {})
  req = build_request(:list_prompts, 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"
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 Amazon Connect 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:



13701
13702
13703
13704
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13701

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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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:



13772
13773
13774
13775
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13772

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 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_quick_connects({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
  quick_connect_types: ["USER"], # accepts USER, QUEUE, PHONE_NUMBER
})

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"
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 Amazon Connect 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 Amazon Connect 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:



13835
13836
13837
13838
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13835

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 Amazon Connect 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 Amazon Connect.

  • :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:



13947
13948
13949
13950
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13947

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 Amazon Connect agent workspace in the Amazon Connect 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 Amazon Connect 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 Amazon Connect 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:



14035
14036
14037
14038
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14035

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 Amazon Connect 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:



14097
14098
14099
14100
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14097

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 Amazon Connect instance.

For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect 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 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. The default MaxResult size is 100.

Returns:

See Also:



14160
14161
14162
14163
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14160

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 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_rules({
  instance_id: "InstanceId", # required
  publish_status: "DRAFT", # accepts DRAFT, PUBLISHED
  event_source_name: "OnPostCallAnalysisAvailable", # accepts OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnRealTimeChatAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit, OnMetricDataUpdate, OnCaseCreate, OnCaseUpdate, OnSlaBreach
  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", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate", "OnContactEvaluationSubmit", "OnMetricDataUpdate", "OnCaseCreate", "OnCaseUpdate", "OnSlaBreach"
resp.rule_summary_list[0].publish_status #=> String, one of "DRAFT", "PUBLISHED"
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 Amazon Connect 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:



14224
14225
14226
14227
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14224

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 Amazon Connect 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 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:



14278
14279
14280
14281
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14278

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 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.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 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:



14337
14338
14339
14340
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14337

def list_security_profile_applications(params = {}, options = {})
  req = build_request(:list_security_profile_applications, 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 Amazon Connect 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 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:



14403
14404
14405
14406
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14403

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 Amazon Connect instance.

For more information about security profiles, see Security Profiles in the Amazon Connect 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 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. The default MaxResult size is 100.

Returns:

See Also:



14467
14468
14469
14470
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14467

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 Amazon Connect Identity-Based Policy Examples in the Amazon Connect 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 Amazon Connect resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN for an instance, for example, see Find your Amazon Connect instance ID/ARN.

Returns:

See Also:



14510
14511
14512
14513
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14510

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 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_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 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.

    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:



14580
14581
14582
14583
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14580

def list_task_templates(params = {}, options = {})
  req = build_request(:list_task_templates, 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:



14626
14627
14628
14629
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14626

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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

See Also:



14679
14680
14681
14682
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14679

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 Amazon Connect 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:



14733
14734
14735
14736
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14733

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 Amazon Connect instance.

For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect 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 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. The default MaxResult size is 100.

Returns:

See Also:



14794
14795
14796
14797
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14794

def list_user_hierarchy_groups(params = {}, options = {})
  req = build_request(:list_user_hierarchy_groups, 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 Amazon Connect 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:



14848
14849
14850
14851
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14848

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 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_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 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. The default MaxResult size is 100.

Returns:

See Also:



14902
14903
14904
14905
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14902

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 Amazon Connect 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 Amazon Connect 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:



14960
14961
14962
14963
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14960

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 Amazon Connect 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:



15016
15017
15018
15019
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15016

def list_views(params = {}, options = {})
  req = build_request(:list_views, 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 Amazon Connect 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:



15078
15079
15080
15081
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15078

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 Amazon Connect 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:



15109
15110
15111
15112
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15109

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 Amazon Connect. 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 Amazon Connect 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 Amazon Connect 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:



15154
15155
15156
15157
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15154

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 Amazon Connect 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 Amazon Connect 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:



15218
15219
15220
15221
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15218

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 Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.

For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect 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 Amazon Connect 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 Amazon Connect 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:



15288
15289
15290
15291
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15288

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 Amazon Connect 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:



15319
15320
15321
15322
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15319

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 Amazon Connect 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:



15365
15366
15367
15368
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15365

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 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_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 Amazon Connect 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:



15471
15472
15473
15474
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15471

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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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:



15546
15547
15548
15549
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15546

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 Amazon Connect 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. Contact Evaluations may not be fully backfilled with historical data in all regions yet, however all recently created Contact Evaluations should be available for search.

^

Endpoints: See Amazon Connect 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",
      },
    },
  },
})

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].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].status #=> String, one of "DRAFT", "SUBMITTED"
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 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_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:



15714
15715
15716
15717
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15714

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 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_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 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::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:



15828
15829
15830
15831
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15828

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 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_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",
      },
    },
  },
  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 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::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:



15944
15945
15946
15947
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15944

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 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.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
    },
  },
  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.next_token #=> String
resp.total_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of Amazon Connect 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:



16129
16130
16131
16132
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16129

def search_contacts(params = {}, options = {})
  req = build_request(:search_contacts, 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 Amazon Connect 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:



16228
16229
16230
16231
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16228

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 Amazon Connect 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 Amazon Connect 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].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 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_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:



16384
16385
16386
16387
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16384

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.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.

  • :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:



16492
16493
16494
16495
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16492

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 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_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].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 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::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:



16602
16603
16604
16605
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16602

def search_hours_of_operations(params = {}, options = {})
  req = build_request(:search_hours_of_operations, 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 Amazon Connect quotas.

Endpoints: See Amazon Connect 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 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_criteria (Types::PredefinedAttributeSearchCriteria) —

    The search criteria to be used to return predefined attributes.

Returns:

See Also:



16699
16700
16701
16702
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16699

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 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_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 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::PromptSearchFilter) —

    Filters to be applied to search results.

  • :search_criteria (Types::PromptSearchCriteria) —

    The search criteria to be used to return prompts.

Returns:

See Also:



16802
16803
16804
16805
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16802

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 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_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 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::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:



16920
16921
16922
16923
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16920

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 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_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"
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].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 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::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:



17029
17030
17031
17032
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17029

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 Amazon Connect 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 Amazon Connect 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)

  • :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:



17114
17115
17116
17117
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17114

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 Amazon Connect 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 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::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:



17250
17251
17252
17253
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17250

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

#search_security_profiles(params = {}) ⇒ Types::SearchSecurityProfilesResponse

Searches security profiles in an Amazon Connect instance, with optional filtering.

For information about security profiles, see Security Profiles in the Amazon Connect 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 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_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:



17372
17373
17374
17375
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17372

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

#search_user_hierarchy_groups(params = {}) ⇒ Types::SearchUserHierarchyGroupsResponse

Searches UserHierarchyGroups in an Amazon Connect 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 Amazon Connect 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:



17504
17505
17506
17507
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17504

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 Amazon Connect 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.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::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:



17684
17685
17686
17687
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17684

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

#search_vocabularies(params = {}) ⇒ Types::SearchVocabulariesResponse

Searches for vocabularies within a specific Amazon Connect 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 Amazon Connect 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:



17757
17758
17759
17760
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17757

def search_vocabularies(params = {}, options = {})
  req = build_request(:search_vocabularies, 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 Amazon Connect. 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 Amazon Connect 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:



17842
17843
17844
17845
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17842

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 Amazon Connect outbound campaigns.

Only the Amazon Connect 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 Amazon Connect 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:



17954
17955
17956
17957
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17954

def send_outbound_email(params = {}, options = {})
  req = build_request(:send_outbound_email, 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 an Amazon Connect Case or Amazon Connect Email.

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: "EMAIL_MESSAGE", # required, accepts EMAIL_MESSAGE, ATTACHMENT
  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 Amazon Connect 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 and Email.

    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:



18066
18067
18068
18069
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18066

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 Amazon Connect 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 Amazon Connect 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
  },
  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",
})

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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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.

  • :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 Amazon Connect 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 Amazon Connect 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.

Returns:

See Also:



18284
18285
18286
18287
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18284

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

#start_contact_evaluation(params = {}) ⇒ Types::StartContactEvaluationResponse

Starts an empty evaluation in the specified Amazon Connect 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 Amazon Connect 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 Amazon Connect.

  • :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:



18364
18365
18366
18367
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18364

def start_contact_evaluation(params = {}, options = {})
  req = build_request(:start_contact_evaluation, 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 Amazon Connect 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:



18429
18430
18431
18432
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18429

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 Amazon Connect Administrator Guide.

For more information about chat, see the following topics in the Amazon Connect 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 Amazon Connect 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:



18506
18507
18508
18509
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18506

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
      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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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:



18697
18698
18699
18700
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18697

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

#start_outbound_chat_contact(params = {}) ⇒ Types::StartOutboundChatContactResponse

Initiates a new outbound SMS contact to a customer. Response of this API provides the ContactId of the outbound SMS 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 SMS contact created.

This API can be used to initiate outbound SMS contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS contact by using the StartOutboundChatContact Flow Action.

For more information about using SMS in Amazon Connect, see the following topics in the Amazon Connect 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
  },
  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 Amazon Connect 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 Amazon Connect 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 and connect:SMS.

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

    A custom key-value pair using an attribute map. The attributes are standard Amazon Connect 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 Amazon Connect 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.

  • :related_contact_id (String) —

    The unique identifier for an Amazon Connect 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 AWS 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:



18877
18878
18879
18880
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18877

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 Amazon Connect 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 Amazon Connect.

  • :from_email_address (Types::EmailAddressInfo) —

    The email address associated with the Amazon Connect 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:



18975
18976
18977
18978
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18975

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 Amazon Connect Service Quotas in the Amazon Connect 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 Amazon Connect 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
      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 Amazon Connect 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 Amazon Connect 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 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. 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 Amazon Connect 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 Amazon Connect 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 Amazon Connect. 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:



19181
19182
19183
19184
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19181

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 Amazon Connect 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 Amazon Connect 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 Amazon Connect.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



19232
19233
19234
19235
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19232

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 Amazon Connect in the Amazon Connect 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 Amazon Connect 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 Amazon Connect service quotas in the Amazon Connect 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
      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",
    },
  },
})

Response structure


resp.contact_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.

  • :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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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"}}}.

Returns:

See Also:



19458
19459
19460
19461
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19458

def start_task_contact(params = {}, options = {})
  req = build_request(:start_task_contact, 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 Amazon Connect 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
      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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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:



19593
19594
19595
19596
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19593

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 Amazon Connect 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 Amazon Connect 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 Amazon Connect Administrator Guide.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



19653
19654
19655
19656
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19653

def stop_contact(params = {}, options = {})
  req = build_request(:stop_contact, 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 Amazon Connect 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:



19701
19702
19703
19704
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19701

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 Amazon Connect 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:



19742
19743
19744
19745
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19742

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

#submit_contact_evaluation(params = {}) ⇒ Types::SubmitContactEvaluationResponse

Submits a contact evaluation in the specified Amazon Connect 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,
        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 Amazon Connect 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:



19815
19816
19817
19818
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19815

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 Amazon Connect 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:



19870
19871
19872
19873
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19870

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 Amazon Connect 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 Amazon Connect.

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

  • :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:



19918
19919
19920
19921
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19918

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, and task templates. For a complete list, see Tagging resources in Amazon Connect.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect 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:



19961
19962
19963
19964
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19961

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 Amazon Connect 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 Amazon Connect.

  • :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:



20045
20046
20047
20048
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20045

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 Amazon Connect 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 Amazon Connect.

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

  • :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:



20087
20088
20089
20090
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20087

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:



20113
20114
20115
20116
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20113

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 Amazon Connect 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:



20164
20165
20166
20167
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20164

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

#update_authentication_profile(params = {}) ⇒ Struct

This API is in preview release for Amazon Connect 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 Amazon Connect 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 Amazon Connect 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 Amazon Connect Administrator Guide.

  • :periodic_session_duration (Integer) —

    The short lived session duration configuration for users logged in to Amazon Connect, 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 Amazon Connect 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:



20251
20252
20253
20254
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20251

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 Amazon Connect 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
      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 Amazon Connect 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 Amazon Connect 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 Amazon Connect Contact Lens integration in the Amazon Connect 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 Amazon Connect Contact Lens integration in the Amazon Connect 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 Amazon Connect Contact Lens integration in the Amazon Connect 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 Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



20401
20402
20403
20404
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20401

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 Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.

Contact attributes are available in Amazon Connect 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 Amazon Connect 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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    The Amazon Connect 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 Amazon Connect Administrator Guide.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



20482
20483
20484
20485
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20482

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 Amazon Connect 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,
        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 Amazon Connect 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:



20551
20552
20553
20554
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20551

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 Amazon Connect 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 Amazon Connect 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 Amazon Connect Flow language.

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



20600
20601
20602
20603
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20600

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 Amazon Connect 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:



20643
20644
20645
20646
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20643

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 Amazon Connect 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:



20691
20692
20693
20694
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20691

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 Amazon Connect 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 Amazon Connect 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 Amazon Connect Flow language.

  • :settings (String) —

    Serialized JSON string of the flow module Settings schema.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



20741
20742
20743
20744
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20741

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 Amazon Connect 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:



20784
20785
20786
20787
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20784

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 Amazon Connect 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 Amazon Connect 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:



20825
20826
20827
20828
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20825

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 Amazon Connect 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 Amazon Connect.

  • :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:



20944
20945
20946
20947
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20944

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 Amazon Connect 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:



20982
20983
20984
20985
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20982

def update_contact_schedule(params = {}, options = {})
  req = build_request(:update_contact_schedule, 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 Amazon Connect 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 Amazon Connect 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:



21046
21047
21048
21049
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21046

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 Amazon Connect 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,
      },
      question: {
        title: "EvaluationFormQuestionTitle", # required
        instructions: "EvaluationFormQuestionInstructions",
        ref_id: "ReferenceId", # required
        not_applicable_enabled: false,
        question_type: "TEXT", # required, accepts TEXT, SINGLESELECT, NUMERIC
        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",
                },
              },
            ],
            automation: {
              property_value: {
                label: "OVERALL_CUSTOMER_SENTIMENT_SCORE", # required, accepts OVERALL_CUSTOMER_SENTIMENT_SCORE, OVERALL_AGENT_SENTIMENT_SCORE, 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",
                },
              },
            ],
            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
              },
            },
          },
        },
        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
                },
                condition: {
                  # recursive EvaluationFormItemEnablementCondition
                },
              },
            ],
            operator: "OR", # accepts OR, AND
          },
          action: "DISABLE", # required, accepts DISABLE, ENABLE
          default_action: "DISABLE", # accepts DISABLE, ENABLE
        },
        weight: 1.0,
      },
    },
  ],
  scoring_strategy: {
    mode: "QUESTION_ONLY", # required, accepts QUESTION_ONLY, SECTION_ONLY
    status: "ENABLED", # required, accepts ENABLED, DISABLED
  },
  auto_evaluation_configuration: {
    enabled: false, # required
  },
  client_token: "ClientToken",
})

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 Amazon Connect 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.

  • :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:



21249
21250
21251
21252
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21249

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 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 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:



21308
21309
21310
21311
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21308

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",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect 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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



21371
21372
21373
21374
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21371

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 Amazon Connect 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
  value: "InstanceAttributeValue", # required
  client_token: "ClientToken",
})

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.

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

  • :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:



21429
21430
21431
21432
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21429

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 Amazon Connect 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 Amazon Connect 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:



21512
21513
21514
21515
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21512

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

#update_participant_authentication(params = {}) ⇒ Struct

Instructs Amazon Connect 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 Amazon Connect 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:



21576
21577
21578
21579
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21576

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 Amazon Connect 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 Amazon Connect.

  • :channel_configuration (required, Types::UpdateParticipantRoleConfigChannelInfo) —

    The Amazon Connect channel you want to configure.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



21641
21642
21643
21644
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21641

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 Amazon Connect instance or traffic distribution group to another Amazon Connect 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 Amazon Connect 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 Amazon Connect 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:



21719
21720
21721
21722
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21719

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:



21766
21767
21768
21769
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21766

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 Amazon Connect instance. A predefined attribute is made up of a name and a value.

For the predefined attributes per instance quota, see Amazon Connect 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 Amazon Connect 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 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 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 Amazon Connect 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 Amazon Connect admin website.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



21841
21842
21843
21844
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21841

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 Amazon Connect 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:



21898
21899
21900
21901
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21898

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 Amazon Connect 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:



21933
21934
21935
21936
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21933

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 Amazon Connect 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:



21970
21971
21972
21973
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21970

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 Amazon Connect 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:



22010
22011
22012
22013
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22010

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 Amazon Connect 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 Amazon Connect 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:



22077
22078
22079
22080
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22077

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 Amazon Connect 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:



22114
22115
22116
22117
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22114

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 Amazon Connect 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:



22149
22150
22151
22152
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22149

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
    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
    },
  },
})

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.

  • :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:



22197
22198
22199
22200
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22197

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 Amazon Connect 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:



22238
22239
22240
22241
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22238

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 Amazon Connect 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:



22277
22278
22279
22280
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22277

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 Amazon Connect 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:



22322
22323
22324
22325
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22322

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 Amazon Connect 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:



22357
22358
22359
22360
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22357

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 Amazon Connect 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:



22399
22400
22401
22402
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22399

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 Amazon Connect 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:



22446
22447
22448
22449
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22446

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 Amazon Connect 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
            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 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 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:



22595
22596
22597
22598
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22595

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 Amazon Connect 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"],
    },
  ],
  hierarchy_restricted_resources: ["HierarchyRestrictedResourceName"],
  allowed_access_control_hierarchy_group_id: "HierarchyGroupId",
})

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 Amazon Connect 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 Amazon Connect.

  • :tag_restricted_resources (Array<String>) —

    The list of resources that a security profile applies tag restrictions to in Amazon Connect.

  • :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 Amazon Connect. 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 Amazon Connect.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



22681
22682
22683
22684
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22681

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 Amazon Connect 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 Amazon Connect 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.

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

  • :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 (Array<Types::TaskTemplateField>) —

    Fields that are part of the template.

Returns:

See Also:



22834
22835
22836
22837
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22834

def update_task_template(params = {}, options = {})
  req = build_request(:update_task_template, 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 Amazon Connect Administrator Guide.

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:



22918
22919
22920
22921
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22918

def update_traffic_distribution(params = {}, options = {})
  req = build_request(:update_traffic_distribution, 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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



22953
22954
22955
22956
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22953

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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



22988
22989
22990
22991
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22988

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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



23036
23037
23038
23039
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23036

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 Amazon Connect 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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



23089
23090
23091
23092
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23089

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

#update_user_phone_config(params = {}) ⇒ Struct

Updates the phone configuration settings for the specified user.

Examples:

Request syntax with placeholder values


resp = client.update_user_phone_config({
  phone_config: { # required
    phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
    auto_accept: false,
    after_contact_work_time_limit: 1,
    desk_phone_number: "PhoneNumber",
    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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



23130
23131
23132
23133
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23130

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 Amazon Connect 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:



23169
23170
23171
23172
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23169

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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



23204
23205
23206
23207
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23204

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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



23239
23240
23241
23242
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23239

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 Amazon Connect 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 Amazon Connect 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:



23310
23311
23312
23313
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23310

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 Amazon Connect 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:



23346
23347
23348
23349
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23346

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