You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Connect::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon Connect Service. To construct a client, you need to configure a :region and :credentials.

connect = Aws::Connect::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::Connect::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::Connect::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#create_user(options = {}) ⇒ Types::CreateUserResponse

Creates a new user account in your Amazon Connect instance.

Examples:

Request syntax with placeholder values


resp = client.create_user({
  username: "AgentUsername", # required
  password: "Password",
  identity_info: {
    first_name: "AgentFirstName",
    last_name: "AgentLastName",
    email: "Email",
  },
  phone_config: { # required
    phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
    auto_accept: false,
    after_contact_work_time_limit: 1,
    desk_phone_number: "PhoneNumber",
  },
  directory_user_id: "DirectoryUserId",
  security_profile_ids: ["SecurityProfileId"], # required
  routing_profile_id: "RoutingProfileId", # required
  hierarchy_group_id: "HierarchyGroupId",
  instance_id: "InstanceId", # required
})

Response structure


resp.user_id #=> String
resp.user_arn #=> String

Options Hash (options):

  • :username (required, String)

    The user name in Amazon Connect for the account to create.

  • :password (String)

    The password for the user account to create. This is required if you are using Amazon Connect for identity management. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.

  • :identity_info (Types::UserIdentityInfo)

    Information about the user, including email address, first name, and last name.

  • :phone_config (required, Types::UserPhoneConfig)

    Specifies the phone settings for the user, including AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.

  • :directory_user_id (String)

    The unique identifier for the user account in the directory service directory used for identity management. If Amazon Connect is unable to access the existing directory, you can use the DirectoryUserId to authenticate users. If you include the parameter, it is assumed that Amazon Connect cannot access the directory. If the parameter is not included, the UserIdentityInfo is used to authenticate users from your existing 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 InvalidRequestException is returned.

  • :security_profile_ids (required, Array<String>)

    The unique identifier of the security profile to assign to the user created.

  • :routing_profile_id (required, String)

    The unique identifier for the routing profile to assign to the user created.

  • :hierarchy_group_id (String)

    The unique identifier for the hierarchy group to assign to the user created.

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Returns:

See Also:

#delete_user(options = {}) ⇒ Struct

Deletes a user account from Amazon Connect.

Examples:

Request syntax with placeholder values


resp = client.delete_user({
  instance_id: "InstanceId", # required
  user_id: "UserId", # required
})

Options Hash (options):

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

  • :user_id (required, String)

    The unique identifier of the user to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

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

Returns a User object that contains information about the user account specified by the UserId.

Examples:

Request syntax with placeholder values


resp = client.describe_user({
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
})

Response structure


resp.user.id #=> String
resp.user.arn #=> String
resp.user.username #=> String
resp.user.identity_info.first_name #=> String
resp.user.identity_info.last_name #=> String
resp.user.identity_info.email #=> String
resp.user.phone_config.phone_type #=> String, one of "SOFT_PHONE", "DESK_PHONE"
resp.user.phone_config.auto_accept #=> true/false
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

Options Hash (options):

  • :user_id (required, String)

    Unique identifier for the user account to return.

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Returns:

See Also:

#describe_user_hierarchy_group(options = {}) ⇒ Types::DescribeUserHierarchyGroupResponse

Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.

Examples:

Request syntax with placeholder values


resp = client.describe_user_hierarchy_group({
  hierarchy_group_id: "HierarchyGroupId", # required
  instance_id: "InstanceId", # required
})

Response structure


resp.hierarchy_group.id #=> String
resp.hierarchy_group.arn #=> String
resp.hierarchy_group.name #=> String
resp.hierarchy_group.level_id #=> String
resp.hierarchy_group.hierarchy_path.level_one.id #=> String
resp.hierarchy_group.hierarchy_path.level_one.arn #=> String
resp.hierarchy_group.hierarchy_path.level_one.name #=> String
resp.hierarchy_group.hierarchy_path.level_two.id #=> String
resp.hierarchy_group.hierarchy_path.level_two.arn #=> String
resp.hierarchy_group.hierarchy_path.level_two.name #=> String
resp.hierarchy_group.hierarchy_path.level_three.id #=> String
resp.hierarchy_group.hierarchy_path.level_three.arn #=> String
resp.hierarchy_group.hierarchy_path.level_three.name #=> String
resp.hierarchy_group.hierarchy_path.level_four.id #=> String
resp.hierarchy_group.hierarchy_path.level_four.arn #=> String
resp.hierarchy_group.hierarchy_path.level_four.name #=> String
resp.hierarchy_group.hierarchy_path.level_five.id #=> String
resp.hierarchy_group.hierarchy_path.level_five.arn #=> String
resp.hierarchy_group.hierarchy_path.level_five.name #=> String

