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

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

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

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

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

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

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

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

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

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

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.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::InstanceProfileCredentails 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)
  • :active_endpoint_cache (Boolean) — default: false —

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

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

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

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

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

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

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

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :token_provider (Aws::TokenProvider) —

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

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

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

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

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::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_proxy (URI::HTTP, String) —

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

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

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

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

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



365
366
367
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 365

def initialize(*args)
  super
end

Instance Method Details

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

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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



400
401
402
403
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 400

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

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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



444
445
446
447
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 444

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



488
489
490
491
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 488

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

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.

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

    A valid storage type.

Returns:

See Also:



565
566
567
568
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 565

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

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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



601
602
603
604
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 601

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

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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



640
641
642
643
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 640

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:



687
688
689
690
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 687

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

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

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:



725
726
727
728
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 725

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: [ # required
    {
      queue_reference: { # required
        queue_id: "QueueId", # required
        channel: "VOICE", # required, accepts VOICE, CHAT, TASK
      },
      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 associate with this routing profile.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



769
770
771
772
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 769

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

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.

Returns:

See Also:



809
810
811
812
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 809

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

Examples:

Request syntax with placeholder values


resp = client.claim_phone_number({
  target_arn: "ARN", # required
  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 (required, String) —

    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

  • :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": {"key1":"value1", "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:



894
895
896
897
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 894

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

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

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

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": {"key1":"value1", "key2":"value2"\} \}.

Returns:

See Also:



956
957
958
959
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 956

def create_agent_status(params = {}, options = {})
  req = build_request(:create_agent_status, 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
  description: "ContactFlowDescription",
  content: "ContactFlowContent", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The identifier of the Amazon Connect instance.

  • :name (required, String) —

    The name of the 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 content of the flow.

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



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

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

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 content of the flow module.

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

    The tags used to organize, track, or control access for this resource. For example, \{ "tags": {"key1":"value1", "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:



1091
1092
1093
1094
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1091

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

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

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

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": {"key1":"value1", "key2":"value2"\} \}.

Returns:

See Also:



1166
1167
1168
1169
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1166

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

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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    The idempotency token.

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

Returns:

See Also:



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

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, CASES_DOMAIN
  integration_arn: "ARN", # required
  source_application_url: "URI",
  source_application_name: "SourceApplicationName",
  source_type: "SALESFORCE", # accepts SALESFORCE, ZENDESK
  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 Pinpoint, the Amazon Connect and Amazon Pinpoint 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": {"key1":"value1", "key2":"value2"\} \}.

Returns:

See Also:



1301
1302
1303
1304
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1301

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

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

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

Creates a new queue for the specified Amazon Connect instance.

If the number being used in the input 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 OutboundCallerIdNumberId value of the OutboundCallerConfig request body 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.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",
  },
  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.

  • :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": {"key1":"value1", "key2":"value2"\} \}.

Returns:

See Also:



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

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

    The 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": {"key1":"value1", "key2":"value2"\} \}.

Returns:

See Also:



1460
1461
1462
1463
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1460

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
      },
      priority: 1, # required
      delay: 1, # required
    },
  ],
  media_concurrencies: [ # required
    {
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK
      concurrency: 1, # required
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
})

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.

  • :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": {"key1":"value1", "key2":"value2"\} \}.

Returns:

See Also:



1550
1551
1552
1553
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1550

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, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate
    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
      task_action: {
        name: "TaskNameExpression", # required
        description: "TaskDescriptionExpression",
        contact_flow_id: "ContactFlowId", # required
        references: {
          "ReferenceKey" => {
            value: "ReferenceValue", # required
            type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
          },
        },
      },
      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"],
        },
      },
    },
  ],
  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:



1660
1661
1662
1663
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1660

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

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

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

Creates a security profile.

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

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": {"key1":"value1", "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. Following are acceptable ResourceNames: User | SecurityProfile | Queue | RoutingProfile

Returns:

See Also:



1736
1737
1738
1739
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1736

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

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



1858
1859
1860
1861
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1858

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.

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": {"key1":"value1", "key2":"value2"\} \}.

Returns:

See Also:



1928
1929
1930
1931
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1928

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": {"key1":"value1", "key2":"value2"\} \}.

Returns:

See Also:



1980
1981
1982
1983
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1980

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.

For information about how to create user accounts using the Amazon Connect console, 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",
  },
  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_-.\@]+.

  • :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": {"key1":"value1", "key2":"value2"\} \}.

Returns:

See Also:



2089
2090
2091
2092
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2089

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": {"key1":"value1", "key2":"value2"\} \}.

Returns:

See Also:



2142
2143
2144
2145
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2142

