Connect

Table of Contents

Client

class Connect.Client

A low-level client representing Amazon Connect Service:

import boto3

client = boto3.client('connect')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_user(**kwargs)

Creates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_user(
    Username='string',
    Password='string',
    IdentityInfo={
        'FirstName': 'string',
        'LastName': 'string',
        'Email': 'string'
    },
    PhoneConfig={
        'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
        'AutoAccept': True|False,
        'AfterContactWorkTimeLimit': 123,
        'DeskPhoneNumber': 'string'
    },
    DirectoryUserId='string',
    SecurityProfileIds=[
        'string',
    ],
    RoutingProfileId='string',
    HierarchyGroupId='string',
    InstanceId='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • Username (string) --

    [REQUIRED]

    The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.@]+.

  • Password (string) -- The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.
  • IdentityInfo (dict) --

    The information about the identity of the user.

    • FirstName (string) --

      The first name. This is required if you are using Amazon Connect or SAML for identity management.

    • LastName (string) --

      The last name. This is required if you are using Amazon Connect or SAML for identity management.

    • Email (string) --

      The email address. If you are using SAML for identity management and include this parameter, an error is returned.

  • PhoneConfig (dict) --

    [REQUIRED]

    The phone settings for the user.

    • PhoneType (string) -- [REQUIRED]

      The phone type.

    • AutoAccept (boolean) --

      The Auto accept setting.

    • AfterContactWorkTimeLimit (integer) --

      The After Call Work (ACW) timeout setting, in seconds.

    • DeskPhoneNumber (string) --

      The phone number for the user's desk phone.

  • DirectoryUserId (string) --

    The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

    This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

  • SecurityProfileIds (list) --

    [REQUIRED]

    The identifier of the security profile for the user.

    • (string) --
  • RoutingProfileId (string) --

    [REQUIRED]

    The identifier of the routing profile for the user.

  • HierarchyGroupId (string) -- The identifier of the hierarchy group for the user.
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • Tags (dict) --

    One or more tags.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'UserId': 'string',
    'UserArn': 'string'
}

Response Structure

  • (dict) --

    • UserId (string) --

      The identifier of the user account.

    • UserArn (string) --

      The Amazon Resource Name (ARN) of the user account.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.LimitExceededException
  • Connect.Client.exceptions.DuplicateResourceException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
delete_user(**kwargs)

Deletes a user account from the specified Amazon Connect instance.