Options Hash (options):

  • :hierarchy_group_id (required, String)

    The identifier for the hierarchy group to return.

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Returns:

See Also:

#describe_user_hierarchy_structure(options = {}) ⇒ Types::DescribeUserHierarchyStructureResponse

Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy.

Examples:

Request syntax with placeholder values


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

Response structure


resp.hierarchy_structure.level_one.id #=> String
resp.hierarchy_structure.level_one.arn #=> String
resp.hierarchy_structure.level_one.name #=> String
resp.hierarchy_structure.level_two.id #=> String
resp.hierarchy_structure.level_two.arn #=> String
resp.hierarchy_structure.level_two.name #=> String
resp.hierarchy_structure.level_three.id #=> String
resp.hierarchy_structure.level_three.arn #=> String
resp.hierarchy_structure.level_three.name #=> String
resp.hierarchy_structure.level_four.id #=> String
resp.hierarchy_structure.level_four.arn #=> String
resp.hierarchy_structure.level_four.name #=> String
resp.hierarchy_structure.level_five.id #=> String
resp.hierarchy_structure.level_five.arn #=> String
resp.hierarchy_structure.level_five.name #=> String

Options Hash (options):

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Returns:

See Also:

#get_current_metric_data(options = {}) ⇒ Types::GetCurrentMetricDataResponse

The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action.

Examples:

Request syntax with placeholder values