def create_user_hierarchy_group(params = {}, options = {})
  req = build_request(:create_user_hierarchy_group, 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
  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": {"key1":"value1", "key2":"value2"\} \}.

Returns:

See Also:



2233
2234
2235
2236
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2233

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



2264
2265
2266
2267
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2264

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:



2295
2296
2297
2298
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2295

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

#delete_hours_of_operation(params = {}) ⇒ Struct

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

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:



2329
2330
2331
2332
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2329

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

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

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:

  • (Struct) —

    Returns an empty response.

See Also:



2366
2367
2368
2369
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2366

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:



2399
2400
2401
2402
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2399

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

#delete_quick_connect(params = {}) ⇒ Struct

Deletes a quick connect.

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:



2430
2431
2432
2433
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2430

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



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

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

#delete_security_profile(params = {}) ⇒ Struct

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

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:



2495
2496
2497
2498
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2495

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:



2526
2527
2528
2529
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2526

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

  • (Struct) —

    Returns an empty response.

See Also:



2560
2561
2562
2563
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2560

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:



2595
2596
2597
2598
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2595

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.

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:



2634
2635
2636
2637
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2634

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:



2666
2667
2668
2669
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2666

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



2707
2708
2709
2710
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2707

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

#describe_agent_status(params = {}) ⇒ Types::DescribeAgentStatusResponse

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

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

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:



2755
2756
2757
2758
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2755

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

Contact information remains available in Amazon Connect for 24 months, and then it is deleted.

Only data from November 12, 2021, and later is returned by this API.

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.initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR"
resp.contact.name #=> String
resp.contact.description #=> String
resp.contact.channel #=> String, one of "VOICE", "CHAT", "TASK"
resp.contact.queue_info.id #=> String
resp.contact.queue_info.enqueue_timestamp #=> Time
resp.contact.agent_info.id #=> String
resp.contact.agent_info.connected_to_agent_timestamp #=> Time
resp.contact.initiation_timestamp #=> Time
resp.contact.disconnect_timestamp #=> Time
resp.contact.last_update_timestamp #=> Time
resp.contact.scheduled_timestamp #=> Time
resp.contact.related_contact_id #=> String
resp.contact.wisdom_info.session_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.

Returns:

See Also:



2817
2818
2819
2820
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2817

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

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"
resp.contact_flow.state #=> String, one of "ACTIVE", "ARCHIVED"
resp.contact_flow.description #=> String
resp.contact_flow.content #=> String
resp.contact_flow.tags #=> Hash
resp.contact_flow.tags["TagKey"] #=> 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:



2864
2865
2866
2867
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2864

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.

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

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:



2909
2910
2911
2912
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2909

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

#describe_hours_of_operation(params = {}) ⇒ Types::DescribeHoursOfOperationResponse

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

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

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:



2961
2962
2963
2964
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2961

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

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:



3013
3014
3015
3016
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3013

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

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



3054
3055
3056
3057
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3054

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

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:



3111
3112
3113
3114
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3111

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 will 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"
resp.claimed_phone_number_summary.phone_number_description #=> String
resp.claimed_phone_number_summary.target_arn #=> 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

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number_id (required, String) —

    A unique identifier for the phone number.

Returns:

See Also:



3160
3161
3162
3163
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3160

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

#describe_queue(params = {}) ⇒ Types::DescribeQueueResponse

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

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

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:



3211
3212
3213
3214
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3211

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

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:



3259
3260
3261
3262
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3259

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.

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"
resp.routing_profile.media_concurrencies[0].concurrency #=> Integer
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_users #=> 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.

  • :routing_profile_id (required, String) —

    The identifier of the routing profile.

Returns:

See Also:



3308
3309
3310
3311
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3308

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", "OnPostChatAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate"
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"
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", "NUMBER", "STRING", "DATE", "EMAIL"
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.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:



3373
3374
3375
3376
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3373

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

#describe_security_profile(params = {}) ⇒ Types::DescribeSecurityProfileResponse

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

Gets basic information about the security profle.

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

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:



3423
3424
3425
3426
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3423

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

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:



3461
3462
3463
3464
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3461

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

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:



3523
3524
3525
3526
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3523

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_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_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_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_five.id #=> String
resp.hierarchy_group.hierarchy_path.level_five.arn #=> String
resp.hierarchy_group.hierarchy_path.level_five.name #=> String
resp.hierarchy_group.tags #=> Hash
resp.hierarchy_group.tags["TagKey"] #=> 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:



3580
3581
3582
3583
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3580

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_two.id #=> String
resp.hierarchy_structure.level_two.arn #=> String
resp.hierarchy_structure.level_two.name #=> 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_four.id #=> String
resp.hierarchy_structure.level_four.arn #=> String
resp.hierarchy_structure.level_four.name #=> String
resp.hierarchy_structure.level_five.id #=> String
resp.hierarchy_structure.level_five.arn #=> String
resp.hierarchy_structure.level_five.name #=> 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:



3628
3629
3630
3631
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3628

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



3674
3675
3676
3677
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3674

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

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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3708
3709
3710
3711
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3708

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

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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3752
3753
3754
3755
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3752

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

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:

  • (Struct) —

    Returns an empty response.

See Also:



3792
3793
3794
3795
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3792

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

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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3868
3869
3870
3871
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3868

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:



3911
3912
3913
3914
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3911

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

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

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:



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

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.

Examples:

Request syntax with placeholder values


resp = client.disassociate_routing_profile_queues({
  instance_id: "InstanceId", # required
  routing_profile_id: "RoutingProfileId", # required
  queue_references: [ # required
    {
      queue_id: "QueueId", # required
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK
    },
  ],
})

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

    The queues to disassociate from this routing profile.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3989
3990
3991
3992
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3989

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

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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4024
4025
4026
4027
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4024

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



4062
4063
4064
4065
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4062

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



4095
4096
4097
4098
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4095

def get_contact_attributes(params = {}, options = {})
  req = build_request(:get_contact_attributes, 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 Real-time Metrics Definitions 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.get_current_metric_data({
  instance_id: "InstanceId", # required
  filters: { # required
    queues: ["QueueId"],
    channels: ["VOICE"], # accepts VOICE, CHAT, TASK
    routing_profiles: ["RoutingProfileId"],
  },
  groupings: ["QUEUE"], # accepts QUEUE, CHANNEL, ROUTING_PROFILE
  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"
resp.metric_results[0].dimensions.routing_profile.id #=> String
resp.metric_results[0].dimensions.routing_profile.arn #=> 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.)

    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.

    Currently tagging is only supported on the resources that are passed in the filter.

  • :groupings (Array<String>) —

    The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues.

    • If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.

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

    • If no Grouping is included in the request, a summary of metrics is returned.

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

    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:



4343
4344
4345
4346
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4343

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"
resp.user_data_list[0].contacts[0].initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API", "DISCONNECT", "MONITOR"
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:



4456
4457
4458
4459
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4456

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

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

Retrieves a token for federation.

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:



4507
4508
4509
4510
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4507

def get_federation_token(params = {}, options = {})
  req = build_request(:get_federation_token, 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 Historical Metrics Definitions 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.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
    routing_profiles: ["RoutingProfileId"],
  },
  groupings: ["QUEUE"], # accepts QUEUE, CHANNEL, ROUTING_PROFILE
  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"
resp.metric_results[0].dimensions.routing_profile.id #=> String
resp.metric_results[0].dimensions.routing_profile.arn #=> 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.

    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.

  • :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 Historical Metrics Definitions 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

    AFTER_CONTACT_WORK_TIME

    Unit: SECONDS

    Statistic: AVG

    API_CONTACTS_HANDLED

    Unit: COUNT

    Statistic: SUM

    CALLBACK_CONTACTS_HANDLED

    Unit: COUNT

    Statistic: SUM

    CONTACTS_ABANDONED

    Unit: COUNT

    Statistic: SUM

    CONTACTS_AGENT_HUNG_UP_FIRST

    Unit: COUNT

    Statistic: SUM

    CONTACTS_CONSULTED

    Unit: COUNT

    Statistic: SUM

    CONTACTS_HANDLED

    Unit: COUNT

    Statistic: SUM

    CONTACTS_HANDLED_INCOMING

    Unit: COUNT

    Statistic: SUM

    CONTACTS_HANDLED_OUTBOUND

    Unit: COUNT

    Statistic: SUM

    CONTACTS_HOLD_ABANDONS

    Unit: COUNT

    Statistic: SUM

    CONTACTS_MISSED

    Unit: COUNT

    Statistic: SUM

    CONTACTS_QUEUED

    Unit: COUNT

    Statistic: SUM

    CONTACTS_TRANSFERRED_IN

    Unit: COUNT

    Statistic: SUM

    CONTACTS_TRANSFERRED_IN_FROM_QUEUE

    Unit: COUNT

    Statistic: SUM

    CONTACTS_TRANSFERRED_OUT

    Unit: COUNT

    Statistic: SUM

    CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

    Unit: COUNT

    Statistic: SUM

    HANDLE_TIME

    Unit: SECONDS

    Statistic: AVG

    HOLD_TIME

    Unit: SECONDS

    Statistic: AVG

    INTERACTION_AND_HOLD_TIME

    Unit: SECONDS

    Statistic: AVG

    INTERACTION_TIME

    Unit: SECONDS

    Statistic: AVG

    OCCUPANCY

    Unit: PERCENT

    Statistic: AVG

    QUEUE_ANSWER_TIME

    Unit: SECONDS

    Statistic: AVG

    QUEUED_TIME

    Unit: SECONDS

    Statistic: MAX

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

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



4803
4804
4805
4806
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4803

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 last the 14 days, in 24-hour intervals.

For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator's Guide.

This API is not available in the Amazon Web Services GovCloud (US) Regions.

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
  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"],
        },
      ],
    },
  ],
  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].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].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 time range between the start and end time must be less than 24 hours. The start time cannot be earlier than 14 days before the time of the request. Historical metrics are available for 14 days.

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

    The time range between the start and end time must be less than 24 hours.

  • :filters (required, Array<Types::FilterV2>) —

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

    • Queues

    • Routing profiles

    • Agents

    • Channels

    • User hierarchy groups

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

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

    Note the following limits:

    • Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE

    • Filter values: A maximum of 100 filter values are supported in a single request. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL 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: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE

  • :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 Historical metrics definitions in the Amazon Connect Administrator's Guide.

    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

    AGENT_NON_RESPONSE

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AGENT_OCCUPANCY

    Unit: Percentage

    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

    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

    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

    AVG_ABANDON_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AVG_AFTER_CONTACT_WORK_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    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

    AVG_HANDLE_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AVG_HOLD_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AVG_INTERACTION_AND_HOLD_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AVG_INTERACTION_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile

    AVG_QUEUE_ANSWER_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile

    CONTACTS_ABANDONED

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    CONTACTS_CREATED

    Unit: Count

    Valid metric filter key: INITIATION_METHOD

    Valid groupings and filters: Queue, Channel, Routing Profile

    CONTACTS_HANDLED

    Unit: Count

    Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    CONTACTS_HOLD_ABANDONS

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    CONTACTS_QUEUED

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    CONTACTS_TRANSFERRED_OUT

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    CONTACTS_TRANSFERRED_OUT_BY_AGENT

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    MAX_QUEUED_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    SERVICE_LEVEL

    You can include up to 20 SERVICE_LEVEL metrics in a request.

    Unit: Percent

    Valid groupings and filters: Queue, Channel, Routing Profile

    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

    SUM_CONTACTS_ANSWERED_IN_X

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile

    SUM_CONTACTS_ABANDONED_IN_X

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile

    SUM_CONTACTS_DISCONNECTED

    Valid metric filter key: DISCONNECT_REASON

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile

    SUM_RETRY_CALLBACK_ATTEMPTS

    Unit: Count

    Valid groupings and filters: Queue, Channel, 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:



