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.

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

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

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

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



335
336
337
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 335

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 instanceId in the ARN of the instance.

  • :origin (required, String)

    The domain to add to your allow list.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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",
    lex_region: "LexRegion",
  },
  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 instanceId in the 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:



406
407
408
409
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 406

def associate_bot(params = {}, options = {})
  req = build_request(:associate_bot, 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
  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 instanceId in the ARN of the instance.

  • :resource_type (required, String)

    A valid resource type.

  • :storage_config (required, Types::InstanceStorageConfig)

    A valid storage type.

Returns:

See Also:



479
480
481
482
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 479

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 instanceId in the 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:



511
512
513
514
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 511

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :lex_bot (required, Types::LexBot)

    The Amazon Lex bot to associate with the instance.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



545
546
547
548
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 545

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



579
580
581
582
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 579

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 instanceId in the 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:



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

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 instanceId in the ARN of the instance.

  • :key (required, String)

    A valid security key in PEM format.

Returns:

See Also:



655
656
657
658
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 655

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

Returns:

See Also:



711
712
713
714
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 711

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 contact flow for the specified Amazon Connect instance.

You can also create and update contact 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 contact flow.

  • :type (required, String)

    The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide.

  • :description (String)

    The description of the contact flow.

  • :content (required, String)

    The content of the contact flow.

  • :tags (Hash<String,String>)

    One or more tags.

Returns:

See Also:



776
777
778
779
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 776

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 contact 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 instanceId in the ARN of the instance.

  • :name (required, String)

    The name of the contact flow module.

  • :description (String)

    The description of the contact flow module.

  • :content (required, String)

    The content of the contact flow module.

  • :tags (Hash<String,String>)

    The tags used to organize, track, or control access for this resource.

  • :client_token (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

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

Returns:

See Also:



834
835
836
837
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 834

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 instanceId in the 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.

Returns:

See Also:



903
904
905
906
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 903

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:



966
967
968
969
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 966

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

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

Creates an AWS 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
  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 instanceId in the 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.

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

Returns:

See Also:



1026
1027
1028
1029
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1026

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.

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 instanceId in the 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.

Returns:

See Also:



1095
1096
1097
1098
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1095

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 instanceId in the 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.

Returns:

See Also:



1157
1158
1159
1160
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1157

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 instanceId in the 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.

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

    One or more tags.

Returns:

See Also:



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

def create_routing_profile(params = {}, options = {})
  req = build_request(:create_routing_profile, 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: "SecurityProfileName", # required
  description: "SecurityProfileDescription",
  permissions: ["SecurityProfilePermission"],
  instance_id: "InstanceId", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

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.

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :tags (Hash<String,String>)

    The tags used to organize, track, or control access for this resource.

Returns:

See Also:



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

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

Returns:

See Also:



1329
1330
1331
1332
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1329

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",
  },
  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 instanceId in the ARN of the instance.

  • :tags (Hash<String,String>)

    One or more tags.

Returns:

See Also:



1430
1431
1432
1433
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1430

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

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 instanceId in the ARN of the instance.

Returns:

See Also:



1471
1472
1473
1474
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1471

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

#delete_contact_flow(params = {}) ⇒ Struct

Deletes a contact 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 instanceId in the ARN of the instance.

  • :contact_flow_id (required, String)

    The identifier of the contact flow.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1498
1499
1500
1501
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1498

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 contact 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 instanceId in the ARN of the instance.

  • :contact_flow_module_id (required, String)

    The identifier of the contact flow module.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1525
1526
1527
1528
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1525

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 instanceId in the 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:



1555
1556
1557
1558
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1555

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 instanceId in the ARN of the instance.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

#delete_integration_association(params = {}) ⇒ Struct

Deletes an AWS 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 instanceId in the ARN of the instance.

  • :integration_association_id (required, String)

    The identifier for the integration association.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1616
1617
1618
1619
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1616

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 instanceId in the ARN of the instance.

  • :quick_connect_id (required, String)

    The identifier for the quick connect.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1643
1644
1645
1646
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1643

def delete_quick_connect(params = {}, options = {})
  req = build_request(:delete_quick_connect, 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 instanceId in the ARN of the instance.

  • :security_profile_id (required, String)

    The identifier for the security profle.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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



1704
1705
1706
1707
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1704

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 instanceId in the ARN of the instance.

  • :user_id (required, String)

    The identifier of the user.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1739
1740
1741
1742
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1739

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 instanceId in the ARN of the instance.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1767
1768
1769
1770
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1767

def delete_user_hierarchy_group(params = {}, options = {})
  req = build_request(:delete_user_hierarchy_group, 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 instanceId in the ARN of the instance.

  • :agent_status_id (required, String)

    The identifier for the agent status.

Returns:

See Also:



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

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.

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

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :contact_id (required, String)

    The identifier of the contact.

Returns:

See Also:



1865
1866
1867
1868
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1865

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

You can also create and update contact 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 contact flow.

Returns:

See Also:



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

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 contact 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 instanceId in the ARN of the instance.

  • :contact_flow_module_id (required, String)

    The identifier of the contact flow module.

Returns:

See Also:



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

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 instanceId in the ARN of the instance.

  • :hours_of_operation_id (required, String)

    The identifier for the hours of operation.

Returns:

See Also:



2001
2002
2003
2004
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2001

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 instanceId in the ARN of the instance.

Returns:

See Also:



2049
2050
2051
2052
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2049

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

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"
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 instanceId in the ARN of the instance.

  • :attribute_type (required, String)

    The type of attribute.

Returns:

See Also:



2086
2087
2088
2089
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2086

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

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 instanceId in the 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:



2139
2140
2141
2142
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2139

def describe_instance_storage_config(params = {}, options = {})
  req = build_request(:describe_instance_storage_config, 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 instanceId in the ARN of the instance.

  • :queue_id (required, String)

    The identifier for the queue.

Returns:

See Also:



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

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 instanceId in the ARN of the instance.

  • :quick_connect_id (required, String)

    The identifier for the quick connect.

Returns:

See Also:



2230
2231
2232
2233
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2230

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

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :routing_profile_id (required, String)

    The identifier of the routing profile.

Returns:

See Also:



2273
2274
2275
2276
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2273

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

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 instanceId in the ARN of the instance.

Returns:

See Also:



2315
2316
2317
2318
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2315

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

#describe_user(params = {}) ⇒ Types::DescribeUserResponse

Describes the specified user account. You can find the instance ID in the 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.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 instanceId in the ARN of the instance.

Returns:

See Also:



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

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

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 instanceId in the ARN of the instance.

Returns:

See Also:



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

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 instanceId in the ARN of the instance.

Returns:

See Also:



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

def describe_user_hierarchy_structure(params = {}, options = {})
  req = build_request(:describe_user_hierarchy_structure, 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 instanceId in the ARN of the instance.

  • :origin (required, String)

    The domain URL of the integrated application.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2492
2493
2494
2495
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2492

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",
    lex_region: "LexRegion",
  },
  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 instanceId in the 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:



2532
2533
2534
2535
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2532

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

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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



2568
2569
2570
2571
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2568

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 contact 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 instanceId in the 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:



2600
2601
2602
2603
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2600

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 instanceId in the 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 Region in which the Amazon Lex bot has been created.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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



2669
2670
2671
2672
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2669

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 instanceId in the 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:



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

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 instanceId in the 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:



2736
2737
2738
2739
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2736

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



2769
2770
2771
2772
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2769

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
  },
  groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
  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,
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

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

Returns:

See Also:



2973
2974
2975
2976
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2973

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

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Returns:

See Also:



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

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
  },
  groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
  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].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 instanceId in the 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:



3303
3304
3305
3306
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3303

def get_metric_data(params = {}, options = {})
  req = build_request(:get_metric_data, 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 instanceId in the ARN of the instance.

  • :next_token (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per page.

  • :agent_status_types (Array<String>)

    Available agent status types.

Returns:

See Also:



3357
3358
3359
3360
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3357

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 instanceId in the ARN of the instance.

  • :next_token (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per page.

Returns:

See Also:



3405
3406
3407
3408
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3405

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.

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 instanceId in the ARN of the instance.

  • :next_token (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per page.

  • :lex_version (required, String)

    The version of Amazon Lex or Amazon Lex V2.

Returns:

See Also:



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

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 contact 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 instanceId in the ARN of the instance.

  • :next_token (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per page.

  • :contact_flow_module_state (String)

    The state of the contact flow module.

Returns:

See Also:



3511
3512
3513
3514
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3511

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 contact flows for the specified Amazon Connect instance.

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

For more information about contact flows, see Contact 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 instanceId in the ARN of the instance.

  • :contact_flow_types (Array<String>)

    The type of contact 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.

Returns:

See Also:



3575
3576
3577
3578
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3575

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

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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



3634
3635
3636
3637
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3634

def list_contact_references(params = {}, options = {})
  req = build_request(:list_contact_references, 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 instanceId in the ARN of the instance.

  • :next_token (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per page.

Returns:

See Also:



3688
3689
3690
3691
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3688

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"
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 instanceId in the ARN of the instance.

  • :next_token (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per page.

Returns:

See Also:



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

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
  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 instanceId in the 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:



3800
3801
3802
3803
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3800

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:



3853
3854
3855
3856
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3853

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 AWS 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
  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"
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 instanceId in the 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:



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

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 contact 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 instanceId in the ARN of the instance.

  • :next_token (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per page.

Returns:

See Also:



3957
3958
3959
3960
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3957

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 bots currently 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_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 instanceId in the ARN of the instance.

  • :next_token (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per page. If no value is specified, the default is 10.

Returns:

See Also:



4007
4008
4009
4010
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4007

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 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 instanceId in the 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.

Returns:

See Also:



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

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

Returns:

See Also:



4118
4119
4120
4121
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4118

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 instanceId in the ARN of the instance.

  • :queue_id (required, String)

    The identifier for the queue.

  • :next_token (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per page.

Returns:

See Also:



4172
4173
4174
4175
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4172

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

#list_queues(params = {}) ⇒ Types::ListQueuesResponse

Provides information about the queues for the specified Amazon Connect instance.

If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.

For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.

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

Examples:

Request syntax with placeholder values


resp = client.list_queues({
  instance_id: "InstanceId", # required
  queue_types: ["STANDARD"], # accepts STANDARD, AGENT
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.queue_summary_list #=> Array
resp.queue_summary_list[0].id #=> String
resp.queue_summary_list[0].arn #=> String
resp.queue_summary_list[0].name #=> String
resp.queue_summary_list[0].queue_type #=> String, one of "STANDARD", "AGENT"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :queue_types (Array<String>)

    The type of queue.

  • :next_token (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per page.

Returns:

See Also:



4236
4237
4238
4239
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4236

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

#list_quick_connects(params = {}) ⇒ Types::ListQuickConnectsResponse

Provides information about the quick connects for the specified Amazon Connect instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_quick_connects({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
  quick_connect_types: ["USER"], # accepts USER, QUEUE, PHONE_NUMBER
})

Response structure


resp.quick_connect_summary_list #=> Array
resp.quick_connect_summary_list[0].id #=> String
resp.quick_connect_summary_list[0].arn #=> String
resp.quick_connect_summary_list[0].name #=> String
resp.quick_connect_summary_list[0].quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

  • :quick_connect_types (Array<String>)

    The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

Returns:

See Also:



4291
4292
4293
4294
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4291

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

#list_routing_profile_queues(params = {}) ⇒ Types::ListRoutingProfileQueuesResponse

Lists the queues associated with a routing profile.

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

Examples:

Request syntax with placeholder values


resp = client.list_routing_profile_queues({
  instance_id: "InstanceId", # required
  routing_profile_id: "RoutingProfileId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.routing_profile_queue_config_summary_list #=> Array
resp.routing_profile_queue_config_summary_list[0].queue_id #=> String
resp.routing_profile_queue_config_summary_list[0].queue_arn #=> String
resp.routing_profile_queue_config_summary_list[0].queue_name #=> String
resp.routing_profile_queue_config_summary_list[0].priority #=> Integer
resp.routing_profile_queue_config_summary_list[0].delay #=> Integer
resp.routing_profile_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT", "TASK"

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :routing_profile_id (required, String)

    The identifier of the routing profile.

  • :next_token (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per page.

Returns:

See Also:



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

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

#list_routing_profiles(params = {}) ⇒ Types::ListRoutingProfilesResponse

Provides summary information about the routing profiles for the specified Amazon Connect instance.

For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.

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

Examples:

Request syntax with placeholder values


resp = client.list_routing_profiles({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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



4400
4401
4402
4403
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4400

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

#list_security_keys(params = {}) ⇒ Types::ListSecurityKeysResponse

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

Returns a paginated list of all security keys associated with the instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_security_keys({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.security_keys #=> Array
resp.security_keys[0].association_id #=> String
resp.security_keys[0].key #=> String
resp.security_keys[0].creation_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :next_token (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per page.

Returns:

See Also:



4450
4451
4452
4453
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4450

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

#list_security_profile_permissions(params = {}) ⇒ Types::ListSecurityProfilePermissionsResponse

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

Lists the permissions granted to a security profile.

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

Examples:

Request syntax with placeholder values


resp = client.list_security_profile_permissions({
  security_profile_id: "SecurityProfileId", # required
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


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

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 instanceId in the ARN of the instance.

  • :next_token (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per page.

Returns:

See Also:



4501
4502
4503
4504
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4501

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

#list_security_profiles(params = {}) ⇒ Types::ListSecurityProfilesResponse

Provides summary information about the security profiles for the specified Amazon Connect instance.

For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.

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

Examples:

Request syntax with placeholder values


resp = client.list_security_profiles({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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



4555
4556
4557
4558
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4555

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

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

Lists the tags for the specified resource.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



4591
4592
4593
4594
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4591

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

#list_use_cases(params = {}) ⇒ Types::ListUseCasesResponse

Lists the use cases for the integration association.

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

Examples:

Request syntax with placeholder values


resp = client.list_use_cases({
  instance_id: "InstanceId", # required
  integration_association_id: "IntegrationAssociationId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.use_case_summary_list #=> Array
resp.use_case_summary_list[0].use_case_id #=> String
resp.use_case_summary_list[0].use_case_arn #=> String
resp.use_case_summary_list[0].use_case_type #=> String, one of "RULES_EVALUATION", "CONNECT_CAMPAIGNS"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :integration_association_id (required, String)

    The identifier for the integration association.

  • :next_token (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer)

    The maximum number of results to return per page.

Returns:

See Also:



4641
4642
4643
4644
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4641

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

#list_user_hierarchy_groups(params = {}) ⇒ Types::ListUserHierarchyGroupsResponse

Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

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

Examples:

Request syntax with placeholder values


resp = client.list_user_hierarchy_groups({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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



4695
4696
4697
4698
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4695

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

#list_users(params = {}) ⇒ Types::ListUsersResponse

Provides summary information about the users for the specified Amazon Connect instance.

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

Examples:

Request syntax with placeholder values


resp = client.list_users({
  instance_id: "InstanceId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.user_summary_list #=> Array
resp.user_summary_list[0].id #=> String
resp.user_summary_list[0].arn #=> String
resp.user_summary_list[0].username #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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



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

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

#resume_contact_recording(params = {}) ⇒ Struct

When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.

Only voice recordings are supported at this time.

Examples:

Request syntax with placeholder values


resp = client.resume_contact_recording({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  initial_contact_id: "ContactId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :contact_id (required, String)

    The identifier of the contact.

  • :initial_contact_id (required, String)

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4777
4778
4779
4780
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4777

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

#start_chat_contact(params = {}) ⇒ Types::StartChatContactResponse

Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

A 429 error occurs in two situations:

  • API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.

  • The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

For more information about chat, see Chat in the Amazon Connect Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.start_chat_contact({
  instance_id: "InstanceId", # required
  contact_flow_id: "ContactFlowId", # required
  attributes: {
    "AttributeName" => "AttributeValue",
  },
  participant_details: { # required
    display_name: "DisplayName", # required
  },
  initial_message: {
    content_type: "ChatContentType", # required
    content: "ChatContent", # required
  },
  client_token: "ClientToken",
})

Response structure


resp.contact_id #=> String
resp.participant_id #=> String
resp.participant_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :contact_flow_id (required, String)

    The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

  • :attributes (Hash<String,String>)

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

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

  • :participant_details (required, Types::ParticipantDetails)

    Information identifying the participant.

  • :initial_message (Types::ChatMessage)

    The initial message to be sent to the newly created chat.

  • :client_token (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

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

Returns:

See Also:



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

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

#start_contact_recording(params = {}) ⇒ Struct

Starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

You can use this API to override the recording behavior configured in the Set recording behavior block.

Only voice recordings are supported at this time.

Examples:

Request syntax with placeholder values


resp = client.start_contact_recording({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  initial_contact_id: "ContactId", # required
  voice_recording_configuration: { # required
    voice_recording_track: "FROM_AGENT", # accepts FROM_AGENT, TO_AGENT, ALL
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :contact_id (required, String)

    The identifier of the contact.

  • :initial_contact_id (required, String)

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

  • :voice_recording_configuration (required, Types::VoiceRecordingConfiguration)

    The person being recorded.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4933
4934
4935
4936
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4933

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

#start_contact_streaming(params = {}) ⇒ Types::StartContactStreamingResponse

Initiates real-time message streaming for a new chat contact.

For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.start_contact_streaming({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  chat_streaming_configuration: { # required
    streaming_endpoint_arn: "ChatStreamingEndpointARN", # required
  },
  client_token: "ClientToken", # required
})

Response structure


resp.streaming_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :contact_id (required, String)

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

  • :chat_streaming_configuration (required, Types::ChatStreamingConfiguration)

    The streaming configuration, such as the Amazon SNS streaming endpoint.

  • :client_token (required, String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

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

Returns:

See Also:



4990
4991
4992
4993
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4990

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

#start_outbound_voice_contact(params = {}) ⇒ Types::StartOutboundVoiceContactResponse

Places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in ContactFlowId).

Agents do not initiate the outbound API, which means that they do not dial the contact. If the contact flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.

There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.start_outbound_voice_contact({
  destination_phone_number: "PhoneNumber", # required
  contact_flow_id: "ContactFlowId", # required
  instance_id: "InstanceId", # required
  client_token: "ClientToken",
  source_phone_number: "PhoneNumber",
  queue_id: "QueueId",
  attributes: {
    "AttributeName" => "AttributeValue",
  },
  answer_machine_detection_config: {
    enable_answer_machine_detection: false,
    await_answer_machine_prompt: false,
  },
  campaign_id: "CampaignId",
  traffic_type: "GENERAL", # accepts GENERAL, CAMPAIGN
})

Response structure


resp.contact_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :destination_phone_number (required, String)

    The phone number of the customer, in E.164 format.

  • :contact_flow_id (required, String)

    The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the 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. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

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

  • :source_phone_number (String)

    The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

  • :queue_id (String)

    The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.

  • :attributes (Hash<String,String>)

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

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

  • :answer_machine_detection_config (Types::AnswerMachineDetectionConfig)

    Configuration of the answering machine detection for this outbound call.

  • :campaign_id (String)

    The campaign identifier of the outbound communication.

  • :traffic_type (String)

    Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.

Returns:

See Also:



5115
5116
5117
5118
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5115

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

#start_task_contact(params = {}) ⇒ Types::StartTaskContactResponse

Initiates a contact flow to start a new task.

Examples:

Request syntax with placeholder values


resp = client.start_task_contact({
  instance_id: "InstanceId", # required
  previous_contact_id: "ContactId",
  contact_flow_id: "ContactFlowId", # required
  attributes: {
    "AttributeName" => "AttributeValue",
  },
  name: "Name", # required
  references: {
    "ReferenceKey" => {
      value: "ReferenceValue", # required
      type: "URL", # required, accepts URL, ATTACHMENT
    },
  },
  description: "Description",
  client_token: "ClientToken",
  scheduled_time: Time.now,
})

Response structure


resp.contact_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :previous_contact_id (String)

    The identifier of the previous chat, voice, or task contact.

  • :contact_flow_id (required, String)

    The identifier of the contact flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

  • :attributes (Hash<String,String>)

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

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

  • :name (required, String)

    The name of a task that is shown to an agent in the Contact Control Panel (CCP).

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

    A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

  • :description (String)

    A description of the task that is shown to an agent in the Contact Control Panel (CCP).

  • :client_token (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

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

  • :scheduled_time (Time, DateTime, Date, Integer, String)

    The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

Returns:

See Also:



5205
5206
5207
5208
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5205

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

#stop_contact(params = {}) ⇒ Struct

Ends the specified contact.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :contact_id (required, String)

    The ID of the contact.

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



5232
5233
5234
5235
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5232

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

#stop_contact_recording(params = {}) ⇒ Struct

Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.

Only voice recordings are supported at this time.

Examples:

Request syntax with placeholder values


resp = client.stop_contact_recording({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  initial_contact_id: "ContactId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :contact_id (required, String)

    The identifier of the contact.

  • :initial_contact_id (required, String)

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



5272
5273
5274
5275
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5272

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

#stop_contact_streaming(params = {}) ⇒ Struct

Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.

Examples:

Request syntax with placeholder values


resp = client.stop_contact_streaming({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  streaming_id: "StreamingId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :contact_id (required, String)

    The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.

  • :streaming_id (required, String)

    The identifier of the streaming configuration enabled.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



5309
5310
5311
5312
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5309

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

#suspend_contact_recording(params = {}) ⇒ Struct

When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.

The period of time that the recording is suspended is filled with silence in the final recording.

Only voice recordings are supported at this time.

Examples:

Request syntax with placeholder values


resp = client.suspend_contact_recording({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  initial_contact_id: "ContactId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :contact_id (required, String)

    The identifier of the contact.

  • :initial_contact_id (required, String)

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

#tag_resource(params = {}) ⇒ Struct

Adds the specified tags to the specified resource.

The supported resource types are users, routing profiles, queues, quick connects, contact flows, agent status, and hours of operation.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource.

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

    One or more tags. For example, \{ "tags": {"key1":"value1", "key2":"value2"\} \}.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



5388
5389
5390
5391
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5388

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

#untag_resource(params = {}) ⇒ Struct

Removes the specified tags from the specified resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource.

  • :tag_keys (required, Array<String>)

    The tag keys.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



5414
5415
5416
5417
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5414

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

#update_agent_status(params = {}) ⇒ Struct

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

Updates agent status.

Examples:

Request syntax with placeholder values


resp = client.update_agent_status({
  instance_id: "InstanceId", # required
  agent_status_id: "AgentStatusId", # required
  name: "AgentStatusName",
  description: "UpdateAgentStatusDescription",
  state: "ENABLED", # accepts ENABLED, DISABLED
  display_order: 1,
  reset_order_number: false,
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :agent_status_id (required, String)

    The identifier of the agent status.

  • :name (String)

    The name of the agent status.

  • :description (String)

    The description of the agent status.

  • :state (String)

    The state of the agent status.

  • :display_order (Integer)

    The display order of the agent status.

  • :reset_order_number (Boolean)

    A number indicating the reset order of the agent status.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



5464
5465
5466
5467
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5464

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

#update_contact(params = {}) ⇒ Struct

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

Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

You can add or update user-defined contact information for both ongoing and completed contacts.

Examples:

Request syntax with placeholder values


resp = client.update_contact({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  name: "Name",
  description: "Description",
  references: {
    "ReferenceKey" => {
      value: "ReferenceValue", # required
      type: "URL", # required, accepts URL, ATTACHMENT
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :contact_id (required, String)

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

  • :name (String)

    The name of the contact.

  • :description (String)

    The description of the contact.

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

    A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

#update_contact_attributes(params = {}) ⇒ Struct

Creates or updates user-defined contact attributes associated with the specified contact.

You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about CTR retention and the maximum size of the CTR attributes section, see Feature specifications in the Amazon Connect Administrator Guide.

Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, which was September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.

Examples:

Request syntax with placeholder values


resp = client.update_contact_attributes({
  initial_contact_id: "ContactId", # required
  instance_id: "InstanceId", # required
  attributes: { # required
    "AttributeName" => "AttributeValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :initial_contact_id (required, String)

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

    The Amazon Connect attributes. These attributes can be accessed in contact flows just like any other contact attributes.

    You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



5586
5587
5588
5589
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5586

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

#update_contact_flow_content(params = {}) ⇒ Struct

Updates the specified contact flow.

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

Examples:

Request syntax with placeholder values


resp = client.update_contact_flow_content({
  instance_id: "InstanceId", # required
  contact_flow_id: "ContactFlowId", # required
  content: "ContactFlowContent", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance.

  • :contact_flow_id (required, String)

    The identifier of the contact flow.

  • :content (required, String)

    The JSON string that represents contact flow’s content. For an example, see Example contact flow in Amazon Connect Flow language in the Amazon Connect Administrator Guide.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



5629
5630
5631
5632
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5629

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

#update_contact_flow_metadata(params = {}) ⇒ Struct

Updates metadata about specified contact flow.

Examples:

Request syntax with placeholder values


resp = client.({
  instance_id: "InstanceId", # required
  contact_flow_id: "ContactFlowId", # required
  name: "ContactFlowName",
  description: "ContactFlowDescription",
  contact_flow_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :contact_flow_id (required, String)

    The identifier of the contact flow.

  • :name (String)

    TThe name of the contact flow.

  • :description (String)

    The description of the contact flow.

  • :contact_flow_state (String)

    The state of contact flow.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

#update_contact_flow_module_content(params = {}) ⇒ Struct

Updates specified contact flow module for the specified Amazon Connect instance.

Examples:

Request syntax with placeholder values


resp = client.update_contact_flow_module_content({
  instance_id: "InstanceId", # required
  contact_flow_module_id: "ContactFlowModuleId", # required
  content: "ContactFlowModuleContent", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :contact_flow_module_id (required, String)

    The identifier of the contact flow module.

  • :content (required, String)

    The content of the contact flow module.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



5700
5701
5702
5703
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5700

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

#update_contact_flow_module_metadata(params = {}) ⇒ Struct

Updates metadata about specified contact flow module.

Examples:

Request syntax with placeholder values


resp = client.({
  instance_id: "InstanceId", # required
  contact_flow_module_id: "ContactFlowModuleId", # required
  name: "ContactFlowModuleName",
  description: "ContactFlowModuleDescription",
  state: "ACTIVE", # accepts ACTIVE, ARCHIVED
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :contact_flow_module_id (required, String)

    The identifier of the contact flow module.

  • :name (String)

    The name of the contact flow module.

  • :description (String)

    The description of the contact flow module.

  • :state (String)

    The state of contact flow module.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



5739
5740
5741
5742
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5739

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

#update_contact_flow_name(params = {}) ⇒ Struct

The name of the contact flow.

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

Examples:

Request syntax with placeholder values


resp = client.update_contact_flow_name({
  instance_id: "InstanceId", # required
  contact_flow_id: "ContactFlowId", # required
  name: "ContactFlowName",
  description: "ContactFlowDescription",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance.

  • :contact_flow_id (required, String)

    The identifier of the contact flow.

  • :name (String)

    The name of the contact flow.

  • :description (String)

    The description of the contact flow.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



5780
5781
5782
5783
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5780

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

#update_contact_schedule(params = {}) ⇒ Struct

Updates the scheduled time of a task contact that is already scheduled.

Examples:

Request syntax with placeholder values


resp = client.update_contact_schedule({
  instance_id: "InstanceId", # required
  contact_id: "ContactId", # required
  scheduled_time: Time.now, # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :contact_id (required, String)

    The identifier of the contact.

  • :scheduled_time (required, Time, DateTime, Date, Integer, String)

    The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



5814
5815
5816
5817
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5814

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

#update_hours_of_operation(params = {}) ⇒ Struct

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

Updates the hours of operation.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :hours_of_operation_id (required, String)

    The identifier of the hours of operation.

  • :name (String)

    The name of the hours of operation.

  • :description (String)

    The description of the hours of operation.

  • :time_zone (String)

    The time zone of the hours of operation.

  • :config (Array<Types::HoursOfOperationConfig>)

    Configuration information of the hours of operation.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



5872
5873
5874
5875
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5872

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

#update_instance_attribute(params = {}) ⇒ Struct

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

Updates the value for the specified attribute type.

Examples:

Request syntax with placeholder values


resp = client.update_instance_attribute({
  instance_id: "InstanceId", # required
  attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA
  value: "InstanceAttributeValue", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :attribute_type (required, String)

    The type of attribute.

    Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact AWS Support for allowlisting.

  • :value (required, String)

    The value for the attribute. Maximum character limit is 100.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



5911
5912
5913
5914
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5911

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

#update_instance_storage_config(params = {}) ⇒ Struct

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

Updates an existing configuration for a resource type. This API is idempotent.

Examples:

Request syntax with placeholder values


resp = client.update_instance_storage_config({
  instance_id: "InstanceId", # required
  association_id: "AssociationId", # required
  resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
  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
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :association_id (required, String)

    The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

  • :resource_type (required, String)

    A valid resource type.

  • :storage_config (required, Types::InstanceStorageConfig)

    The storage configuration for the instance.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



5976
5977
5978
5979
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5976

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

#update_queue_hours_of_operation(params = {}) ⇒ Struct

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

Updates the hours of operation for the specified queue.

Examples:

Request syntax with placeholder values


resp = client.update_queue_hours_of_operation({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  hours_of_operation_id: "HoursOfOperationId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :queue_id (required, String)

    The identifier for the queue.

  • :hours_of_operation_id (required, String)

    The identifier for the hours of operation.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



6010
6011
6012
6013
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6010

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

#update_queue_max_contacts(params = {}) ⇒ Struct

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

Updates the maximum number of contacts allowed in a queue before it is considered full.

Examples:

Request syntax with placeholder values


resp = client.update_queue_max_contacts({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  max_contacts: 1,
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :queue_id (required, String)

    The identifier for the queue.

  • :max_contacts (Integer)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



6046
6047
6048
6049
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6046

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

#update_queue_name(params = {}) ⇒ Struct

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

Updates the name and description of a queue. At least Name or Description must be provided.

Examples:

Request syntax with placeholder values


resp = client.update_queue_name({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  name: "CommonNameLength127",
  description: "QueueDescription",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :queue_id (required, String)

    The identifier for the queue.

  • :name (String)

    The name of the queue.

  • :description (String)

    The description of the queue.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



6085
6086
6087
6088
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6085

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

#update_queue_outbound_caller_config(params = {}) ⇒ Struct

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

Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.

Examples:

Request syntax with placeholder values


resp = client.update_queue_outbound_caller_config({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  outbound_caller_config: { # required
    outbound_caller_id_name: "OutboundCallerIdName",
    outbound_caller_id_number_id: "PhoneNumberId",
    outbound_flow_id: "ContactFlowId",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :queue_id (required, String)

    The identifier for the queue.

  • :outbound_caller_config (required, Types::OutboundCallerConfig)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



6124
6125
6126
6127
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6124

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

#update_queue_status(params = {}) ⇒ Struct

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

Updates the status of the queue.

Examples:

Request syntax with placeholder values


resp = client.update_queue_status({
  instance_id: "InstanceId", # required
  queue_id: "QueueId", # required
  status: "ENABLED", # required, accepts ENABLED, DISABLED
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :queue_id (required, String)

    The identifier for the queue.

  • :status (required, String)

    The status of the queue.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



6158
6159
6160
6161
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6158

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

#update_quick_connect_config(params = {}) ⇒ Struct

Updates the configuration settings for the specified quick connect.

Examples:

Request syntax with placeholder values


resp = client.update_quick_connect_config({
  instance_id: "InstanceId", # required
  quick_connect_id: "QuickConnectId", # required
  quick_connect_config: { # required
    quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER
    user_config: {
      user_id: "UserId", # required
      contact_flow_id: "ContactFlowId", # required
    },
    queue_config: {
      queue_id: "QueueId", # required
      contact_flow_id: "ContactFlowId", # required
    },
    phone_config: {
      phone_number: "PhoneNumber", # required
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :quick_connect_id (required, String)

    The identifier for the quick connect.

  • :quick_connect_config (required, Types::QuickConnectConfig)

    Information about the configuration settings for the quick connect.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



6202
6203
6204
6205
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6202

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

#update_quick_connect_name(params = {}) ⇒ Struct

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

Examples:

Request syntax with placeholder values


resp = client.update_quick_connect_name({
  instance_id: "InstanceId", # required
  quick_connect_id: "QuickConnectId", # required
  name: "QuickConnectName",
  description: "UpdateQuickConnectDescription",
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :quick_connect_id (required, String)

    The identifier for the quick connect.

  • :name (String)

    The name of the quick connect.

  • :description (String)

    The description of the quick connect.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



6239
6240
6241
6242
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6239

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

#update_routing_profile_concurrency(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.update_routing_profile_concurrency({
  instance_id: "InstanceId", # required
  routing_profile_id: "RoutingProfileId", # required
  media_concurrencies: [ # required
    {
      channel: "VOICE", # required, accepts VOICE, CHAT, TASK
      concurrency: 1, # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String)

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • :routing_profile_id (required, String)

    The identifier of the routing profile.

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

    The channels that agents can handle in the Contact Control Panel (CCP).

Returns:

  • (Struct)

    Returns an empty response.

See Also:



6277
6278
6279
6280
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6277

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

#update_routing_profile_default_outbound_queue(params = {}) ⇒ Struct

Updates the default outbound queue of a routing profile.

Examples:

Request syntax with placeholder values


resp = client.update_routing_profile_default_outbound_queue({
  instance_id: "InstanceId", # required
  routing_profile_id: "RoutingProfileId", # required
  default_outbound_queue_id: "QueueId"