Amazon Connect Service

Searches users in an Amazon Connect instance, with optional filtering.

See also: AWS API Documentation

Request Syntax

client.search_users(
    InstanceId='string',
    NextToken='string',
    MaxResults=123,
    SearchFilter={
        'TagFilter': {
            'OrConditions': [
                [
                    {
                        'TagKey': 'string',
                        'TagValue': 'string'
                    },
                ],
            ],
            'AndConditions': [
                {
                    'TagKey': 'string',
                    'TagValue': 'string'
                },
            ],
            'TagCondition': {
                'TagKey': 'string',
                'TagValue': 'string'
            }
        }
    },
    SearchCriteria={
        'OrConditions': [
            {'... recursive ...'},
        ],
        'AndConditions': [
            {'... recursive ...'},
        ],
        'StringCondition': {
            'FieldName': 'string',
            'Value': 'string',
            'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
        },
        'HierarchyGroupCondition': {
            'Value': 'string',
            'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS'
        }
    }
)

type InstanceId

string

param InstanceId

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

type NextToken

string

param NextToken

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.

type MaxResults

integer

param MaxResults

The maximum number of results to return per page.

type SearchFilter

dict

param SearchFilter

Filters to be applied to search results.

• TagFilter (dict) --

  An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR of AND (List of List) input where:

  • Top level list specifies conditions that need to be applied with OR operator

  • Inner list specifies conditions that need to be applied with AND operator.

  • OrConditions (list) --

    A list of conditions which would be applied together with an OR condition.

    • (list) --

      • (dict) --

        A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .

        • TagKey (string) --

          The tag key in the tag condition.

        • TagValue (string) --

          The tag value in the tag condition.

  • AndConditions (list) --

    A list of conditions which would be applied together with an AND condition.

    • (dict) --

      A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .

      • TagKey (string) --

        The tag key in the tag condition.

      • TagValue (string) --

        The tag value in the tag condition.

  • TagCondition (dict) --

    A leaf node condition which can be used to specify a tag condition.

    • TagKey (string) --

      The tag key in the tag condition.

    • TagValue (string) --

      The tag value in the tag condition.

type SearchCriteria

dict

param SearchCriteria

The search criteria to be used to return users.

• OrConditions (list) --

  A list of conditions which would be applied together with an OR condition.

  • (dict) --

    The search criteria to be used to return users.

• AndConditions (list) --

  A list of conditions which would be applied together with an AND condition.

  • (dict) --

    The search criteria to be used to return users.

• StringCondition (dict) --

  A leaf node condition which can be used to specify a string condition.

  • FieldName (string) --

    The name of the field in the string condition.

  • Value (string) --

    The value of the string.

  • ComparisonType (string) --

    The type of comparison to be made when evaluating the string condition.

• HierarchyGroupCondition (dict) --

  A leaf node condition which can be used to specify a hierarchy group condition.

  • Value (string) --

    The value in the hierarchy group condition.

  • HierarchyGroupMatchType (string) --

    The type of hierarchy group match.

rtype

dict

returns

Response Syntax

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

Response Structure

• (dict) --

  • Users (list) --

    Information about the users.

    • (dict) --

      Information about the returned users.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the user.

      • DirectoryUserId (string) --

        The directory identifier of the user.

      • HierarchyGroupId (string) --

        The identifier of the user's hierarchy group.

      • Id (string) --

        The identifier of the user's summary.

      • IdentityInfo (dict) --

        The user's first name and last name.

        • FirstName (string) --

          The user's first name.

        • LastName (string) --

          The user's last name.

      • PhoneConfig (dict) --

        Contains information about the phone configuration settings for a 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.

      • RoutingProfileId (string) --

        The identifier of the user's routing profile.

      • SecurityProfileIds (list) --

        The identifiers of the user's security profiles.

        • (string) --

      • Tags (dict) --

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

        • (string) --

          • (string) --

      • Username (string) --

        The name of the user.

  • NextToken (string) --

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

  • ApproximateTotalCount (integer) --

    The total number of users who matched your search query.