5186
5187
5188
5189
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5186

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



5266
5267
5268
5269
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5266

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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The identifier of the traffic distribution group.

Returns:

See Also:



5301
5302
5303
5304
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5301

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

#list_agent_statuses(params = {}) ⇒ Types::ListAgentStatusResponse

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

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"

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:



5359
5360
5361
5362
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5359

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



5411
5412
5413
5414
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5411

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



5470
5471
5472
5473
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5470

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



5526
5527
5528
5529
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5526

def list_contact_flow_modules(params = {}, options = {})
  req = build_request(:list_contact_flow_modules, 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
  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"
resp.contact_flow_summary_list[0].contact_flow_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.

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



5595
5596
5597
5598
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5595

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.

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, NUMBER, STRING, DATE, EMAIL
  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 "APPROVED", "REJECTED"
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:



5666
5667
5668
5669
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5666

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



5728
5729
5730
5731
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5728

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



5787
5788
5789
5790
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5787

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



5840
5841
5842
5843
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5840

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



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

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



5960
5961
5962
5963
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5960

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, CASES_DOMAIN
  next_token: "NextToken",
  max_results: 1,
})

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", "CASES_DOMAIN"
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"
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.

Returns:

See Also:



6020
6021
6022
6023
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6020

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:



6072
6073
6074
6075
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6072

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:



6131
6132
6133
6134
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6131

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.

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

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



6209
6210
6211
6212
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6209

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.

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",
  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
  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"
resp.list_phone_numbers_summary_list[0].target_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 numbers are claimed to. If TargetArn input is 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.

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



6285
6286
6287
6288
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6285

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



6332
6333
6334
6335
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6332

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

#list_queue_quick_connects(params = {}) ⇒ Types::ListQueueQuickConnectsResponse

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

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"

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:



6391
6392
6393
6394
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6391

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