class Aws::Connect::Client
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See {#initialize} for a full list of supported configuration options.
Attributes
@api private
Public Class Methods
@api private
# File lib/aws-sdk-connect/client.rb, line 5828 def errors_module Errors end
@overload initialize(options)
@param [Hash] options @option options [required, Aws::CredentialProvider] :credentials 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. @option options [required, String] :region The AWS region to connect to. The configured `:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations: * `Aws.config[:region]` * `ENV['AWS_REGION']` * `ENV['AMAZON_REGION']` * `ENV['AWS_DEFAULT_REGION']` * `~/.aws/credentials` * `~/.aws/config` @option options [String] :access_key_id @option options [Boolean] :active_endpoint_cache (false) When set to `true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`. @option options [Boolean] :adaptive_retry_wait_to_fill (true) Used only in `adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping. @option options [Boolean] :client_side_monitoring (false) When `true`, client-side metrics will be collected for all API requests from this client. @option options [String] :client_side_monitoring_client_id ("") Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string. @option options [String] :client_side_monitoring_host ("127.0.0.1") Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Integer] :client_side_monitoring_port (31000) Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher. @option options [Boolean] :convert_params (true) When `true`, an attempt is made to coerce request parameters into the required types. @option options [Boolean] :correct_clock_skew (true) Used only in `standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. @option options [Boolean] :disable_host_prefix_injection (false) Set to true to disable SDK automatically adding host prefix to default service endpoint when available. @option options [String] :endpoint 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. @option options [Integer] :endpoint_cache_max_entries (1000) Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. @option options [Integer] :endpoint_cache_max_threads (10) Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. @option options [Integer] :endpoint_cache_poll_interval (60) When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. @option options [Boolean] :endpoint_discovery (false) When set to `true`, endpoint discovery will be enabled for operations when available. @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) The log formatter. @option options [Symbol] :log_level (:info) The log level to send messages to the `:logger` at. @option options [Logger] :logger The Logger instance to send log messages to. If this option is not set, logging will be disabled. @option options [Integer] :max_attempts (3) An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in `standard` and `adaptive` retry modes. @option options [String] :profile ("default") Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. @option options [Proc] :retry_backoff A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the `legacy` retry mode. @option options [Float] :retry_base_delay (0.3) The base delay in seconds used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [Symbol] :retry_jitter (:none) A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the `legacy` retry mode. @see https://www.awsarchitectureblog.com/2015/03/backoff.html @option options [Integer] :retry_limit (3) The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the `legacy` retry mode. @option options [Integer] :retry_max_delay (0) The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [String] :retry_mode ("legacy") Specifies which retry algorithm to use. Values are: * `legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided. * `standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make. * `adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future. @option options [String] :secret_access_key @option options [String] :session_token @option options [Boolean] :stub_responses (false) Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling {ClientStubs#stub_responses}. See {ClientStubs} for more information. ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled. @option options [Boolean] :validate_params (true) When `true`, request parameters are validated before sending the request. @option options [URI::HTTP,String] :http_proxy A proxy to send requests through. Formatted like 'http://proxy.com:123'. @option options [Float] :http_open_timeout (15) The number of seconds to wait when opening a HTTP session before raising a `Timeout::Error`. @option options [Integer] :http_read_timeout (60) The default number of seconds to wait for response data. This value can safely be set per-request on the session. @option options [Float] :http_idle_timeout (5) The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request. @option options [Float] :http_continue_timeout (1) The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to `nil` which disables this behaviour. This value can safely be set per request on the session. @option options [Boolean] :http_wire_trace (false) When `true`, HTTP debug output will be sent to the `:logger`. @option options [Boolean] :ssl_verify_peer (true) When `true`, SSL peer certificates are verified when establishing a connection. @option options [String] :ssl_ca_bundle Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available. @option options [String] :ssl_ca_directory Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
# File lib/aws-sdk-connect/client.rb, line 324 def initialize(*args) super end
Public Instance Methods
This API is in preview release for Amazon Connect
and is subject to change.
Associates an approved origin to an Amazon Connect
instance.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :origin
The domain to add to your allow list.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.associate_approved_origin({ instance_id: "InstanceId", # required origin: "Origin", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateApprovedOrigin AWS API Documentation
@overload associate_approved_origin
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 355 def associate_approved_origin(params = {}, options = {}) req = build_request(:associate_approved_origin, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [Types::LexBot] :lex_bot
Configuration information of an Amazon Lex bot.
@option params [Types::LexV2Bot] :lex_v2_bot
The Amazon Lex V2 bot to associate with the instance.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example 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", }, })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateBot AWS API Documentation
@overload associate_bot
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 395 def associate_bot(params = {}, options = {}) req = build_request(:associate_bot, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :resource_type
A valid resource type.
@option params [required, Types::InstanceStorageConfig] :storage_config
A valid storage type.
@return [Types::AssociateInstanceStorageConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::AssociateInstanceStorageConfigResponse#association_id #association_id} => String
@example 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 }, }, })
@example Response structure
resp.association_id #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateInstanceStorageConfig AWS API Documentation
@overload associate_instance_storage_config
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 468 def associate_instance_storage_config(params = {}, options = {}) req = build_request(:associate_instance_storage_config, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :function_arn
The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.associate_lambda_function({ instance_id: "InstanceId", # required function_arn: "FunctionArn", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateLambdaFunction AWS API Documentation
@overload associate_lambda_function
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 500 def associate_lambda_function(params = {}, options = {}) req = build_request(:associate_lambda_function, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, Types::LexBot] :lex_bot
The Amazon Lex bot to associate with the instance.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.associate_lex_bot({ instance_id: "InstanceId", # required lex_bot: { # required name: "BotName", lex_region: "LexRegion", }, })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateLexBot AWS API Documentation
@overload associate_lex_bot
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 534 def associate_lex_bot(params = {}, options = {}) req = build_request(:associate_lex_bot, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Associates a set of quick connects with a queue.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :queue_id
The identifier for the queue.
@option params [required, Array<String>] :quick_connect_ids
The quick connects to associate with this queue.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.associate_queue_quick_connects({ instance_id: "InstanceId", # required queue_id: "QueueId", # required quick_connect_ids: ["QuickConnectId"], # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateQueueQuickConnects AWS API Documentation
@overload associate_queue_quick_connects
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 568 def associate_queue_quick_connects(params = {}, options = {}) req = build_request(:associate_queue_quick_connects, params) req.send_request(options) end
Associates a set of queues with a routing profile.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :routing_profile_id
The identifier of the routing profile.
@option params [required, Array<Types::RoutingProfileQueueConfig>] :queue_configs
The queues to associate with this routing profile.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example 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 }, ], })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateRoutingProfileQueues AWS API Documentation
@overload associate_routing_profile_queues
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 608 def associate_routing_profile_queues(params = {}, options = {}) req = build_request(:associate_routing_profile_queues, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Associates a security key to the instance.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :key
A valid security key in PEM format.
@return [Types::AssociateSecurityKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::AssociateSecurityKeyResponse#association_id #association_id} => String
@example Request syntax with placeholder values
resp = client.associate_security_key({ instance_id: "InstanceId", # required key: "PEM", # required })
@example Response structure
resp.association_id #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateSecurityKey AWS API Documentation
@overload associate_security_key
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 644 def associate_security_key(params = {}, options = {}) req = build_request(:associate_security_key, params) req.send_request(options) end
@param params ({}) @api private
# File lib/aws-sdk-connect/client.rb, line 5803 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-connect' context[:gem_version] = '1.50.0' Seahorse::Client::Request.new(handlers, context) end
This API is in preview release for Amazon Connect
and is subject to change.
Creates an agent status for the specified Amazon Connect
instance.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :name
The name of the status.
@option params [String] :description
The description of the status.
@option params [required, String] :state
The state of the status.
@option params [Integer] :display_order
The display order of the status.
@option params [Hash<String,String>] :tags
One or more tags.
@return [Types::CreateAgentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateAgentStatusResponse#agent_status_arn #agent_status_arn} => String * {Types::CreateAgentStatusResponse#agent_status_id #agent_status_id} => String
@example 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", }, })
@example Response structure
resp.agent_status_arn #=> String resp.agent_status_id #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateAgentStatus AWS API Documentation
@overload create_agent_status
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 700 def create_agent_status(params = {}, options = {}) req = build_request(:create_agent_status, params) req.send_request(options) end
Creates a contact flow for the specified Amazon Connect
instance.
You can also create and update contact flows using the [Amazon Connect
Flow language].
[1]: docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance.
@option params [required, String] :name
The name of the contact flow.
@option params [required, String] :type
The type of the contact flow. For descriptions of the available types, see [Choose a Contact Flow Type][1] in the *Amazon Connect Administrator Guide*. [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types
@option params [String] :description
The description of the contact flow.
@option params [required, String] :content
The content of the contact flow.
@option params [Hash<String,String>] :tags
One or more tags.
@return [Types::CreateContactFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateContactFlowResponse#contact_flow_id #contact_flow_id} => String * {Types::CreateContactFlowResponse#contact_flow_arn #contact_flow_arn} => String
@example 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", }, })
@example Response structure
resp.contact_flow_id #=> String resp.contact_flow_arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlow AWS API Documentation
@overload create_contact_flow
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 765 def create_contact_flow(params = {}, options = {}) req = build_request(:create_contact_flow, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Creates hours of operation.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :name
The name of the hours of operation.
@option params [String] :description
The description of the hours of operation.
@option params [required, String] :time_zone
The time zone of the hours of operation.
@option params [required, Array<Types::HoursOfOperationConfig>] :config
Configuration information for the hours of operation: day, start time, and end time.
@option params [Hash<String,String>] :tags
One or more tags.
@return [Types::CreateHoursOfOperationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateHoursOfOperationResponse#hours_of_operation_id #hours_of_operation_id} => String * {Types::CreateHoursOfOperationResponse#hours_of_operation_arn #hours_of_operation_arn} => String
@example 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", }, })
@example Response structure
resp.hours_of_operation_id #=> String resp.hours_of_operation_arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateHoursOfOperation AWS API Documentation
@overload create_hours_of_operation
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 834 def create_hours_of_operation(params = {}, options = {}) req = build_request(:create_hours_of_operation, params) req.send_request(options) end
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.
@option params [String] :client_token
The idempotency token.
@option params [required, String] :identity_management_type
The type of identity management for your Amazon Connect users.
@option params [String] :instance_alias
The name for your instance.
@option params [String] :directory_id
The identifier for the directory.
@option params [required, Boolean] :inbound_calls_enabled
Your contact center handles incoming contacts.
@option params [required, Boolean] :outbound_calls_enabled
Your contact center allows outbound calls.
@return [Types::CreateInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateInstanceResponse#id #id} => String * {Types::CreateInstanceResponse#arn #arn} => String
@example 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 })
@example Response structure
resp.id #=> String resp.arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateInstance AWS API Documentation
@overload create_instance
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 897 def create_instance(params = {}, options = {}) req = build_request(:create_instance, params) req.send_request(options) end
Create an AppIntegration association with an Amazon Connect
instance.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :integration_type
The type of information to be ingested.
@option params [required, String] :integration_arn
The Amazon Resource Name (ARN) of the integration.
@option params [required, String] :source_application_url
The URL for the external application.
@option params [required, String] :source_application_name
The name of the external application.
@option params [required, String] :source_type
The type of the data source.
@option params [Hash<String,String>] :tags
One or more tags.
@return [Types::CreateIntegrationAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateIntegrationAssociationResponse#integration_association_id #integration_association_id} => String * {Types::CreateIntegrationAssociationResponse#integration_association_arn #integration_association_arn} => String
@example Request syntax with placeholder values
resp = client.create_integration_association({ instance_id: "InstanceId", # required integration_type: "EVENT", # required, accepts EVENT integration_arn: "ARN", # required source_application_url: "URI", # required source_application_name: "SourceApplicationName", # required source_type: "SALESFORCE", # required, accepts SALESFORCE, ZENDESK tags: { "TagKey" => "TagValue", }, })
@example Response structure
resp.integration_association_id #=> String resp.integration_association_arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateIntegrationAssociation AWS API Documentation
@overload create_integration_association
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 954 def create_integration_association(params = {}, options = {}) req = build_request(:create_integration_association, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Creates a new queue for the specified Amazon Connect
instance.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :name
The name of the queue.
@option params [String] :description
The description of the queue.
@option params [Types::OutboundCallerConfig] :outbound_caller_config
The outbound caller ID name, number, and outbound whisper flow.
@option params [required, String] :hours_of_operation_id
The identifier for the hours of operation.
@option params [Integer] :max_contacts
The maximum number of contacts that can be in the queue before it is considered full.
@option params [Array<String>] :quick_connect_ids
The quick connects available to agents who are working the queue.
@option params [Hash<String,String>] :tags
One or more tags.
@return [Types::CreateQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateQueueResponse#queue_arn #queue_arn} => String * {Types::CreateQueueResponse#queue_id #queue_id} => String
@example 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", }, })
@example Response structure
resp.queue_arn #=> String resp.queue_id #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQueue AWS API Documentation
@overload create_queue
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1023 def create_queue(params = {}, options = {}) req = build_request(:create_queue, params) req.send_request(options) end
Creates a quick connect for the specified Amazon Connect
instance.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :name
The name of the quick connect.
@option params [String] :description
The description of the quick connect.
@option params [required, Types::QuickConnectConfig] :quick_connect_config
Configuration settings for the quick connect.
@option params [Hash<String,String>] :tags
One or more tags.
@return [Types::CreateQuickConnectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateQuickConnectResponse#quick_connect_arn #quick_connect_arn} => String * {Types::CreateQuickConnectResponse#quick_connect_id #quick_connect_id} => String
@example 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", }, })
@example Response structure
resp.quick_connect_arn #=> String resp.quick_connect_id #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQuickConnect AWS API Documentation
@overload create_quick_connect
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1085 def create_quick_connect(params = {}, options = {}) req = build_request(:create_quick_connect, params) req.send_request(options) end
Creates a new routing profile.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :name
The name of the routing profile. Must not be more than 127 characters.
@option params [required, String] :description
Description of the routing profile. Must not be more than 250 characters.
@option params [required, String] :default_outbound_queue_id
The default outbound queue for the routing profile.
@option params [Array<Types::RoutingProfileQueueConfig>] :queue_configs
The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.
@option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
@option params [Hash<String,String>] :tags
One or more tags.
@return [Types::CreateRoutingProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateRoutingProfileResponse#routing_profile_arn #routing_profile_arn} => String * {Types::CreateRoutingProfileResponse#routing_profile_id #routing_profile_id} => String
@example 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", }, })
@example Response structure
resp.routing_profile_arn #=> String resp.routing_profile_id #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateRoutingProfile AWS API Documentation
@overload create_routing_profile
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1159 def create_routing_profile(params = {}, options = {}) req = build_request(:create_routing_profile, params) req.send_request(options) end
Creates a use case for an AppIntegration association.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :integration_association_id
The identifier for the AppIntegration association.
@option params [required, String] :use_case_type
The type of use case to associate to the AppIntegration association. Each AppIntegration association can have only one of each use case type.
@option params [Hash<String,String>] :tags
One or more tags.
@return [Types::CreateUseCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateUseCaseResponse#use_case_id #use_case_id} => String * {Types::CreateUseCaseResponse#use_case_arn #use_case_arn} => String
@example 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 tags: { "TagKey" => "TagValue", }, })
@example Response structure
resp.use_case_id #=> String resp.use_case_arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUseCase AWS API Documentation
@overload create_use_case
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1206 def create_use_case(params = {}, options = {}) req = build_request(:create_use_case, params) req.send_request(options) end
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*.
[1]: docs.aws.amazon.com/connect/latest/adminguide/user-management.html
@option params [required, String] :username
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\_-.\\@\]+.
@option params [String] :password
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.
@option params [Types::UserIdentityInfo] :identity_info
The information about the identity of the user.
@option params [required, Types::UserPhoneConfig] :phone_config
The phone settings for the user.
@option params [String] :directory_user_id
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.
@option params [required, Array<String>] :security_profile_ids
The identifier of the security profile for the user.
@option params [required, String] :routing_profile_id
The identifier of the routing profile for the user.
@option params [String] :hierarchy_group_id
The identifier of the hierarchy group for the user.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [Hash<String,String>] :tags
One or more tags.
@return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateUserResponse#user_id #user_id} => String * {Types::CreateUserResponse#user_arn #user_arn} => String
@example 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", }, })
@example Response structure
resp.user_id #=> String resp.user_arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUser AWS API Documentation
@overload create_user
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1307 def create_user(params = {}, options = {}) req = build_request(:create_user, params) req.send_request(options) end
Creates a new user hierarchy group.
@option params [required, String] :name
The name of the user hierarchy group. Must not be more than 100 characters.
@option params [String] :parent_group_id
The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Types::CreateUserHierarchyGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateUserHierarchyGroupResponse#hierarchy_group_id #hierarchy_group_id} => String * {Types::CreateUserHierarchyGroupResponse#hierarchy_group_arn #hierarchy_group_arn} => String
@example Request syntax with placeholder values
resp = client.create_user_hierarchy_group({ name: "HierarchyGroupName", # required parent_group_id: "HierarchyGroupId", instance_id: "InstanceId", # required })
@example Response structure
resp.hierarchy_group_id #=> String resp.hierarchy_group_arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUserHierarchyGroup AWS API Documentation
@overload create_user_hierarchy_group
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1348 def create_user_hierarchy_group(params = {}, options = {}) req = build_request(:create_user_hierarchy_group, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Deletes an hours of operation.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :hours_of_operation_id
The identifier for the hours of operation.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_hours_of_operation({ instance_id: "InstanceId", # required hours_of_operation_id: "HoursOfOperationId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteHoursOfOperation AWS API Documentation
@overload delete_hours_of_operation
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1378 def delete_hours_of_operation(params = {}, options = {}) req = build_request(:delete_hours_of_operation, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_instance({ instance_id: "InstanceId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteInstance AWS API Documentation
@overload delete_instance
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1411 def delete_instance(params = {}, options = {}) req = build_request(:delete_instance, params) req.send_request(options) end
Deletes an AppIntegration association from an Amazon Connect
instance. The association must not have any use cases associated with it.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :integration_association_id
The identifier for the AppIntegration association.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_integration_association({ instance_id: "InstanceId", # required integration_association_id: "IntegrationAssociationId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteIntegrationAssociation AWS API Documentation
@overload delete_integration_association
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1439 def delete_integration_association(params = {}, options = {}) req = build_request(:delete_integration_association, params) req.send_request(options) end
Deletes a quick connect.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :quick_connect_id
The identifier for the quick connect.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_quick_connect({ instance_id: "InstanceId", # required quick_connect_id: "QuickConnectId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteQuickConnect AWS API Documentation
@overload delete_quick_connect
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1466 def delete_quick_connect(params = {}, options = {}) req = build_request(:delete_quick_connect, params) req.send_request(options) end
Deletes a use case from an AppIntegration association.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :integration_association_id
The identifier for the AppIntegration association.
@option params [required, String] :use_case_id
The identifier for the use case.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_use_case({ instance_id: "InstanceId", # required integration_association_id: "IntegrationAssociationId", # required use_case_id: "UseCaseId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUseCase AWS API Documentation
@overload delete_use_case
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1497 def delete_use_case(params = {}, options = {}) req = build_request(:delete_use_case, params) req.send_request(options) end
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*.
[1]: docs.aws.amazon.com/connect/latest/adminguide/delete-users.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :user_id
The identifier of the user.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_user({ instance_id: "InstanceId", # required user_id: "UserId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUser AWS API Documentation
@overload delete_user
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1532 def delete_user(params = {}, options = {}) req = build_request(:delete_user, params) req.send_request(options) end
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
@option params [required, String] :hierarchy_group_id
The identifier of the hierarchy group.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_user_hierarchy_group({ hierarchy_group_id: "HierarchyGroupId", # required instance_id: "InstanceId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUserHierarchyGroup AWS API Documentation
@overload delete_user_hierarchy_group
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1560 def delete_user_hierarchy_group(params = {}, options = {}) req = build_request(:delete_user_hierarchy_group, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Describes an agent status.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :agent_status_id
The identifier for the agent status.
@return [Types::DescribeAgentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeAgentStatusResponse#agent_status #agent_status} => Types::AgentStatus
@example Request syntax with placeholder values
resp = client.describe_agent_status({ instance_id: "InstanceId", # required agent_status_id: "AgentStatusId", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeAgentStatus AWS API Documentation
@overload describe_agent_status
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1604 def describe_agent_status(params = {}, options = {}) req = build_request(:describe_agent_status, params) req.send_request(options) end
Describes the specified contact flow.
You can also create and update contact flows using the [Amazon Connect
Flow language].
[1]: docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance.
@option params [required, String] :contact_flow_id
The identifier of the contact flow.
@return [Types::DescribeContactFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeContactFlowResponse#contact_flow #contact_flow} => Types::ContactFlow
@example Request syntax with placeholder values
resp = client.describe_contact_flow({ instance_id: "InstanceId", # required contact_flow_id: "ContactFlowId", # required })
@example 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.description #=> String resp.contact_flow.content #=> String resp.contact_flow.tags #=> Hash resp.contact_flow.tags["TagKey"] #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlow AWS API Documentation
@overload describe_contact_flow
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1650 def describe_contact_flow(params = {}, options = {}) req = build_request(:describe_contact_flow, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Describes the hours of operation.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :hours_of_operation_id
The identifier for the hours of operation.
@return [Types::DescribeHoursOfOperationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeHoursOfOperationResponse#hours_of_operation #hours_of_operation} => Types::HoursOfOperation
@example Request syntax with placeholder values
resp = client.describe_hours_of_operation({ instance_id: "InstanceId", # required hours_of_operation_id: "HoursOfOperationId", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeHoursOfOperation AWS API Documentation
@overload describe_hours_of_operation
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1698 def describe_hours_of_operation(params = {}, options = {}) req = build_request(:describe_hours_of_operation, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Types::DescribeInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeInstanceResponse#instance #instance} => Types::Instance
@example Request syntax with placeholder values
resp = client.describe_instance({ instance_id: "InstanceId", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstance AWS API Documentation
@overload describe_instance
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1746 def describe_instance(params = {}, options = {}) req = build_request(:describe_instance, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Describes the specified instance attribute.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :attribute_type
The type of attribute.
@return [Types::DescribeInstanceAttributeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeInstanceAttributeResponse#attribute #attribute} => Types::Attribute
@example 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 })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceAttribute AWS API Documentation
@overload describe_instance_attribute
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1783 def describe_instance_attribute(params = {}, options = {}) req = build_request(:describe_instance_attribute, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :association_id
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
@option params [required, String] :resource_type
A valid resource type.
@return [Types::DescribeInstanceStorageConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeInstanceStorageConfigResponse#storage_config #storage_config} => Types::InstanceStorageConfig
@example 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 })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceStorageConfig AWS API Documentation
@overload describe_instance_storage_config
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1836 def describe_instance_storage_config(params = {}, options = {}) req = build_request(:describe_instance_storage_config, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Describes the specified queue.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :queue_id
The identifier for the queue.
@return [Types::DescribeQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeQueueResponse#queue #queue} => Types::Queue
@example Request syntax with placeholder values
resp = client.describe_queue({ instance_id: "InstanceId", # required queue_id: "QueueId", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeQueue AWS API Documentation
@overload describe_queue
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1883 def describe_queue(params = {}, options = {}) req = build_request(:describe_queue, params) req.send_request(options) end
Describes the quick connect.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :quick_connect_id
The identifier for the quick connect.
@return [Types::DescribeQuickConnectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeQuickConnectResponse#quick_connect #quick_connect} => Types::QuickConnect
@example Request syntax with placeholder values
resp = client.describe_quick_connect({ instance_id: "InstanceId", # required quick_connect_id: "QuickConnectId", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeQuickConnect AWS API Documentation
@overload describe_quick_connect
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1927 def describe_quick_connect(params = {}, options = {}) req = build_request(:describe_quick_connect, params) req.send_request(options) end
Describes the specified routing profile.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :routing_profile_id
The identifier of the routing profile.
@return [Types::DescribeRoutingProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeRoutingProfileResponse#routing_profile #routing_profile} => Types::RoutingProfile
@example Request syntax with placeholder values
resp = client.describe_routing_profile({ instance_id: "InstanceId", # required routing_profile_id: "RoutingProfileId", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfile AWS API Documentation
@overload describe_routing_profile
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 1970 def describe_routing_profile(params = {}, options = {}) req = build_request(:describe_routing_profile, params) req.send_request(options) end
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.
@option params [required, String] :user_id
The identifier of the user account.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeUserResponse#user #user} => Types::User
@example Request syntax with placeholder values
resp = client.describe_user({ user_id: "UserId", # required instance_id: "InstanceId", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUser AWS API Documentation
@overload describe_user
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 2022 def describe_user(params = {}, options = {}) req = build_request(:describe_user, params) req.send_request(options) end
Describes the specified hierarchy group.
@option params [required, String] :hierarchy_group_id
The identifier of the hierarchy group.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Types::DescribeUserHierarchyGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeUserHierarchyGroupResponse#hierarchy_group #hierarchy_group} => Types::HierarchyGroup
@example Request syntax with placeholder values
resp = client.describe_user_hierarchy_group({ hierarchy_group_id: "HierarchyGroupId", # required instance_id: "InstanceId", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroup AWS API Documentation
@overload describe_user_hierarchy_group
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 2073 def describe_user_hierarchy_group(params = {}, options = {}) req = build_request(:describe_user_hierarchy_group, params) req.send_request(options) end
Describes the hierarchy structure of the specified Amazon Connect
instance.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Types::DescribeUserHierarchyStructureResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeUserHierarchyStructureResponse#hierarchy_structure #hierarchy_structure} => Types::HierarchyStructure
@example Request syntax with placeholder values
resp = client.describe_user_hierarchy_structure({ instance_id: "InstanceId", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructure AWS API Documentation
@overload describe_user_hierarchy_structure
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 2117 def describe_user_hierarchy_structure(params = {}, options = {}) req = build_request(:describe_user_hierarchy_structure, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Revokes access to integrated applications from Amazon Connect
.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :origin
The domain URL of the integrated application.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.disassociate_approved_origin({ instance_id: "InstanceId", # required origin: "Origin", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateApprovedOrigin AWS API Documentation
@overload disassociate_approved_origin
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 2147 def disassociate_approved_origin(params = {}, options = {}) req = build_request(:disassociate_approved_origin, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [Types::LexBot] :lex_bot
Configuration information of an Amazon Lex bot.
@option params [Types::LexV2Bot] :lex_v2_bot
The Amazon Lex V2 bot to disassociate from the instance.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example 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", }, })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateBot AWS API Documentation
@overload disassociate_bot
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 2187 def disassociate_bot(params = {}, options = {}) req = build_request(:disassociate_bot, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :association_id
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
@option params [required, String] :resource_type
A valid resource type.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example 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 })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateInstanceStorageConfig AWS API Documentation
@overload disassociate_instance_storage_config
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 2223 def disassociate_instance_storage_config(params = {}, options = {}) req = build_request(:disassociate_instance_storage_config, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance..
@option params [required, String] :function_arn
The Amazon Resource Name (ARN) of the Lambda function being disassociated.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.disassociate_lambda_function({ instance_id: "InstanceId", # required function_arn: "FunctionArn", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateLambdaFunction AWS API Documentation
@overload disassociate_lambda_function
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 2255 def disassociate_lambda_function(params = {}, options = {}) req = build_request(:disassociate_lambda_function, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :bot_name
The name of the Amazon Lex bot. Maximum character limit of 50
@option params [required, String] :lex_region
The Region in which the Amazon Lex bot has been created.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.disassociate_lex_bot({ instance_id: "InstanceId", # required bot_name: "BotName", # required lex_region: "LexRegion", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateLexBot AWS API Documentation
@overload disassociate_lex_bot
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 2290 def disassociate_lex_bot(params = {}, options = {}) req = build_request(:disassociate_lex_bot, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Disassociates a set of quick connects from a queue.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :queue_id
The identifier for the queue.
@option params [required, Array<String>] :quick_connect_ids
The quick connects to disassociate from the queue.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.disassociate_queue_quick_connects({ instance_id: "InstanceId", # required queue_id: "QueueId", # required quick_connect_ids: ["QuickConnectId"], # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateQueueQuickConnects AWS API Documentation
@overload disassociate_queue_quick_connects
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 2324 def disassociate_queue_quick_connects(params = {}, options = {}) req = build_request(:disassociate_queue_quick_connects, params) req.send_request(options) end
Disassociates a set of queues from a routing profile.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :routing_profile_id
The identifier of the routing profile.
@option params [required, Array<Types::RoutingProfileQueueReference>] :queue_references
The queues to disassociate from this routing profile.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example 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 }, ], })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateRoutingProfileQueues AWS API Documentation
@overload disassociate_routing_profile_queues
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 2360 def disassociate_routing_profile_queues(params = {}, options = {}) req = build_request(:disassociate_routing_profile_queues, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Deletes the specified security key.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :association_id
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.disassociate_security_key({ instance_id: "InstanceId", # required association_id: "AssociationId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateSecurityKey AWS API Documentation
@overload disassociate_security_key
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 2391 def disassociate_security_key(params = {}, options = {}) req = build_request(:disassociate_security_key, params) req.send_request(options) end
Retrieves the contact attributes for the specified contact.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance.
@option params [required, String] :initial_contact_id
The identifier of the initial contact.
@return [Types::GetContactAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetContactAttributesResponse#attributes #attributes} => Hash<String,String>
@example Request syntax with placeholder values
resp = client.get_contact_attributes({ instance_id: "InstanceId", # required initial_contact_id: "ContactId", # required })
@example Response structure
resp.attributes #=> Hash resp.attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetContactAttributes AWS API Documentation
@overload get_contact_attributes
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 2424 def get_contact_attributes(params = {}, options = {}) req = build_request(:get_contact_attributes, params) req.send_request(options) end
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*.
[1]: docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, Types::Filters] :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.
@option params [Array<String>] :groupings
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.
@option params [required, Array<Types::CurrentMetric>] :current_metrics
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][1] in the *Amazon Connect Administrator Guide*. AGENTS\_AFTER\_CONTACT\_WORK : Unit: COUNT Name in real-time metrics report: [ACW][2] AGENTS\_AVAILABLE : Unit: COUNT Name in real-time metrics report: [Available][3] AGENTS\_ERROR : Unit: COUNT Name in real-time metrics report: [Error][4] AGENTS\_NON\_PRODUCTIVE : Unit: COUNT Name in real-time metrics report: [NPT (Non-Productive Time)][5] AGENTS\_ON\_CALL : Unit: COUNT Name in real-time metrics report: [On contact][6] AGENTS\_ON\_CONTACT : Unit: COUNT Name in real-time metrics report: [On contact][6] AGENTS\_ONLINE : Unit: COUNT Name in real-time metrics report: [Online][7] AGENTS\_STAFFED : Unit: COUNT Name in real-time metrics report: [Staffed][8] CONTACTS\_IN\_QUEUE : Unit: COUNT Name in real-time metrics report: [In queue][9] CONTACTS\_SCHEDULED : Unit: COUNT Name in real-time metrics report: [Scheduled][10] OLDEST\_CONTACT\_AGE : Unit: SECONDS When you 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][11] SLOTS\_ACTIVE : Unit: COUNT Name in real-time metrics report: [Active][12] SLOTS\_AVAILABLE : Unit: COUNT Name in real-time metrics report: [Availability][13] [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html [2]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time [3]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time [4]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time [5]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time [6]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time [7]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time [8]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time [9]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time [10]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time [11]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time [12]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time [13]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::GetCurrentMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetCurrentMetricDataResponse#next_token #next_token} => String * {Types::GetCurrentMetricDataResponse#metric_results #metric_results} => Array<Types::CurrentMetricResult> * {Types::GetCurrentMetricDataResponse#data_snapshot_time #data_snapshot_time} => Time
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.get_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, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricData AWS API Documentation
@overload get_current_metric_data
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 2624 def get_current_metric_data(params = {}, options = {}) req = build_request(:get_current_metric_data, params) req.send_request(options) end
Retrieves a token for federation.
<note markdown=“1”> 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`
</note>
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Types::GetFederationTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetFederationTokenResponse#credentials #credentials} => Types::Credentials
@example Request syntax with placeholder values
resp = client.get_federation_token({ instance_id: "InstanceId", # required })
@example Response structure
resp.credentials.access_token #=> String resp.credentials.access_token_expiration #=> Time resp.credentials.refresh_token #=> String resp.credentials.refresh_token_expiration #=> Time
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFederationToken AWS API Documentation
@overload get_federation_token
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 2665 def get_federation_token(params = {}, options = {}) req = build_request(:get_federation_token, params) req.send_request(options) end
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*.
[1]: docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, Time,DateTime,Date,Integer,String] :start_time
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.
@option params [required, Time,DateTime,Date,Integer,String] :end_time
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.
@option params [required, Types::Filters] :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. <note markdown="1"> To filter by `Queues`, enter the queue ID/ARN, not the name of the queue. </note>
@option params [Array<String>] :groupings
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.
@option params [required, Array<Types::HistoricalMetric>] :historical_metrics
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][1] in the *Amazon Connect Administrator Guide*. <note markdown="1"> This API does not support a contacts incoming metric (there's no CONTACTS\_INCOMING metric missing from the documented list). </note> 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"). [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::GetMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetMetricDataResponse#next_token #next_token} => String * {Types::GetMetricDataResponse#metric_results #metric_results} => Array<Types::HistoricalMetricResult>
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.get_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, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricData AWS API Documentation
@overload get_metric_data
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 2954 def get_metric_data(params = {}, options = {}) req = build_request(:get_metric_data, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Lists agent statuses.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [Array<String>] :agent_status_types
Available agent status types.
@return [Types::ListAgentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListAgentStatusResponse#next_token #next_token} => String * {Types::ListAgentStatusResponse#agent_status_summary_list #agent_status_summary_list} => Array<Types::AgentStatusSummary>
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_agent_statuses({ instance_id: "InstanceId", # required next_token: "NextToken", max_results: 1, agent_status_types: ["ROUTABLE"], # accepts ROUTABLE, CUSTOM, OFFLINE })
@example 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"
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAgentStatuses AWS API Documentation
@overload list_agent_statuses
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3008 def list_agent_statuses(params = {}, options = {}) req = build_request(:list_agent_statuses, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListApprovedOriginsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListApprovedOriginsResponse#origins #origins} => Array<String> * {Types::ListApprovedOriginsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_approved_origins({ instance_id: "InstanceId", # required next_token: "NextToken", max_results: 1, })
@example Response structure
resp.origins #=> Array resp.origins[0] #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListApprovedOrigins AWS API Documentation
@overload list_approved_origins
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3056 def list_approved_origins(params = {}, options = {}) req = build_request(:list_approved_origins, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [required, String] :lex_version
The version of Amazon Lex or Amazon Lex V2.
@return [Types::ListBotsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListBotsResponse#lex_bots #lex_bots} => Array<Types::LexBotConfig> * {Types::ListBotsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_bots({ instance_id: "InstanceId", # required next_token: "NextToken", max_results: 1, lex_version: "V1", # required, accepts V1, V2 })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListBots AWS API Documentation
@overload list_bots
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3110 def list_bots(params = {}, options = {}) req = build_request(:list_bots, params) req.send_request(options) end
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*.
[1]: docs.aws.amazon.com/connect/latest/adminguide/flow-language.html [2]: docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [Array<String>] :contact_flow_types
The type of contact flow.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListContactFlowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListContactFlowsResponse#contact_flow_summary_list #contact_flow_summary_list} => Array<Types::ContactFlowSummary> * {Types::ListContactFlowsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_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, })
@example 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.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlows AWS API Documentation
@overload list_contact_flows
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3173 def list_contact_flows(params = {}, options = {}) req = build_request(:list_contact_flows, params) req.send_request(options) end
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*.
[1]: docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListHoursOfOperationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListHoursOfOperationsResponse#hours_of_operation_summary_list #hours_of_operation_summary_list} => Array<Types::HoursOfOperationSummary> * {Types::ListHoursOfOperationsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_hours_of_operations({ instance_id: "InstanceId", # required next_token: "NextToken", max_results: 1, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperations AWS API Documentation
@overload list_hours_of_operations
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3227 def list_hours_of_operations(params = {}, options = {}) req = build_request(:list_hours_of_operations, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListInstanceAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListInstanceAttributesResponse#attributes #attributes} => Array<Types::Attribute> * {Types::ListInstanceAttributesResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_instance_attributes({ instance_id: "InstanceId", # required next_token: "NextToken", max_results: 1, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceAttributes AWS API Documentation
@overload list_instance_attributes
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3276 def list_instance_attributes(params = {}, options = {}) req = build_request(:list_instance_attributes, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :resource_type
A valid resource type.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListInstanceStorageConfigsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListInstanceStorageConfigsResponse#storage_configs #storage_configs} => Array<Types::InstanceStorageConfig> * {Types::ListInstanceStorageConfigsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_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, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceStorageConfigs AWS API Documentation
@overload list_instance_storage_configs
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3339 def list_instance_storage_configs(params = {}, options = {}) req = build_request(:list_instance_storage_configs, params) req.send_request(options) end
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.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListInstancesResponse#instance_summary_list #instance_summary_list} => Array<Types::InstanceSummary> * {Types::ListInstancesResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_instances({ next_token: "NextToken", max_results: 1, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstances AWS API Documentation
@overload list_instances
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3392 def list_instances(params = {}, options = {}) req = build_request(:list_instances, params) req.send_request(options) end
Provides summary information about the AppIntegration associations for the specified Amazon Connect
instance.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListIntegrationAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListIntegrationAssociationsResponse#integration_association_summary_list #integration_association_summary_list} => Array<Types::IntegrationAssociationSummary> * {Types::ListIntegrationAssociationsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_integration_associations({ instance_id: "InstanceId", # required next_token: "NextToken", max_results: 1, })
@example 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" 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListIntegrationAssociations AWS API Documentation
@overload list_integration_associations
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3444 def list_integration_associations(params = {}, options = {}) req = build_request(:list_integration_associations, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListLambdaFunctionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListLambdaFunctionsResponse#lambda_functions #lambda_functions} => Array<String> * {Types::ListLambdaFunctionsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_lambda_functions({ instance_id: "InstanceId", # required next_token: "NextToken", max_results: 1, })
@example Response structure
resp.lambda_functions #=> Array resp.lambda_functions[0] #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListLambdaFunctions AWS API Documentation
@overload list_lambda_functions
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3492 def list_lambda_functions(params = {}, options = {}) req = build_request(:list_lambda_functions, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListLexBotsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListLexBotsResponse#lex_bots #lex_bots} => Array<Types::LexBot> * {Types::ListLexBotsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_lex_bots({ instance_id: "InstanceId", # required next_token: "NextToken", max_results: 1, })
@example Response structure
resp.lex_bots #=> Array resp.lex_bots[0].name #=> String resp.lex_bots[0].lex_region #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListLexBots AWS API Documentation
@overload list_lex_bots
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3541 def list_lex_bots(params = {}, options = {}) req = build_request(:list_lex_bots, params) req.send_request(options) end
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*.
[1]: docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [Array<String>] :phone_number_types
The type of phone number.
@option params [Array<String>] :phone_number_country_codes
The ISO country code.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListPhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListPhoneNumbersResponse#phone_number_summary_list #phone_number_summary_list} => Array<Types::PhoneNumberSummary> * {Types::ListPhoneNumbersResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_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, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbers AWS API Documentation
@overload list_phone_numbers
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3606 def list_phone_numbers(params = {}, options = {}) req = build_request(:list_phone_numbers, params) req.send_request(options) end
Provides information about the prompts for the specified Amazon Connect
instance.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListPromptsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListPromptsResponse#prompt_summary_list #prompt_summary_list} => Array<Types::PromptSummary> * {Types::ListPromptsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_prompts({ instance_id: "InstanceId", # required next_token: "NextToken", max_results: 1, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPrompts AWS API Documentation
@overload list_prompts
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3652 def list_prompts(params = {}, options = {}) req = build_request(:list_prompts, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Lists the quick connects associated with a queue.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :queue_id
The identifier for the queue.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListQueueQuickConnectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListQueueQuickConnectsResponse#next_token #next_token} => String * {Types::ListQueueQuickConnectsResponse#quick_connect_summary_list #quick_connect_summary_list} => Array<Types::QuickConnectSummary>
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_queue_quick_connects({ instance_id: "InstanceId", # required queue_id: "QueueId", # required next_token: "NextToken", max_results: 1, })
@example 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"
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueueQuickConnects AWS API Documentation
@overload list_queue_quick_connects
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3706 def list_queue_quick_connects(params = {}, options = {}) req = build_request(:list_queue_quick_connects, params) req.send_request(options) end
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*.
[1]: docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [Array<String>] :queue_types
The type of queue.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListQueuesResponse#queue_summary_list #queue_summary_list} => Array<Types::QueueSummary> * {Types::ListQueuesResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_queues({ instance_id: "InstanceId", # required queue_types: ["STANDARD"], # accepts STANDARD, AGENT next_token: "NextToken", max_results: 1, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueues AWS API Documentation
@overload list_queues
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3770 def list_queues(params = {}, options = {}) req = build_request(:list_queues, params) req.send_request(options) end
Provides information about the quick connects for the specified Amazon Connect
instance.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [Array<String>] :quick_connect_types
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).
@return [Types::ListQuickConnectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListQuickConnectsResponse#quick_connect_summary_list #quick_connect_summary_list} => Array<Types::QuickConnectSummary> * {Types::ListQuickConnectsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_quick_connects({ instance_id: "InstanceId", # required next_token: "NextToken", max_results: 1, quick_connect_types: ["USER"], # accepts USER, QUEUE, PHONE_NUMBER })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQuickConnects AWS API Documentation
@overload list_quick_connects
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3825 def list_quick_connects(params = {}, options = {}) req = build_request(:list_quick_connects, params) req.send_request(options) end
Lists the queues associated with a routing profile.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :routing_profile_id
The identifier of the routing profile.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListRoutingProfileQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListRoutingProfileQueuesResponse#next_token #next_token} => String * {Types::ListRoutingProfileQueuesResponse#routing_profile_queue_config_summary_list #routing_profile_queue_config_summary_list} => Array<Types::RoutingProfileQueueConfigSummary>
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_routing_profile_queues({ instance_id: "InstanceId", # required routing_profile_id: "RoutingProfileId", # required next_token: "NextToken", max_results: 1, })
@example 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"
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueues AWS API Documentation
@overload list_routing_profile_queues
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3878 def list_routing_profile_queues(params = {}, options = {}) req = build_request(:list_routing_profile_queues, params) req.send_request(options) end
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*.
[1]: docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html [2]: docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListRoutingProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListRoutingProfilesResponse#routing_profile_summary_list #routing_profile_summary_list} => Array<Types::RoutingProfileSummary> * {Types::ListRoutingProfilesResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_routing_profiles({ instance_id: "InstanceId", # required next_token: "NextToken", max_results: 1, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfiles AWS API Documentation
@overload list_routing_profiles
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3934 def list_routing_profiles(params = {}, options = {}) req = build_request(:list_routing_profiles, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListSecurityKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListSecurityKeysResponse#security_keys #security_keys} => Array<Types::SecurityKey> * {Types::ListSecurityKeysResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_security_keys({ instance_id: "InstanceId", # required next_token: "NextToken", max_results: 1, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityKeys AWS API Documentation
@overload list_security_keys
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 3984 def list_security_keys(params = {}, options = {}) req = build_request(:list_security_keys, params) req.send_request(options) end
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*.
[1]: docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListSecurityProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListSecurityProfilesResponse#security_profile_summary_list #security_profile_summary_list} => Array<Types::SecurityProfileSummary> * {Types::ListSecurityProfilesResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_security_profiles({ instance_id: "InstanceId", # required next_token: "NextToken", max_results: 1, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfiles AWS API Documentation
@overload list_security_profiles
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4038 def list_security_profiles(params = {}, options = {}) req = build_request(:list_security_profiles, params) req.send_request(options) end
Lists the use cases.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :integration_association_id
The identifier for the integration association.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListUseCasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListUseCasesResponse#use_case_summary_list #use_case_summary_list} => Array<Types::UseCase> * {Types::ListUseCasesResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_use_cases({ instance_id: "InstanceId", # required integration_association_id: "IntegrationAssociationId", # required next_token: "NextToken", max_results: 1, })
@example 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" resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUseCases AWS API Documentation
@overload list_use_cases
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4124 def list_use_cases(params = {}, options = {}) req = build_request(:list_use_cases, params) req.send_request(options) end
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*.
[1]: docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListUserHierarchyGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListUserHierarchyGroupsResponse#user_hierarchy_group_summary_list #user_hierarchy_group_summary_list} => Array<Types::HierarchyGroupSummary> * {Types::ListUserHierarchyGroupsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_user_hierarchy_groups({ instance_id: "InstanceId", # required next_token: "NextToken", max_results: 1, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroups AWS API Documentation
@overload list_user_hierarchy_groups
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4178 def list_user_hierarchy_groups(params = {}, options = {}) req = build_request(:list_user_hierarchy_groups, params) req.send_request(options) end
Provides summary information about the users for the specified Amazon Connect
instance.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :next_token
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.
@option params [Integer] :max_results
The maximum number of results to return per page.
@return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListUsersResponse#user_summary_list #user_summary_list} => Array<Types::UserSummary> * {Types::ListUsersResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_users({ instance_id: "InstanceId", # required next_token: "NextToken", max_results: 1, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsers AWS API Documentation
@overload list_users
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4225 def list_users(params = {}, options = {}) req = build_request(:list_users, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :contact_id
The identifier of the contact.
@option params [required, String] :initial_contact_id
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.resume_contact_recording({ instance_id: "InstanceId", # required contact_id: "ContactId", # required initial_contact_id: "ContactId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResumeContactRecording AWS API Documentation
@overload resume_contact_recording
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4260 def resume_contact_recording(params = {}, options = {}) req = build_request(:resume_contact_recording, params) req.send_request(options) end
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][1
-
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*.
[1]: docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html [2]: docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html [3]: docs.aws.amazon.com/connect/latest/adminguide/chat.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :contact_flow_id
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**
@option params [Hash<String,String>] :attributes
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.
@option params [required, Types::ParticipantDetails] :participant_details
Information identifying the participant.
@option params [Types::ChatMessage] :initial_message
The initial message to be sent to the newly created chat.
@option params [String] :client_token
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.**
@return [Types::StartChatContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::StartChatContactResponse#contact_id #contact_id} => String * {Types::StartChatContactResponse#participant_id #participant_id} => String * {Types::StartChatContactResponse#participant_token #participant_token} => String
@example 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", })
@example Response structure
resp.contact_id #=> String resp.participant_id #=> String resp.participant_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartChatContact AWS API Documentation
@overload start_chat_contact
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4363 def start_chat_contact(params = {}, options = {}) req = build_request(:start_chat_contact, params) req.send_request(options) end
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.
[1]: docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :contact_id
The identifier of the contact.
@option params [required, String] :initial_contact_id
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
@option params [required, Types::VoiceRecordingConfiguration] :voice_recording_configuration
The person being recorded.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example 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 }, })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactRecording AWS API Documentation
@overload start_contact_recording
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4416 def start_contact_recording(params = {}, options = {}) req = build_request(:start_contact_recording, params) req.send_request(options) end
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.
<note markdown=“1”> 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*.
</note>
[1]: docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
@option params [required, String] :destination_phone_number
The phone number of the customer, in E.164 format.
@option params [required, String] :contact_flow_id
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**
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :client_token
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.**
@option params [String] :source_phone_number
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.
@option params [String] :queue_id
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.
@option params [Hash<String,String>] :attributes
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.
@return [Types::StartOutboundVoiceContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::StartOutboundVoiceContactResponse#contact_id #contact_id} => String
@example 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", }, })
@example Response structure
resp.contact_id #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContact AWS API Documentation
@overload start_outbound_voice_contact
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4515 def start_outbound_voice_contact(params = {}, options = {}) req = build_request(:start_outbound_voice_contact, params) req.send_request(options) end
Initiates a contact flow to start a new task.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [String] :previous_contact_id
The identifier of the previous chat, voice, or task contact.
@option params [required, String] :contact_flow_id
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**
@option params [Hash<String,String>] :attributes
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.
@option params [required, String] :name
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
@option params [Hash<String,Types::Reference>] :references
A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
@option params [String] :description
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
@option params [String] :client_token
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.**
@return [Types::StartTaskContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::StartTaskContactResponse#contact_id #contact_id} => String
@example 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 }, }, description: "Description", client_token: "ClientToken", })
@example Response structure
resp.contact_id #=> String
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContact AWS API Documentation
@overload start_task_contact
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4599 def start_task_contact(params = {}, options = {}) req = build_request(:start_task_contact, params) req.send_request(options) end
Ends the specified contact.
@option params [required, String] :contact_id
The ID of the contact.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.stop_contact({ contact_id: "ContactId", # required instance_id: "InstanceId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContact AWS API Documentation
@overload stop_contact
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4626 def stop_contact(params = {}, options = {}) req = build_request(:stop_contact, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :contact_id
The identifier of the contact.
@option params [required, String] :initial_contact_id
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.stop_contact_recording({ instance_id: "InstanceId", # required contact_id: "ContactId", # required initial_contact_id: "ContactId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactRecording AWS API Documentation
@overload stop_contact_recording
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4666 def stop_contact_recording(params = {}, options = {}) req = build_request(:stop_contact_recording, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :contact_id
The identifier of the contact.
@option params [required, String] :initial_contact_id
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.suspend_contact_recording({ instance_id: "InstanceId", # required contact_id: "ContactId", # required initial_contact_id: "ContactId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SuspendContactRecording AWS API Documentation
@overload suspend_contact_recording
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4706 def suspend_contact_recording(params = {}, options = {}) req = build_request(:suspend_contact_recording, params) req.send_request(options) end
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*.
[1]: docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html
@option params [required, String] :resource_arn
The Amazon Resource Name (ARN) of the resource.
@option params [required, Hash<String,String>] :tags
One or more tags. For example, \\\{ "tags": \\\{"key1":"value1", "key2":"value2"\\} \\}.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.tag_resource({ resource_arn: "ARN", # required tags: { # required "TagKey" => "TagValue", }, })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TagResource AWS API Documentation
@overload tag_resource
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4745 def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end
Removes the specified tags from the specified resource.
@option params [required, String] :resource_arn
The Amazon Resource Name (ARN) of the resource.
@option params [required, Array<String>] :tag_keys
The tag keys.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.untag_resource({ resource_arn: "ARN", # required tag_keys: ["TagKey"], # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UntagResource AWS API Documentation
@overload untag_resource
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4771 def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Updates agent status.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :agent_status_id
The identifier of the agent status.
@option params [String] :name
The name of the agent status.
@option params [String] :description
The description of the agent status.
@option params [String] :state
The state of the agent status.
@option params [Integer] :display_order
The display order of the agent status.
@option params [Boolean] :reset_order_number
A number indicating the reset order of the agent status.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example 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, })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateAgentStatus AWS API Documentation
@overload update_agent_status
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4821 def update_agent_status(params = {}, options = {}) req = build_request(:update_agent_status, params) req.send_request(options) end
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.
[1]: docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits
@option params [required, String] :initial_contact_id
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, Hash<String,String>] :attributes
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.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_contact_attributes({ initial_contact_id: "ContactId", # required instance_id: "InstanceId", # required attributes: { # required "AttributeName" => "AttributeValue", }, })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactAttributes AWS API Documentation
@overload update_contact_attributes
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4889 def update_contact_attributes(params = {}, options = {}) req = build_request(:update_contact_attributes, params) req.send_request(options) end
Updates the specified contact flow.
You can also create and update contact flows using the [Amazon Connect
Flow language].
[1]: docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance.
@option params [required, String] :contact_flow_id
The identifier of the contact flow.
@option params [required, String] :content
The JSON string that represents contact flow’s content. For an example, see [Example contact flow in Amazon Connect Flow language][1] in the *Amazon Connect Administrator Guide*. [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language-example.html
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_contact_flow_content({ instance_id: "InstanceId", # required contact_flow_id: "ContactFlowId", # required content: "ContactFlowContent", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowContent AWS API Documentation
@overload update_contact_flow_content
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4932 def update_contact_flow_content(params = {}, options = {}) req = build_request(:update_contact_flow_content, params) req.send_request(options) end
The name of the contact flow.
You can also create and update contact flows using the [Amazon Connect
Flow language].
[1]: docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance.
@option params [required, String] :contact_flow_id
The identifier of the contact flow.
@option params [String] :name
The name of the contact flow.
@option params [String] :description
The description of the contact flow.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_contact_flow_name({ instance_id: "InstanceId", # required contact_flow_id: "ContactFlowId", # required name: "ContactFlowName", description: "ContactFlowDescription", })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowName AWS API Documentation
@overload update_contact_flow_name
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 4973 def update_contact_flow_name(params = {}, options = {}) req = build_request(:update_contact_flow_name, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Updates the hours of operation.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :hours_of_operation_id
The identifier of the hours of operation.
@option params [String] :name
The name of the hours of operation.
@option params [String] :description
The description of the hours of operation.
@option params [String] :time_zone
The time zone of the hours of operation.
@option params [Array<Types::HoursOfOperationConfig>] :config
Configuration information of the hours of operation.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example 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 }, }, ], })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateHoursOfOperation AWS API Documentation
@overload update_hours_of_operation
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5031 def update_hours_of_operation(params = {}, options = {}) req = build_request(:update_hours_of_operation, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Updates the value for the specified attribute type.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :attribute_type
The type of attribute.
@option params [required, String] :value
The value for the attribute. Maximum character limit is 100.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example 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 })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateInstanceAttribute AWS API Documentation
@overload update_instance_attribute
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5065 def update_instance_attribute(params = {}, options = {}) req = build_request(:update_instance_attribute, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :association_id
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
@option params [required, String] :resource_type
A valid resource type.
@option params [required, Types::InstanceStorageConfig] :storage_config
The storage configuration for the instance.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example 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 }, }, })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateInstanceStorageConfig AWS API Documentation
@overload update_instance_storage_config
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5130 def update_instance_storage_config(params = {}, options = {}) req = build_request(:update_instance_storage_config, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Updates the hours of operation for the specified queue.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :queue_id
The identifier for the queue.
@option params [required, String] :hours_of_operation_id
The identifier for the hours of operation.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example 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 })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueHoursOfOperation AWS API Documentation
@overload update_queue_hours_of_operation
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5164 def update_queue_hours_of_operation(params = {}, options = {}) req = build_request(:update_queue_hours_of_operation, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :queue_id
The identifier for the queue.
@option params [Integer] :max_contacts
The maximum number of contacts that can be in the queue before it is considered full.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_queue_max_contacts({ instance_id: "InstanceId", # required queue_id: "QueueId", # required max_contacts: 1, })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueMaxContacts AWS API Documentation
@overload update_queue_max_contacts
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5200 def update_queue_max_contacts(params = {}, options = {}) req = build_request(:update_queue_max_contacts, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :queue_id
The identifier for the queue.
@option params [String] :name
The name of the queue.
@option params [String] :description
The description of the queue.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_queue_name({ instance_id: "InstanceId", # required queue_id: "QueueId", # required name: "CommonNameLength127", description: "QueueDescription", })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueName AWS API Documentation
@overload update_queue_name
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5239 def update_queue_name(params = {}, options = {}) req = build_request(:update_queue_name, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :queue_id
The identifier for the queue.
@option params [required, Types::OutboundCallerConfig] :outbound_caller_config
The outbound caller ID name, number, and outbound whisper flow.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example 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", }, })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueOutboundCallerConfig AWS API Documentation
@overload update_queue_outbound_caller_config
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5278 def update_queue_outbound_caller_config(params = {}, options = {}) req = build_request(:update_queue_outbound_caller_config, params) req.send_request(options) end
This API is in preview release for Amazon Connect
and is subject to change.
Updates the status of the queue.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :queue_id
The identifier for the queue.
@option params [required, String] :status
The status of the queue.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_queue_status({ instance_id: "InstanceId", # required queue_id: "QueueId", # required status: "ENABLED", # required, accepts ENABLED, DISABLED })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueStatus AWS API Documentation
@overload update_queue_status
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5312 def update_queue_status(params = {}, options = {}) req = build_request(:update_queue_status, params) req.send_request(options) end
Updates the configuration settings for the specified quick connect.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :quick_connect_id
The identifier for the quick connect.
@option params [required, Types::QuickConnectConfig] :quick_connect_config
Information about the configuration settings for the quick connect.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example 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 }, }, })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQuickConnectConfig AWS API Documentation
@overload update_quick_connect_config
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5356 def update_quick_connect_config(params = {}, options = {}) req = build_request(:update_quick_connect_config, params) req.send_request(options) end
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.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :quick_connect_id
The identifier for the quick connect.
@option params [String] :name
The name of the quick connect.
@option params [String] :description
The description of the quick connect.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_quick_connect_name({ instance_id: "InstanceId", # required quick_connect_id: "QuickConnectId", # required name: "QuickConnectName", description: "UpdateQuickConnectDescription", })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQuickConnectName AWS API Documentation
@overload update_quick_connect_name
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5393 def update_quick_connect_name(params = {}, options = {}) req = build_request(:update_quick_connect_name, params) req.send_request(options) end
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :routing_profile_id
The identifier of the routing profile.
@option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
The channels that agents can handle in the Contact Control Panel (CCP).
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example 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 }, ], })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileConcurrency AWS API Documentation
@overload update_routing_profile_concurrency
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5431 def update_routing_profile_concurrency(params = {}, options = {}) req = build_request(:update_routing_profile_concurrency, params) req.send_request(options) end
Updates the default outbound queue of a routing profile.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :routing_profile_id
The identifier of the routing profile.
@option params [required, String] :default_outbound_queue_id
The identifier for the default outbound queue.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_routing_profile_default_outbound_queue({ instance_id: "InstanceId", # required routing_profile_id: "RoutingProfileId", # required default_outbound_queue_id: "QueueId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueue AWS API Documentation
@overload update_routing_profile_default_outbound_queue
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5462 def update_routing_profile_default_outbound_queue(params = {}, options = {}) req = build_request(:update_routing_profile_default_outbound_queue, params) req.send_request(options) end
Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least `Name` or `Description` must be provided.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :routing_profile_id
The identifier of the routing profile.
@option params [String] :name
The name of the routing profile. Must not be more than 127 characters.
@option params [String] :description
The description of the routing profile. Must not be more than 250 characters.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_routing_profile_name({ instance_id: "InstanceId", # required routing_profile_id: "RoutingProfileId", # required name: "RoutingProfileName", description: "RoutingProfileDescription", })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileName AWS API Documentation
@overload update_routing_profile_name
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5500 def update_routing_profile_name(params = {}, options = {}) req = build_request(:update_routing_profile_name, params) req.send_request(options) end
Updates the properties associated with a set of queues for a routing profile.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@option params [required, String] :routing_profile_id
The identifier of the routing profile.
@option params [required, Array<Types::RoutingProfileQueueConfig>] :queue_configs
The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_routing_profile_queues({ instance_id: "InstanceId", # required routing_profile_id: "RoutingProfileId", # required queue_configs: [ # required { queue_reference: { # required queue_id: "QueueId", # required channel: "VOICE", # required, accepts VOICE, CHAT, TASK }, priority: 1, # required delay: 1, # required }, ], })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileQueues AWS API Documentation
@overload update_routing_profile_queues
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5543 def update_routing_profile_queues(params = {}, options = {}) req = build_request(:update_routing_profile_queues, params) req.send_request(options) end
Assigns the specified hierarchy group to the specified user.
@option params [String] :hierarchy_group_id
The identifier of the hierarchy group.
@option params [required, String] :user_id
The identifier of the user account.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_user_hierarchy({ hierarchy_group_id: "HierarchyGroupId", user_id: "UserId", # required instance_id: "InstanceId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchy AWS API Documentation
@overload update_user_hierarchy
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5574 def update_user_hierarchy(params = {}, options = {}) req = build_request(:update_user_hierarchy, params) req.send_request(options) end
Updates the name of the user hierarchy group.
@option params [required, String] :name
The name of the hierarchy group. Must not be more than 100 characters.
@option params [required, String] :hierarchy_group_id
The identifier of the hierarchy group.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_user_hierarchy_group_name({ name: "HierarchyGroupName", # required hierarchy_group_id: "HierarchyGroupId", # required instance_id: "InstanceId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyGroupName AWS API Documentation
@overload update_user_hierarchy_group_name
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5605 def update_user_hierarchy_group_name(params = {}, options = {}) req = build_request(:update_user_hierarchy_group_name, params) req.send_request(options) end
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
@option params [required, Types::HierarchyStructureUpdate] :hierarchy_structure
The hierarchy levels to update.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_user_hierarchy_structure({ hierarchy_structure: { # required level_one: { name: "HierarchyLevelName", # required }, level_two: { name: "HierarchyLevelName", # required }, level_three: { name: "HierarchyLevelName", # required }, level_four: { name: "HierarchyLevelName", # required }, level_five: { name: "HierarchyLevelName", # required }, }, instance_id: "InstanceId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyStructure AWS API Documentation
@overload update_user_hierarchy_structure
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5649 def update_user_hierarchy_structure(params = {}, options = {}) req = build_request(:update_user_hierarchy_structure, params) req.send_request(options) end
Updates the identity information for the specified user.
We strongly recommend limiting who has the ability to invoke `UpdateUserIdentityInfo`. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see [Best Practices for Security Profiles] in the *Amazon Connect
Administrator Guide*.
[1]: docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html
@option params [required, Types::UserIdentityInfo] :identity_info
The identity information for the user.
@option params [required, String] :user_id
The identifier of the user account.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_user_identity_info({ identity_info: { # required first_name: "AgentFirstName", last_name: "AgentLastName", email: "Email", }, user_id: "UserId", # required instance_id: "InstanceId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserIdentityInfo AWS API Documentation
@overload update_user_identity_info
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5696 def update_user_identity_info(params = {}, options = {}) req = build_request(:update_user_identity_info, params) req.send_request(options) end
Updates the phone configuration settings for the specified user.
@option params [required, Types::UserPhoneConfig] :phone_config
Information about phone configuration settings for the user.
@option params [required, String] :user_id
The identifier of the user account.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_user_phone_config({ phone_config: { # required phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE auto_accept: false, after_contact_work_time_limit: 1, desk_phone_number: "PhoneNumber", }, user_id: "UserId", # required instance_id: "InstanceId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserPhoneConfig AWS API Documentation
@overload update_user_phone_config
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5732 def update_user_phone_config(params = {}, options = {}) req = build_request(:update_user_phone_config, params) req.send_request(options) end
Assigns the specified routing profile to the specified user.
@option params [required, String] :routing_profile_id
The identifier of the routing profile for the user.
@option params [required, String] :user_id
The identifier of the user account.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_user_routing_profile({ routing_profile_id: "RoutingProfileId", # required user_id: "UserId", # required instance_id: "InstanceId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserRoutingProfile AWS API Documentation
@overload update_user_routing_profile
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5763 def update_user_routing_profile(params = {}, options = {}) req = build_request(:update_user_routing_profile, params) req.send_request(options) end
Assigns the specified security profiles to the specified user.
@option params [required, Array<String>] :security_profile_ids
The identifiers of the security profiles for the user.
@option params [required, String] :user_id
The identifier of the user account.
@option params [required, String] :instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.update_user_security_profiles({ security_profile_ids: ["SecurityProfileId"], # required user_id: "UserId", # required instance_id: "InstanceId", # required })
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserSecurityProfiles AWS API Documentation
@overload update_user_security_profiles
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connect/client.rb, line 5794 def update_user_security_profiles(params = {}, options = {}) req = build_request(:update_user_security_profiles, params) req.send_request(options) end
@api private @deprecated
# File lib/aws-sdk-connect/client.rb, line 5818 def waiter_names [] end