resp = client.get_current_metric_data({
  instance_id: "InstanceId", # required
  filters: { # required
    queues: ["QueueId"],
    channels: ["VOICE"], # accepts VOICE
  },
  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
      unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.metric_results #=> Array
resp.metric_results[0].dimensions.queue.id #=> String
resp.metric_results[0].dimensions.queue.arn #=> String
resp.metric_results[0].dimensions.channel #=> String, one of "VOICE"
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"
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

Options Hash (options):

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

  • :filters (required, Types::Filters)

    A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the queue IDs, ARNs, or Channels included in the filter. You can include both IDs and ARNs in the same request. To retrieve metrics for all queues, add the queue ID or ARN for each queue in your instance. Only VOICE is supported for Channels.

    To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after \'id=\' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61. The queue ID is also included in the URL, and is the string after \'queue/\'.

  • :groupings (Array<String>)

    The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. The only supported channel is VOICE.

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

  • :current_metrics (required, Array<Types::CurrentMetric>)

    A list of CurrentMetric objects for the metrics to retrieve. Each CurrentMetric includes a name of a metric to retrieve and the unit to use for it.

    The following metrics are available:

    AGENTS_AVAILABLE

    Unit: COUNT

    AGENTS_ONLINE

    Unit: COUNT

    AGENTS_ON_CALL

    Unit: COUNT

    AGENTS_STAFFED

    Unit: COUNT

    AGENTS_AFTER_CONTACT_WORK

    Unit: COUNT

    AGENTS_NON_PRODUCTIVE

    Unit: COUNT

    AGENTS_ERROR

    Unit: COUNT

    CONTACTS_IN_QUEUE

    Unit: COUNT

    OLDEST_CONTACT_AGE

    Unit: SECONDS

    CONTACTS_SCHEDULED

    Unit: COUNT

  • :next_token (String)

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

    The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.

  • :max_results (Integer)

    MaxResults indicates the maximum number of results to return per page in the response, between 1 and 100.

Returns:

See Also:

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

Retrieves a token for federation.

Examples:

Request syntax with placeholder values


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

Response structure


resp.credentials.access_token #=> String
resp.credentials.access_token_expiration #=> Time
resp.credentials.refresh_token #=> String
resp.credentials.refresh_token_expiration #=> Time

Options Hash (options):

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Returns:

See Also:

#get_metric_data(options = {}) ⇒ Types::GetMetricDataResponse

The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetMetricData action.

Examples:

Request syntax with placeholder values


resp = client.get_metric_data({
  instance_id: "InstanceId", # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  filters: { # required
    queues: ["QueueId"],
    channels: ["VOICE"], # accepts VOICE
  },
  groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
  historical_metrics: [ # required
    {
      name: "CONTACTS_QUEUED", # accepts CONTACTS_QUEUED, CONTACTS_HANDLED, CONTACTS_ABANDONED, CONTACTS_CONSULTED, CONTACTS_AGENT_HUNG_UP_FIRST, CONTACTS_HANDLED_INCOMING, CONTACTS_HANDLED_OUTBOUND, CONTACTS_HOLD_ABANDONS, CONTACTS_TRANSFERRED_IN, CONTACTS_TRANSFERRED_OUT, CONTACTS_TRANSFERRED_IN_FROM_QUEUE, CONTACTS_TRANSFERRED_OUT_FROM_QUEUE, CONTACTS_MISSED, CALLBACK_CONTACTS_HANDLED, API_CONTACTS_HANDLED, OCCUPANCY, HANDLE_TIME, AFTER_CONTACT_WORK_TIME, QUEUED_TIME, ABANDON_TIME, QUEUE_ANSWER_TIME, HOLD_TIME, INTERACTION_TIME, INTERACTION_AND_HOLD_TIME, SERVICE_LEVEL
      threshold: {
        comparison: "LT", # accepts LT
        threshold_value: 1.0,
      },
      statistic: "SUM", # accepts SUM, MAX, AVG
      unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.metric_results #=> Array
resp.metric_results[0].dimensions.queue.id #=> String
resp.metric_results[0].dimensions.queue.arn #=> String
resp.metric_results[0].dimensions.channel #=> String, one of "VOICE"
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

Options Hash (options):

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

  • :start_time (required, 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.

    StartTime cannot be earlier than 24 hours before the time of the request. Historical metrics are available in Amazon Connect only for 24 hours.

  • :end_time (required, 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 StartTime timestamp.

    The time range between StartTime and EndTime must be less than 24 hours.

  • :filters (required, Types::Filters)

    A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or a list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the IDs, ARNs, or Channels included in the filter. You can use both IDs and ARNs together in a request. Only VOICE is supported for Channel.

    To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after \'id=\' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61. The queue ID is also included in the URL, and is the string after \'queue/\'.

  • :groupings (Array<String>)

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

    The current version supports grouping by Queue

    If no Grouping is included in the request, a summary of HistoricalMetrics for all queues is returned.

  • :historical_metrics (required, Array<Types::HistoricalMetric>)

    A list of HistoricalMetric objects that contain the metrics to retrieve with the request.

    A HistoricalMetric object contains: HistoricalMetricName, Statistic, Threshold, and Unit.

    For each historical metric you include in the request, you must include a Unit and a Statistic.

    The following historical metrics are available:

    CONTACTS_QUEUED

    Unit: COUNT

    Statistic: SUM

    CONTACTS_HANDLED

    Unit: COUNT

    Statistics: SUM

    CONTACTS_ABANDONED

    Unit: COUNT

    Statistics: SUM

    CONTACTS_CONSULTED

    Unit: COUNT

    Statistics: SUM

    CONTACTS_AGENT_HUNG_UP_FIRST

    Unit: COUNT

    Statistics: SUM

    CONTACTS_HANDLED_INCOMING

    Unit: COUNT

    Statistics: SUM

    CONTACTS_HANDLED_OUTBOUND

    Unit: COUNT

    Statistics: SUM

    CONTACTS_HOLD_ABANDONS

    Unit: COUNT

    Statistics: SUM

    CONTACTS_TRANSFERRED_IN

    Unit: COUNT

    Statistics: SUM

    CONTACTS_TRANSFERRED_OUT

    Unit: COUNT

    Statistics: SUM

    CONTACTS_TRANSFERRED_IN_FROM_QUEUE

    Unit: COUNT

    Statistics: SUM

    CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

    Unit: COUNT

    Statistics: SUM

    CALLBACK_CONTACTS_HANDLED

    Unit: COUNT

    Statistics: SUM

    CALLBACK_CONTACTS_HANDLED

    Unit: COUNT

    Statistics: SUM

    API_CONTACTS_HANDLED

    Unit: COUNT

    Statistics: SUM

    CONTACTS_MISSED

    Unit: COUNT

    Statistics: SUM

    OCCUPANCY

    Unit: PERCENT

    Statistics: AVG

    HANDLE_TIME

    Unit: SECONDS

    Statistics: AVG

    AFTER_CONTACT_WORK_TIME

    Unit: SECONDS

    Statistics: AVG

    QUEUED_TIME

    Unit: SECONDS

    Statistics: MAX

    ABANDON_TIME

    Unit: COUNT

    Statistics: SUM

    QUEUE_ANSWER_TIME

    Unit: SECONDS

    Statistics: AVG

    HOLD_TIME

    Unit: SECONDS

    Statistics: AVG

    INTERACTION_TIME

    Unit: SECONDS

    Statistics: AVG

    INTERACTION_AND_HOLD_TIME

    Unit: SECONDS

    Statistics: AVG

    SERVICE_LEVEL

    Unit: PERCENT

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

  • :next_token (String)

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

  • :max_results (Integer)

    Indicates the maximum number of results to return per page in the response, between 1-100.

Returns:

See Also:

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

Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of routing profiles to return in the response.

Returns:

See Also:

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

Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of security profiles to return.

Returns:

See Also:

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

Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of hierarchy groups to return.

Returns:

See Also:

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

Returns a UserSummaryList, which is an array of UserSummary objects.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

  • :next_token (String)

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

  • :max_results (Integer)

    The maximum number of results to return in the response.

Returns:

See Also:

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

The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.

If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action.

Examples:

Request syntax with placeholder values


resp = client.start_outbound_voice_contact({
  destination_phone_number: "PhoneNumber", # required
  contact_flow_id: "ContactFlowId", # required
  instance_id: "InstanceId", # required
  client_token: "ClientToken",
  source_phone_number: "PhoneNumber",
  queue_id: "QueueId",
  attributes: {
    "AttributeName" => "AttributeValue",
  },
})

Response structure


resp.contact_id #=> String

Options Hash (options):

  • :destination_phone_number (required, String)

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

  • :contact_flow_id (required, String)

    The identifier for the contact flow to connect the outbound call to.

    To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after \'contact-flow/\' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

  • :client_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. 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.

  • :source_phone_number (String)

    The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.

  • :queue_id (String)

    The queue to add the call to. 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 used will be the queue defined in the contact flow.

    To find the QueueId, open the queue you want to use in the Amazon Connect Queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters at the end of the URL, after \'queue/\' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.

  • :attributes (Hash<String,String>)

    Specify 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. Attribute keys can include only alphanumeric, dash, and underscore characters.

    For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:

Returns:

See Also:

#stop_contact(options = {}) ⇒ Struct

Ends the contact initiated by the StartOutboundVoiceContact operation.

If you are using an IAM account, it must have permission to the connect:StopContact action.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :contact_id (required, String)

    The unique identifier of the contact to end.

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_contact_attributes(options = {}) ⇒ Struct

The UpdateContactAttributes operation lets you programmatically create new, or update existing, contact attributes associated with a contact. You can use the operation to 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 use the UpdateContactAttributes operation to 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.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :initial_contact_id (required, String)

    The unique identifier of the contact for which to update attributes. This is the identifier for the contact associated with the first interaction with the contact center.

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

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

    The key-value pairs for the attribute to update.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_user_hierarchy(options = {}) ⇒ Struct

Assigns the specified hierarchy group to the user.

Examples:

Request syntax with placeholder values


resp = client.update_user_hierarchy({
  hierarchy_group_id: "HierarchyGroupId",
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
})

Options Hash (options):

  • :hierarchy_group_id (String)

    The identifier for the hierarchy group to assign to the user.

  • :user_id (required, String)

    The identifier of the user account to assign the hierarchy group to.

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_user_identity_info(options = {}) ⇒ Struct

Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name.

Examples:

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

Options Hash (options):

  • :identity_info (required, Types::UserIdentityInfo)

    A UserIdentityInfo object.

  • :user_id (required, String)

    The identifier for the user account to update identity information for.

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_user_phone_config(options = {}) ⇒ Struct

Updates the phone configuration settings in the UserPhoneConfig object for the specified user.

Examples:

Request syntax with placeholder values


resp = client.update_user_phone_config({
  phone_config: { # required
    phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
    auto_accept: false,
    after_contact_work_time_limit: 1,
    desk_phone_number: "PhoneNumber",
  },
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
})

Options Hash (options):

  • :phone_config (required, Types::UserPhoneConfig)

    A UserPhoneConfig object that contains settings for AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType to assign to the user.

  • :user_id (required, String)

    The identifier for the user account to change phone settings for.

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_user_routing_profile(options = {}) ⇒ Struct

Assigns the specified routing profile to a user.

Examples:

Request syntax with placeholder values


resp = client.update_user_routing_profile({
  routing_profile_id: "RoutingProfileId", # required
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
})

Options Hash (options):

  • :routing_profile_id (required, String)

    The identifier of the routing profile to assign to the user.

  • :user_id (required, String)

    The identifier for the user account to assign the routing profile to.

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_user_security_profiles(options = {}) ⇒ Struct

Updates the security profiles assigned to the user.

Examples:

Request syntax with placeholder values


resp = client.update_user_security_profiles({
  security_profile_ids: ["SecurityProfileId"], # required
  user_id: "UserId", # required
  instance_id: "InstanceId", # required
})

Options Hash (options):

  • :security_profile_ids (required, Array<String>)

    The identifiers for the security profiles to assign to the user.

  • :user_id (required, String)

    The identifier of the user account to assign the security profiles.

  • :instance_id (required, String)

    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.