# WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE require 'seahorse/client/plugins/content_length.rb' require 'aws-sdk-core/plugins/credentials_configuration.rb' require 'aws-sdk-core/plugins/logging.rb' require 'aws-sdk-core/plugins/param_converter.rb' require 'aws-sdk-core/plugins/param_validator.rb' require 'aws-sdk-core/plugins/user_agent.rb' require 'aws-sdk-core/plugins/helpful_socket_errors.rb' require 'aws-sdk-core/plugins/retry_errors.rb' require 'aws-sdk-core/plugins/global_configuration.rb' require 'aws-sdk-core/plugins/regional_endpoint.rb' require 'aws-sdk-core/plugins/endpoint_discovery.rb' require 'aws-sdk-core/plugins/endpoint_pattern.rb' require 'aws-sdk-core/plugins/response_paging.rb' require 'aws-sdk-core/plugins/stub_responses.rb' require 'aws-sdk-core/plugins/idempotency_token.rb' require 'aws-sdk-core/plugins/jsonvalue_converter.rb' require 'aws-sdk-core/plugins/client_metrics_plugin.rb' require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb' require 'aws-sdk-core/plugins/transfer_encoding.rb' require 'aws-sdk-core/plugins/signature_v4.rb' require 'aws-sdk-core/plugins/protocols/rest_json.rb' Aws::Plugins::GlobalConfiguration.add_identifier(:connect) module Aws::Connect class Client < Seahorse::Client::Base include Aws::ClientStubs @identifier = :connect set_api(ClientApi::API) add_plugin(Seahorse::Client::Plugins::ContentLength) add_plugin(Aws::Plugins::CredentialsConfiguration) add_plugin(Aws::Plugins::Logging) add_plugin(Aws::Plugins::ParamConverter) add_plugin(Aws::Plugins::ParamValidator) add_plugin(Aws::Plugins::UserAgent) add_plugin(Aws::Plugins::HelpfulSocketErrors) add_plugin(Aws::Plugins::RetryErrors) add_plugin(Aws::Plugins::GlobalConfiguration) add_plugin(Aws::Plugins::RegionalEndpoint) add_plugin(Aws::Plugins::EndpointDiscovery) add_plugin(Aws::Plugins::EndpointPattern) add_plugin(Aws::Plugins::ResponsePaging) add_plugin(Aws::Plugins::StubResponses) add_plugin(Aws::Plugins::IdempotencyToken) add_plugin(Aws::Plugins::JsonvalueConverter) add_plugin(Aws::Plugins::ClientMetricsPlugin) add_plugin(Aws::Plugins::ClientMetricsSendPlugin) add_plugin(Aws::Plugins::TransferEncoding) add_plugin(Aws::Plugins::SignatureV4) add_plugin(Aws::Plugins::Protocols::RestJson) # @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::InstanceProfileCredentials` - Used for loading credentials # from an EC2 IMDS on an EC2 instance. # # * `Aws::SharedCredentials` - Used for loading credentials from a # shared file, such as `~/.aws/config`. # # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. # # 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 IMDS instance profile - When used by default, the timeouts are # very aggressive. Construct and pass an instance of # `Aws::InstanceProfileCredentails` 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 search 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] :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] :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 endpoints. This should be avalid 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. Defaults to `false`. # # @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 [String] :profile ("default") # Used when loading credentials from the shared credentials file # at HOME/.aws/credentials. When not specified, 'default' is used. # # @option options [Float] :retry_base_delay (0.3) # The base delay in seconds used by the default backoff function. # # @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. # # @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 and auth # errors from expired credentials. # # @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. # # @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 rasing 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 yeidled by {#session_for}. # # @option options [Float] :http_idle_timeout (5) The number of # seconds a connection is allowed to sit idble 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 yeidled by {#session_for}. # # @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. # def initialize(*args) super end # @!group API Operations # Creates a user account for the specified Amazon Connect instance. # # @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] :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. # # @option params [Hash] :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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUser AWS API Documentation # # @overload create_user(params = {}) # @param [Hash] params ({}) def create_user(params = {}, options = {}) req = build_request(:create_user, params) req.send_request(options) end # Deletes a user account from the specified Amazon Connect instance. # # @option params [required, String] :instance_id # The identifier of the Amazon Connect 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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUser AWS API Documentation # # @overload delete_user(params = {}) # @param [Hash] params ({}) def delete_user(params = {}, options = {}) req = build_request(:delete_user, 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. # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUser AWS API Documentation # # @overload describe_user(params = {}) # @param [Hash] params ({}) 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. # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroup AWS API Documentation # # @overload describe_user_hierarchy_group(params = {}) # @param [Hash] params ({}) 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. # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructure AWS API Documentation # # @overload describe_user_hierarchy_structure(params = {}) # @param [Hash] params ({}) def describe_user_hierarchy_structure(params = {}, options = {}) req = build_request(:describe_user_hierarchy_structure, 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"] #=> # # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetContactAttributes AWS API Documentation # # @overload get_contact_attributes(params = {}) # @param [Hash] params ({}) 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 more information, see [Real-time Metrics Reports][1] in the # *Amazon Connect Administrator Guide*. # # # # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-reports.html # # @option params [required, String] :instance_id # The identifier of the Amazon Connect 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. The only supported # channel is `VOICE`. # # @option params [Array] :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. The only supported channel is `VOICE`. # # If no `Grouping` is included in the request, a summary of metrics is # returned. # # @option params [required, Array] :current_metrics # The metrics to retrieve. Specify the name and unit for each metric. # The following metrics are available: # # AGENTS\_AFTER\_CONTACT\_WORK # # : Unit: COUNT # # AGENTS\_AVAILABLE # # : Unit: COUNT # # AGENTS\_ERROR # # : Unit: COUNT # # AGENTS\_NON\_PRODUCTIVE # # : Unit: COUNT # # AGENTS\_ON\_CALL # # : Unit: COUNT # # AGENTS\_ON\_CONTACT # # : Unit: COUNT # # AGENTS\_ONLINE # # : Unit: COUNT # # AGENTS\_STAFFED # # : Unit: COUNT # # CONTACTS\_IN\_QUEUE # # : Unit: COUNT # # CONTACTS\_SCHEDULED # # : Unit: COUNT # # OLDEST\_CONTACT\_AGE # # : Unit: SECONDS # # SLOTS\_ACTIVE # # : Unit: COUNT # # SLOTS\_AVAILABLE # # : Unit: COUNT # # @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 maximimum 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 # # @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 # }, # 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" # 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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricData AWS API Documentation # # @overload get_current_metric_data(params = {}) # @param [Hash] params ({}) 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. # # @option params [required, String] :instance_id # The identifier of the Amazon Connect 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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFederationToken AWS API Documentation # # @overload get_federation_token(params = {}) # @param [Hash] params ({}) 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 more information, see [Historical Metrics Reports][1] in the # *Amazon Connect Administrator Guide*. # # # # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics.html # # @option params [required, String] :instance_id # The identifier of the Amazon Connect 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. The only supported # channel is `VOICE`. # # @option params [Array] :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. # # The only supported grouping is `QUEUE`. # # If no grouping is specified, a summary of metrics for all queues is # returned. # # @option params [required, Array] :historical_metrics # The metrics to retrieve. Specify the name, unit, and statistic for # each metric. The following historical metrics are available: # # 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 # # : Unit: PERCENT # # Statistic: AVG # # Threshold: Only "Less than" comparisons are supported, with the # following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, # 180, 240, 300, 600 # # @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 maximimum 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> # # @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 # }, # 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" # 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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricData AWS API Documentation # # @overload get_metric_data(params = {}) # @param [Hash] params ({}) def get_metric_data(params = {}, options = {}) req = build_request(:get_metric_data, params) req.send_request(options) end # Provides information about the contact flows for the specified Amazon # Connect instance. # # @option params [required, String] :instance_id # The identifier of the Amazon Connect instance. # # @option params [Array] :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 maximimum 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 # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlows AWS API Documentation # # @overload list_contact_flows(params = {}) # @param [Hash] params ({}) 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. # # @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 maximimum 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 # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperations AWS API Documentation # # @overload list_hours_of_operations(params = {}) # @param [Hash] params ({}) def list_hours_of_operations(params = {}, options = {}) req = build_request(:list_hours_of_operations, params) req.send_request(options) end # Provides information about the phone numbers for the specified Amazon # Connect instance. # # @option params [required, String] :instance_id # The identifier of the Amazon Connect instance. # # @option params [Array] :phone_number_types # The type of phone number. # # @option params [Array] :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 maximimum 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 # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbers AWS API Documentation # # @overload list_phone_numbers(params = {}) # @param [Hash] params ({}) def list_phone_numbers(params = {}, options = {}) req = build_request(:list_phone_numbers, params) req.send_request(options) end # Provides information about the queues for the specified Amazon Connect # instance. # # @option params [required, String] :instance_id # The identifier of the Amazon Connect instance. # # @option params [Array] :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 maximimum 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 # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueues AWS API Documentation # # @overload list_queues(params = {}) # @param [Hash] params ({}) def list_queues(params = {}, options = {}) req = build_request(:list_queues, params) req.send_request(options) end # Provides summary information about the routing profiles 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 maximimum 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 # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfiles AWS API Documentation # # @overload list_routing_profiles(params = {}) # @param [Hash] params ({}) def list_routing_profiles(params = {}, options = {}) req = build_request(:list_routing_profiles, params) req.send_request(options) end # Provides summary information about the security profiles 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 maximimum 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 # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfiles AWS API Documentation # # @overload list_security_profiles(params = {}) # @param [Hash] params ({}) def list_security_profiles(params = {}, options = {}) req = build_request(:list_security_profiles, params) req.send_request(options) end # Lists the tags for the specified resource. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the resource. # # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String> # # @example Request syntax with placeholder values # # resp = client.list_tags_for_resource({ # resource_arn: "ARN", # required # }) # # @example Response structure # # resp.tags #=> Hash # resp.tags["TagKey"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTagsForResource AWS API Documentation # # @overload list_tags_for_resource(params = {}) # @param [Hash] params ({}) def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end # Provides summary information about the hierarchy groups 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 maximimum 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 # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroups AWS API Documentation # # @overload list_user_hierarchy_groups(params = {}) # @param [Hash] params ({}) 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. # # @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 maximimum 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 # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsers AWS API Documentation # # @overload list_users(params = {}) # @param [Hash] params ({}) def list_users(params = {}, options = {}) req = build_request(:list_users, 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][1] API in the Amazon Connect # Participant Service. # # When a new chat contact is successfully created, clients need to # 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. # # # # [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.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 for the chat. # # @option params [Hash] :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, 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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartChatContact AWS API Documentation # # @overload start_chat_contact(params = {}) # @param [Hash] params ({}) def start_chat_contact(params = {}, options = {}) req = build_request(:start_chat_contact, params) req.send_request(options) end # Initiates a contact flow to place an outbound call to a customer. # # There is a 60 second dialing timeout for this operation. If the call # is not connected after 60 seconds, it fails. # # @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. # # @option params [required, String] :instance_id # The identifier of the Amazon Connect 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. # If the contact is disconnected, a new contact is started. # # **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] :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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContact AWS API Documentation # # @overload start_outbound_voice_contact(params = {}) # @param [Hash] params ({}) def start_outbound_voice_contact(params = {}, options = {}) req = build_request(:start_outbound_voice_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. # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContact AWS API Documentation # # @overload stop_contact(params = {}) # @param [Hash] params ({}) def stop_contact(params = {}, options = {}) req = build_request(:stop_contact, params) req.send_request(options) end # Adds the specified tags to the specified resource. # # The supported resource type is users. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the resource. # # @option params [required, Hash] :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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TagResource AWS API Documentation # # @overload tag_resource(params = {}) # @param [Hash] params ({}) 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] :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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UntagResource AWS API Documentation # # @overload untag_resource(params = {}) # @param [Hash] params ({}) def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end # Creates or updates the contact attributes associated with the # specified contact. # # You can add or update attributes for both ongoing and completed # contacts. For example, you can update the customer's name or the # reason the customer called while the call is active, or add notes # about steps that the agent took during the call that are displayed 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 identifying abusive # callers. # # Contact attributes are available in Amazon Connect for 24 months, and # are then deleted. # # **Important:** You cannot use the operation to update attributes for # contacts that occurred prior to the release of the API, 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. # # @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. # # @option params [required, Hash] :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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactAttributes AWS API Documentation # # @overload update_contact_attributes(params = {}) # @param [Hash] params ({}) def update_contact_attributes(params = {}, options = {}) req = build_request(:update_contact_attributes, 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. # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchy AWS API Documentation # # @overload update_user_hierarchy(params = {}) # @param [Hash] params ({}) def update_user_hierarchy(params = {}, options = {}) req = build_request(:update_user_hierarchy, params) req.send_request(options) end # Updates the identity information for the specified user. # # @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. # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserIdentityInfo AWS API Documentation # # @overload update_user_identity_info(params = {}) # @param [Hash] params ({}) 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. # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserPhoneConfig AWS API Documentation # # @overload update_user_phone_config(params = {}) # @param [Hash] params ({}) 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. # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserRoutingProfile AWS API Documentation # # @overload update_user_routing_profile(params = {}) # @param [Hash] params ({}) 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] :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. # # @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 http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserSecurityProfiles AWS API Documentation # # @overload update_user_security_profiles(params = {}) # @param [Hash] params ({}) def update_user_security_profiles(params = {}, options = {}) req = build_request(:update_user_security_profiles, params) req.send_request(options) end # @!endgroup # @param params ({}) # @api private 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.22.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated def waiter_names [] end class << self # @api private attr_reader :identifier # @api private def errors_module Errors end end end end