For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_user(
    InstanceId='string',
    UserId='string'
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • UserId (string) --

    [REQUIRED]

    The identifier of the user.

Returns

None

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
describe_user(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_user(
    UserId='string',
    InstanceId='string'
)
Parameters
  • UserId (string) --

    [REQUIRED]

    The identifier of the user account.

  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

Return type

dict

Returns

Response Syntax

{
    'User': {
        'Id': 'string',
        'Arn': 'string',
        'Username': 'string',
        'IdentityInfo': {
            'FirstName': 'string',
            'LastName': 'string',
            'Email': 'string'
        },
        'PhoneConfig': {
            'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
            'AutoAccept': True|False,
            'AfterContactWorkTimeLimit': 123,
            'DeskPhoneNumber': 'string'
        },
        'DirectoryUserId': 'string',
        'SecurityProfileIds': [
            'string',
        ],
        'RoutingProfileId': 'string',
        'HierarchyGroupId': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • User (dict) --

      Information about the user account and configuration settings.

      • Id (string) --

        The identifier of the user account.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the user account.

      • Username (string) --

        The user name assigned to the user account.

      • IdentityInfo (dict) --

        Information about the user identity.

        • FirstName (string) --

          The first name. This is required if you are using Amazon Connect or SAML for identity management.

        • LastName (string) --

          The last name. This is required if you are using Amazon Connect or SAML for identity management.

        • Email (string) --

          The email address. If you are using SAML for identity management and include this parameter, an error is returned.

      • PhoneConfig (dict) --

        Information about the phone configuration for the user.

        • PhoneType (string) --

          The phone type.

        • AutoAccept (boolean) --

          The Auto accept setting.

        • AfterContactWorkTimeLimit (integer) --

          The After Call Work (ACW) timeout setting, in seconds.

        • DeskPhoneNumber (string) --

          The phone number for the user's desk phone.

      • DirectoryUserId (string) --

        The identifier of the user account in the directory used for identity management.

      • SecurityProfileIds (list) --

        The identifiers of the security profiles for the user.

        • (string) --
      • RoutingProfileId (string) --

        The identifier of the routing profile for the user.

      • HierarchyGroupId (string) --

        The identifier of the hierarchy group for the user.

      • Tags (dict) --

        The tags.

        • (string) --
          • (string) --

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
describe_user_hierarchy_group(**kwargs)

Describes the specified hierarchy group.

See also: AWS API Documentation

Request Syntax

response = client.describe_user_hierarchy_group(
    HierarchyGroupId='string',
    InstanceId='string'
)
Parameters
  • HierarchyGroupId (string) --

    [REQUIRED]

    The identifier of the hierarchy group.

  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

Return type

dict

Returns

Response Syntax

{
    'HierarchyGroup': {
        'Id': 'string',
        'Arn': 'string',
        'Name': 'string',
        'LevelId': 'string',
        'HierarchyPath': {
            'LevelOne': {
                'Id': 'string',
                'Arn': 'string',
                'Name': 'string'
            },
            'LevelTwo': {
                'Id': 'string',
                'Arn': 'string',
                'Name': 'string'
            },
            'LevelThree': {
                'Id': 'string',
                'Arn': 'string',
                'Name': 'string'
            },
            'LevelFour': {
                'Id': 'string',
                'Arn': 'string',
                'Name': 'string'
            },
            'LevelFive': {
                'Id': 'string',
                'Arn': 'string',
                'Name': 'string'
            }
        }
    }
}

Response Structure

  • (dict) --

    • HierarchyGroup (dict) --

      Information about the hierarchy group.

      • Id (string) --

        The identifier of the hierarchy group.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the hierarchy group.

      • Name (string) --

        The name of the hierarchy group.

      • LevelId (string) --

        The identifier of the level in the hierarchy group.

      • HierarchyPath (dict) --

        Information about the levels in the hierarchy group.

        • LevelOne (dict) --

          Information about level one.

          • Id (string) --

            The identifier of the hierarchy group.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the hierarchy group.

          • Name (string) --

            The name of the hierarchy group.

        • LevelTwo (dict) --

          Information about level two.

          • Id (string) --

            The identifier of the hierarchy group.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the hierarchy group.

          • Name (string) --

            The name of the hierarchy group.

        • LevelThree (dict) --

          Information about level three.

          • Id (string) --

            The identifier of the hierarchy group.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the hierarchy group.

          • Name (string) --

            The name of the hierarchy group.

        • LevelFour (dict) --

          Information about level four.

          • Id (string) --

            The identifier of the hierarchy group.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the hierarchy group.

          • Name (string) --

            The name of the hierarchy group.

        • LevelFive (dict) --

          Information about level five.

          • Id (string) --

            The identifier of the hierarchy group.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the hierarchy group.

          • Name (string) --

            The name of the hierarchy group.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
describe_user_hierarchy_structure(**kwargs)

Describes the hierarchy structure of the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

response = client.describe_user_hierarchy_structure(
    InstanceId='string'
)
Parameters
InstanceId (string) --

[REQUIRED]

The identifier of the Amazon Connect instance.

Return type
dict
Returns
Response Syntax
{
    'HierarchyStructure': {
        'LevelOne': {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
        'LevelTwo': {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
        'LevelThree': {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
        'LevelFour': {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
        'LevelFive': {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • HierarchyStructure (dict) --

      Information about the hierarchy structure.

      • LevelOne (dict) --

        Information about level one.

        • Id (string) --

          The identifier of the hierarchy level.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the hierarchy level.

        • Name (string) --

          The name of the hierarchy level.

      • LevelTwo (dict) --

        Information about level two.

        • Id (string) --

          The identifier of the hierarchy level.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the hierarchy level.

        • Name (string) --

          The name of the hierarchy level.

      • LevelThree (dict) --

        Information about level three.

        • Id (string) --

          The identifier of the hierarchy level.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the hierarchy level.

        • Name (string) --

          The name of the hierarchy level.

      • LevelFour (dict) --

        Information about level four.

        • Id (string) --

          The identifier of the hierarchy level.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the hierarchy level.

        • Name (string) --

          The name of the hierarchy level.

      • LevelFive (dict) --

        Information about level five.

        • Id (string) --

          The identifier of the hierarchy level.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the hierarchy level.

        • Name (string) --

          The name of the hierarchy level.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_contact_attributes(**kwargs)

Retrieves the contact attributes for the specified contact.

See also: AWS API Documentation

Request Syntax

response = client.get_contact_attributes(
    InstanceId='string',
    InitialContactId='string'
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • InitialContactId (string) --

    [REQUIRED]

    The identifier of the initial contact.

Return type

dict

Returns

Response Syntax

{
    'Attributes': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • Attributes (dict) --

      Information about the attributes.

      • (string) --
        • (string) --

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.InternalServiceException
get_current_metric_data(**kwargs)

Gets the real-time metric data from the specified Amazon Connect instance.

For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_current_metric_data(
    InstanceId='string',
    Filters={
        'Queues': [
            'string',
        ],
        'Channels': [
            'VOICE'|'CHAT',
        ]
    },
    Groupings=[
        'QUEUE'|'CHANNEL',
    ],
    CurrentMetrics=[
        {
            'Name': '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'|'COUNT'|'PERCENT'
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • Filters (dict) --

    [REQUIRED]

    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 .

    • Queues (list) --

      The queues to use to filter the metrics. You can specify up to 100 queues per request.

      • (string) --
    • Channels (list) --

      The channel to use to filter the metrics.

      • (string) --
  • Groupings (list) --

    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.

    • (string) --
  • CurrentMetrics (list) --

    [REQUIRED]

    The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide .

    AGENTS_AFTER_CONTACT_WORK

    Unit: COUNT

    Name in real-time metrics report: ACW

    AGENTS_AVAILABLE

    Unit: COUNT

    Name in real-time metrics report: Available

    AGENTS_ERROR

    Unit: COUNT

    Name in real-time metrics report: Error

    AGENTS_NON_PRODUCTIVE

    Unit: COUNT

    Name in real-time metrics report: NPT (Non-Productive Time)

    AGENTS_ON_CALL

    Unit: COUNT

    Name in real-time metrics report: On contact

    AGENTS_ON_CONTACT

    Unit: COUNT

    Name in real-time metrics report: On contact

    AGENTS_ONLINE

    Unit: COUNT

    Name in real-time metrics report: Online

    AGENTS_STAFFED

    Unit: COUNT

    Name in real-time metrics report: Staffed

    CONTACTS_IN_QUEUE

    Unit: COUNT

    Name in real-time metrics report: In queue

    CONTACTS_SCHEDULED

    Unit: COUNT

    Name in real-time metrics report: Scheduled

    OLDEST_CONTACT_AGE

    Unit: SECONDS

    When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:

    { "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0 }

    The actual OLDEST_CONTACT_AGE is 24 seconds.

    Name in real-time metrics report: Oldest

    SLOTS_ACTIVE

    Unit: COUNT

    Name in real-time metrics report: Active

    SLOTS_AVAILABLE

    Unit: COUNT

    Name in real-time metrics report: Availability

    • (dict) --

      Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide .

      • Name (string) --

        The name of the metric.

      • Unit (string) --

        The unit for the metric.

  • NextToken (string) --

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

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

  • MaxResults (integer) -- The maximimum number of results to return per page.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'MetricResults': [
        {
            'Dimensions': {
                'Queue': {
                    'Id': 'string',
                    'Arn': 'string'
                },
                'Channel': 'VOICE'|'CHAT'
            },
            'Collections': [
                {
                    'Metric': {
                        'Name': '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'|'COUNT'|'PERCENT'
                    },
                    'Value': 123.0
                },
            ]
        },
    ],
    'DataSnapshotTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If there are additional results, this is the token for 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.

    • MetricResults (list) --

      Information about the real-time metrics.

      • (dict) --

        Contains information about a set of real-time metrics.

        • Dimensions (dict) --

          The dimensions for the metrics.

          • Queue (dict) --

            Information about the queue for which metrics are returned.

            • Id (string) --

              The identifier of the queue.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the queue.

          • Channel (string) --

            The channel used for grouping and filters.

        • Collections (list) --

          The set of metrics.

          • (dict) --

            Contains the data for a real-time metric.

            • Metric (dict) --

              Information about the metric.

              • Name (string) --

                The name of the metric.

              • Unit (string) --

                The unit for the metric.

            • Value (float) --

              The value of the metric.

    • DataSnapshotTime (datetime) --

      The time at which the metrics were retrieved and cached for pagination.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.InternalServiceException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.ResourceNotFoundException
get_federation_token(**kwargs)

Retrieves a token for federation.

See also: AWS API Documentation

Request Syntax

response = client.get_federation_token(
    InstanceId='string'
)
Parameters
InstanceId (string) --

[REQUIRED]

The identifier of the Amazon Connect instance.

Return type
dict
Returns
Response Syntax
{
    'Credentials': {
        'AccessToken': 'string',
        'AccessTokenExpiration': datetime(2015, 1, 1),
        'RefreshToken': 'string',
        'RefreshTokenExpiration': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • Credentials (dict) --

      The credentials to use for federation.

      • AccessToken (string) --

        An access token generated for a federated user to access Amazon Connect.

      • AccessTokenExpiration (datetime) --

        A token generated with an expiration time for the session a user is logged in to Amazon Connect.

      • RefreshToken (string) --

        Renews a token generated for a user to access the Amazon Connect instance.

      • RefreshTokenExpiration (datetime) --

        Renews the expiration timer for a generated token.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.UserNotFoundException
  • Connect.Client.exceptions.InternalServiceException
  • Connect.Client.exceptions.DuplicateResourceException
get_metric_data(**kwargs)

Gets historical metric data from the specified Amazon Connect instance.

For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_metric_data(
    InstanceId='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    Filters={
        'Queues': [
            'string',
        ],
        'Channels': [
            'VOICE'|'CHAT',
        ]
    },
    Groupings=[
        'QUEUE'|'CHANNEL',
    ],
    HistoricalMetrics=[
        {
            'Name': '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',
                'ThresholdValue': 123.0
            },
            'Statistic': 'SUM'|'MAX'|'AVG',
            'Unit': 'SECONDS'|'COUNT'|'PERCENT'
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • StartTime (datetime) --

    [REQUIRED]

    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.

  • EndTime (datetime) --

    [REQUIRED]

    The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

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

  • Filters (dict) --

    [REQUIRED]

    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 .

    • Queues (list) --

      The queues to use to filter the metrics. You can specify up to 100 queues per request.

      • (string) --
    • Channels (list) --

      The channel to use to filter the metrics.

      • (string) --
  • Groupings (list) --

    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.

    • (string) --
  • HistoricalMetrics (list) --

    [REQUIRED]

    The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide .

    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

    • (dict) --

      Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide .

      • Name (string) --

        The name of the metric.

      • Threshold (dict) --

        The threshold for the metric, used with service level metrics.

        • Comparison (string) --

          The type of comparison. Only "less than" (LT) comparisons are supported.

        • ThresholdValue (float) --

          The threshold value to compare.

      • Statistic (string) --

        The statistic for the metric.

      • Unit (string) --

        The unit for the metric.

  • NextToken (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.
  • MaxResults (integer) -- The maximimum number of results to return per page.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'MetricResults': [
        {
            'Dimensions': {
                'Queue': {
                    'Id': 'string',
                    'Arn': 'string'
                },
                'Channel': 'VOICE'|'CHAT'
            },
            'Collections': [
                {
                    'Metric': {
                        'Name': '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',
                            'ThresholdValue': 123.0
                        },
                        'Statistic': 'SUM'|'MAX'|'AVG',
                        'Unit': 'SECONDS'|'COUNT'|'PERCENT'
                    },
                    'Value': 123.0
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If there are additional results, this is the token for 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.

    • MetricResults (list) --

      Information about the historical metrics.

      If no grouping is specified, a summary of metric data is returned.

      • (dict) --

        Contains information about the historical metrics retrieved.

        • Dimensions (dict) --

          The dimension for the metrics.

          • Queue (dict) --

            Information about the queue for which metrics are returned.

            • Id (string) --

              The identifier of the queue.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the queue.

          • Channel (string) --

            The channel used for grouping and filters.

        • Collections (list) --

          The set of metrics.

          • (dict) --

            Contains the data for a historical metric.

            • Metric (dict) --

              Information about the metric.

              • Name (string) --

                The name of the metric.

              • Threshold (dict) --

                The threshold for the metric, used with service level metrics.

                • Comparison (string) --

                  The type of comparison. Only "less than" (LT) comparisons are supported.

                • ThresholdValue (float) --

                  The threshold value to compare.

              • Statistic (string) --

                The statistic for the metric.

              • Unit (string) --

                The unit for the metric.

            • Value (float) --

              The value of the metric.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.InternalServiceException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.ResourceNotFoundException
get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_contact_flows(**kwargs)

Provides information about the contact flows for the specified Amazon Connect instance.

For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Request Syntax

response = client.list_contact_flows(
    InstanceId='string',
    ContactFlowTypes=[
        'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • ContactFlowTypes (list) --

    The type of contact flow.

    • (string) --
  • NextToken (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.
  • MaxResults (integer) -- The maximimum number of results to return per page.
Return type

dict

Returns

Response Syntax

{
    'ContactFlowSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'ContactFlowType': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ContactFlowSummaryList (list) --

      Information about the contact flows.

      • (dict) --

        Contains summary information about a contact flow.

        • Id (string) --

          The identifier of the contact flow.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the contact flow.

        • Name (string) --

          The name of the contact flow.

        • ContactFlowType (string) --

          The type of contact flow.

    • NextToken (string) --

      If there are additional results, this is the token for the next set of results.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
list_hours_of_operations(**kwargs)

Provides information about the hours of operation for the specified Amazon Connect instance.

For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Request Syntax

response = client.list_hours_of_operations(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • NextToken (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.
  • MaxResults (integer) -- The maximimum number of results to return per page.
Return type

dict

Returns

Response Syntax

{
    'HoursOfOperationSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • HoursOfOperationSummaryList (list) --

      Information about the hours of operation.

      • (dict) --

        Contains summary information about hours of operation for a contact center.

        • Id (string) --

          The identifier of the hours of operation.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the hours of operation.

        • Name (string) --

          The name of the hours of operation.

    • NextToken (string) --

      If there are additional results, this is the token for the next set of results.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
list_phone_numbers(**kwargs)

Provides information about the phone numbers for the specified Amazon Connect instance.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Request Syntax

response = client.list_phone_numbers(
    InstanceId='string',
    PhoneNumberTypes=[
        'TOLL_FREE'|'DID',
    ],
    PhoneNumberCountryCodes=[
        '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',
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • PhoneNumberTypes (list) --

    The type of phone number.

    • (string) --
  • PhoneNumberCountryCodes (list) --

    The ISO country code.

    • (string) --
  • NextToken (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.
  • MaxResults (integer) -- The maximimum number of results to return per page.
Return type

dict

Returns

Response Syntax

{
    'PhoneNumberSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'PhoneNumber': 'string',
            'PhoneNumberType': 'TOLL_FREE'|'DID',
            'PhoneNumberCountryCode': '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • PhoneNumberSummaryList (list) --

      Information about the phone numbers.

      • (dict) --

        Contains summary information about a phone number for a contact center.

        • Id (string) --

          The identifier of the phone number.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the phone number.

        • PhoneNumber (string) --

          The phone number.

        • PhoneNumberType (string) --

          The type of phone number.

        • PhoneNumberCountryCode (string) --

          The ISO country code.

    • NextToken (string) --

      If there are additional results, this is the token for the next set of results.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
list_queues(**kwargs)

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

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

See also: AWS API Documentation

Request Syntax

response = client.list_queues(
    InstanceId='string',
    QueueTypes=[
        'STANDARD'|'AGENT',
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • QueueTypes (list) --

    The type of queue.

    • (string) --
  • NextToken (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.
  • MaxResults (integer) -- The maximimum number of results to return per page.
Return type

dict

Returns

Response Syntax

{
    'QueueSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'QueueType': 'STANDARD'|'AGENT'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • QueueSummaryList (list) --

      Information about the queues.

      • (dict) --

        Contains summary information about a queue.

        • Id (string) --

          The identifier of the queue.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the queue.

        • Name (string) --

          The name of the queue.

        • QueueType (string) --

          The type of queue.

    • NextToken (string) --

      If there are additional results, this is the token for the next set of results.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
list_routing_profiles(**kwargs)

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

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

See also: AWS API Documentation

Request Syntax

response = client.list_routing_profiles(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • NextToken (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.
  • MaxResults (integer) -- The maximimum number of results to return per page.
Return type

dict

Returns

Response Syntax

{
    'RoutingProfileSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • RoutingProfileSummaryList (list) --

      Information about the routing profiles.

      • (dict) --

        Contains summary information about a routing profile.

        • Id (string) --

          The identifier of the routing profile.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the routing profile.

        • Name (string) --

          The name of the routing profile.

    • NextToken (string) --

      If there are additional results, this is the token for the next set of results.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
list_security_profiles(**kwargs)

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

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

See also: AWS API Documentation

Request Syntax

response = client.list_security_profiles(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • NextToken (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.
  • MaxResults (integer) -- The maximimum number of results to return per page.
Return type

dict

Returns

Response Syntax

{
    'SecurityProfileSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • SecurityProfileSummaryList (list) --

      Information about the security profiles.

      • (dict) --

        Contains information about a security profile.

        • Id (string) --

          The identifier of the security profile.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the security profile.

        • Name (string) --

          The name of the security profile.

    • NextToken (string) --

      If there are additional results, this is the token for the next set of results.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
list_tags_for_resource(**kwargs)

Lists the tags for the specified resource.

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

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --

      Information about the tags.

      • (string) --
        • (string) --

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.InternalServiceException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
list_user_hierarchy_groups(**kwargs)

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

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

See also: AWS API Documentation

Request Syntax

response = client.list_user_hierarchy_groups(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • NextToken (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.
  • MaxResults (integer) -- The maximimum number of results to return per page.
Return type

dict

Returns

Response Syntax

{
    'UserHierarchyGroupSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • UserHierarchyGroupSummaryList (list) --

      Information about the hierarchy groups.

      • (dict) --

        Contains summary information about a hierarchy group.

        • Id (string) --

          The identifier of the hierarchy group.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the hierarchy group.

        • Name (string) --

          The name of the hierarchy group.

    • NextToken (string) --

      If there are additional results, this is the token for the next set of results.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
list_users(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_users(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • NextToken (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.
  • MaxResults (integer) -- The maximimum number of results to return per page.
Return type

dict

Returns

Response Syntax

{
    'UserSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Username': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • UserSummaryList (list) --

      Information about the users.

      • (dict) --

        Contains summary information about a user.

        • Id (string) --

          The identifier of the user account.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the user account.

        • Username (string) --

          The Amazon Connect user name of the user account.

    • NextToken (string) --

      If there are additional results, this is the token for the next set of results.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
start_chat_contact(**kwargs)

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

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

A 429 error occurs in two situations:

  • API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception from the API Gateway.
  • The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException .

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

See also: AWS API Documentation

Request Syntax

response = client.start_chat_contact(
    InstanceId='string',
    ContactFlowId='string',
    Attributes={
        'string': 'string'
    },
    ParticipantDetails={
        'DisplayName': 'string'
    },
    InitialMessage={
        'ContentType': 'string',
        'Content': 'string'
    },
    ClientToken='string'
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • ContactFlowId (string) --

    [REQUIRED]

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

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

  • Attributes (dict) --

    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.

    • (string) --
      • (string) --
  • ParticipantDetails (dict) --

    [REQUIRED]

    Information identifying the participant.

    • DisplayName (string) -- [REQUIRED]

      Display name of the participant.

  • InitialMessage (dict) --

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

    • ContentType (string) -- [REQUIRED]

      The type of the content. Supported types are text/plain.

    • Content (string) -- [REQUIRED]

      The content of the chat message.

  • ClientToken (string) --

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'ContactId': 'string',
    'ParticipantId': 'string',
    'ParticipantToken': 'string'
}

Response Structure

  • (dict) --

    • ContactId (string) --

      The identifier of this contact within the Amazon Connect instance.

    • ParticipantId (string) --

      The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.

    • ParticipantToken (string) --

      The token used by the chat participant to call CreateParticipantConnection . The participant token is valid for the lifetime of a chat participant.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.InternalServiceException
  • Connect.Client.exceptions.LimitExceededException
start_outbound_voice_contact(**kwargs)

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

Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that's when the call is routed to the agent, like any other inbound case.

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

Note

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

See also: AWS API Documentation

Request Syntax

response = client.start_outbound_voice_contact(
    DestinationPhoneNumber='string',
    ContactFlowId='string',
    InstanceId='string',
    ClientToken='string',
    SourcePhoneNumber='string',
    QueueId='string',
    Attributes={
        'string': 'string'
    }
)
Parameters
  • DestinationPhoneNumber (string) --

    [REQUIRED]

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

  • ContactFlowId (string) --

    [REQUIRED]

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

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

  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • ClientToken (string) --

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. If the contact is disconnected, a new contact is started.

    This field is autopopulated if not provided.

  • SourcePhoneNumber (string) -- The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
  • QueueId (string) -- The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
  • Attributes (dict) --

    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.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'ContactId': 'string'
}

Response Structure

  • (dict) --

    • ContactId (string) --

      The identifier of this contact within the Amazon Connect instance.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.InternalServiceException
  • Connect.Client.exceptions.LimitExceededException
  • Connect.Client.exceptions.DestinationNotAllowedException
  • Connect.Client.exceptions.OutboundContactNotPermittedException
stop_contact(**kwargs)

Ends the specified contact.

See also: AWS API Documentation

Request Syntax

response = client.stop_contact(
    ContactId='string',
    InstanceId='string'
)
Parameters
  • ContactId (string) --

    [REQUIRED]

    The ID of the contact.

  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.ContactNotFoundException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.InternalServiceException
tag_resource(**kwargs)

Adds the specified tags to the specified resource.

The supported resource type is users.

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

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • tags (dict) --

    [REQUIRED]

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

    • (string) --
      • (string) --
Returns

None

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.InternalServiceException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
untag_resource(**kwargs)

Removes the specified tags from the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • tagKeys (list) --

    [REQUIRED]

    The tag keys.

    • (string) --
Returns

None

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.InternalServiceException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
update_contact_attributes(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_contact_attributes(
    InitialContactId='string',
    InstanceId='string',
    Attributes={
        'string': 'string'
    }
)
Parameters
  • InitialContactId (string) --

    [REQUIRED]

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

  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • Attributes (dict) --

    [REQUIRED]

    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.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.InternalServiceException
update_user_hierarchy(**kwargs)

Assigns the specified hierarchy group to the specified user.

See also: AWS API Documentation

Request Syntax

response = client.update_user_hierarchy(
    HierarchyGroupId='string',
    UserId='string',
    InstanceId='string'
)
Parameters
  • HierarchyGroupId (string) -- The identifier of the hierarchy group.
  • UserId (string) --

    [REQUIRED]

    The identifier of the user account.

  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

Returns

None

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
update_user_identity_info(**kwargs)

Updates the identity information for the specified user.

Warning

Someone with the ability to invoke UpdateUserIndentityInfo can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. We strongly recommend limiting who has the ability to invoke UpdateUserIndentityInfo . For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Request Syntax

response = client.update_user_identity_info(
    IdentityInfo={
        'FirstName': 'string',
        'LastName': 'string',
        'Email': 'string'
    },
    UserId='string',
    InstanceId='string'
)
Parameters
  • IdentityInfo (dict) --

    [REQUIRED]

    The identity information for the user.

    • FirstName (string) --

      The first name. This is required if you are using Amazon Connect or SAML for identity management.

    • LastName (string) --

      The last name. This is required if you are using Amazon Connect or SAML for identity management.

    • Email (string) --

      The email address. If you are using SAML for identity management and include this parameter, an error is returned.

  • UserId (string) --

    [REQUIRED]

    The identifier of the user account.

  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

Returns

None

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
update_user_phone_config(**kwargs)

Updates the phone configuration settings for the specified user.

See also: AWS API Documentation

Request Syntax

response = client.update_user_phone_config(
    PhoneConfig={
        'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
        'AutoAccept': True|False,
        'AfterContactWorkTimeLimit': 123,
        'DeskPhoneNumber': 'string'
    },
    UserId='string',
    InstanceId='string'
)
Parameters
  • PhoneConfig (dict) --

    [REQUIRED]

    Information about phone configuration settings for the user.

    • PhoneType (string) -- [REQUIRED]

      The phone type.

    • AutoAccept (boolean) --

      The Auto accept setting.

    • AfterContactWorkTimeLimit (integer) --

      The After Call Work (ACW) timeout setting, in seconds.

    • DeskPhoneNumber (string) --

      The phone number for the user's desk phone.

  • UserId (string) --

    [REQUIRED]

    The identifier of the user account.

  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

Returns

None

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
update_user_routing_profile(**kwargs)

Assigns the specified routing profile to the specified user.

See also: AWS API Documentation

Request Syntax

response = client.update_user_routing_profile(
    RoutingProfileId='string',
    UserId='string',
    InstanceId='string'
)
Parameters
  • RoutingProfileId (string) --

    [REQUIRED]

    The identifier of the routing profile for the user.

  • UserId (string) --

    [REQUIRED]

    The identifier of the user account.

  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

Returns

None

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException
update_user_security_profiles(**kwargs)

Assigns the specified security profiles to the specified user.

See also: AWS API Documentation

Request Syntax

response = client.update_user_security_profiles(
    SecurityProfileIds=[
        'string',
    ],
    UserId='string',
    InstanceId='string'
)
Parameters
  • SecurityProfileIds (list) --

    [REQUIRED]

    The identifiers of the security profiles for the user.

    • (string) --
  • UserId (string) --

    [REQUIRED]

    The identifier of the user account.

  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

Returns

None

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException

Paginators

The available paginators are:

class Connect.Paginator.GetMetricData
paginator = client.get_paginator('get_metric_data')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.get_metric_data().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    Filters={
        'Queues': [
            'string',
        ],
        'Channels': [
            'VOICE'|'CHAT',
        ]
    },
    Groupings=[
        'QUEUE'|'CHANNEL',
    ],
    HistoricalMetrics=[
        {
            'Name': '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',
                'ThresholdValue': 123.0
            },
            'Statistic': 'SUM'|'MAX'|'AVG',
            'Unit': 'SECONDS'|'COUNT'|'PERCENT'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • StartTime (datetime) --

    [REQUIRED]

    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.

  • EndTime (datetime) --

    [REQUIRED]

    The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

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

  • Filters (dict) --

    [REQUIRED]

    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 .

    • Queues (list) --

      The queues to use to filter the metrics. You can specify up to 100 queues per request.

      • (string) --
    • Channels (list) --

      The channel to use to filter the metrics.

      • (string) --
  • Groupings (list) --

    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.

    • (string) --
  • HistoricalMetrics (list) --

    [REQUIRED]

    The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide .

    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

    • (dict) --

      Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide .

      • Name (string) --

        The name of the metric.

      • Threshold (dict) --

        The threshold for the metric, used with service level metrics.

        • Comparison (string) --

          The type of comparison. Only "less than" (LT) comparisons are supported.

        • ThresholdValue (float) --

          The threshold value to compare.

      • Statistic (string) --

        The statistic for the metric.

      • Unit (string) --

        The unit for the metric.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'MetricResults': [
        {
            'Dimensions': {
                'Queue': {
                    'Id': 'string',
                    'Arn': 'string'
                },
                'Channel': 'VOICE'|'CHAT'
            },
            'Collections': [
                {
                    'Metric': {
                        'Name': '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',
                            'ThresholdValue': 123.0
                        },
                        'Statistic': 'SUM'|'MAX'|'AVG',
                        'Unit': 'SECONDS'|'COUNT'|'PERCENT'
                    },
                    'Value': 123.0
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • MetricResults (list) --

      Information about the historical metrics.

      If no grouping is specified, a summary of metric data is returned.

      • (dict) --

        Contains information about the historical metrics retrieved.

        • Dimensions (dict) --

          The dimension for the metrics.

          • Queue (dict) --

            Information about the queue for which metrics are returned.

            • Id (string) --

              The identifier of the queue.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the queue.

          • Channel (string) --

            The channel used for grouping and filters.

        • Collections (list) --

          The set of metrics.

          • (dict) --

            Contains the data for a historical metric.

            • Metric (dict) --

              Information about the metric.

              • Name (string) --

                The name of the metric.

              • Threshold (dict) --

                The threshold for the metric, used with service level metrics.

                • Comparison (string) --

                  The type of comparison. Only "less than" (LT) comparisons are supported.

                • ThresholdValue (float) --

                  The threshold value to compare.

              • Statistic (string) --

                The statistic for the metric.

              • Unit (string) --

                The unit for the metric.

            • Value (float) --

              The value of the metric.

class Connect.Paginator.ListContactFlows
paginator = client.get_paginator('list_contact_flows')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_contact_flows().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    ContactFlowTypes=[
        'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • ContactFlowTypes (list) --

    The type of contact flow.

    • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ContactFlowSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'ContactFlowType': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER'
        },
    ],

}

Response Structure

  • (dict) --

    • ContactFlowSummaryList (list) --

      Information about the contact flows.

      • (dict) --

        Contains summary information about a contact flow.

        • Id (string) --

          The identifier of the contact flow.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the contact flow.

        • Name (string) --

          The name of the contact flow.

        • ContactFlowType (string) --

          The type of contact flow.

class Connect.Paginator.ListHoursOfOperations
paginator = client.get_paginator('list_hours_of_operations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_hours_of_operations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'HoursOfOperationSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • HoursOfOperationSummaryList (list) --

      Information about the hours of operation.

      • (dict) --

        Contains summary information about hours of operation for a contact center.

        • Id (string) --

          The identifier of the hours of operation.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the hours of operation.

        • Name (string) --

          The name of the hours of operation.

class Connect.Paginator.ListPhoneNumbers
paginator = client.get_paginator('list_phone_numbers')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_phone_numbers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    PhoneNumberTypes=[
        'TOLL_FREE'|'DID',
    ],
    PhoneNumberCountryCodes=[
        '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',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • PhoneNumberTypes (list) --

    The type of phone number.

    • (string) --
  • PhoneNumberCountryCodes (list) --

    The ISO country code.

    • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'PhoneNumberSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'PhoneNumber': 'string',
            'PhoneNumberType': 'TOLL_FREE'|'DID',
            'PhoneNumberCountryCode': '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'
        },
    ],

}

Response Structure

  • (dict) --

    • PhoneNumberSummaryList (list) --

      Information about the phone numbers.

      • (dict) --

        Contains summary information about a phone number for a contact center.

        • Id (string) --

          The identifier of the phone number.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the phone number.

        • PhoneNumber (string) --

          The phone number.

        • PhoneNumberType (string) --

          The type of phone number.

        • PhoneNumberCountryCode (string) --

          The ISO country code.

class Connect.Paginator.ListQueues
paginator = client.get_paginator('list_queues')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_queues().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    QueueTypes=[
        'STANDARD'|'AGENT',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • QueueTypes (list) --

    The type of queue.

    • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'QueueSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'QueueType': 'STANDARD'|'AGENT'
        },
    ],

}

Response Structure

  • (dict) --

    • QueueSummaryList (list) --

      Information about the queues.

      • (dict) --

        Contains summary information about a queue.

        • Id (string) --

          The identifier of the queue.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the queue.

        • Name (string) --

          The name of the queue.

        • QueueType (string) --

          The type of queue.

class Connect.Paginator.ListRoutingProfiles
paginator = client.get_paginator('list_routing_profiles')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_routing_profiles().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'RoutingProfileSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • RoutingProfileSummaryList (list) --

      Information about the routing profiles.

      • (dict) --

        Contains summary information about a routing profile.

        • Id (string) --

          The identifier of the routing profile.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the routing profile.

        • Name (string) --

          The name of the routing profile.

class Connect.Paginator.ListSecurityProfiles
paginator = client.get_paginator('list_security_profiles')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_security_profiles().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'SecurityProfileSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • SecurityProfileSummaryList (list) --

      Information about the security profiles.

      • (dict) --

        Contains information about a security profile.

        • Id (string) --

          The identifier of the security profile.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the security profile.

        • Name (string) --

          The name of the security profile.

class Connect.Paginator.ListUserHierarchyGroups
paginator = client.get_paginator('list_user_hierarchy_groups')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_user_hierarchy_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'UserHierarchyGroupSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • UserHierarchyGroupSummaryList (list) --

      Information about the hierarchy groups.

      • (dict) --

        Contains summary information about a hierarchy group.

        • Id (string) --

          The identifier of the hierarchy group.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the hierarchy group.

        • Name (string) --

          The name of the hierarchy group.

class Connect.Paginator.ListUsers
paginator = client.get_paginator('list_users')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_users().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'UserSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Username': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • UserSummaryList (list) --

      Information about the users.

      • (dict) --

        Contains summary information about a user.

        • Id (string) --

          The identifier of the user account.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the user account.

        • Username (string) --

          The Amazon Connect user name of the user account.