Connect / Paginator / SearchUserHierarchyGroups

SearchUserHierarchyGroups

class Connect.Paginator.SearchUserHierarchyGroups

paginator = client.get_paginator('search_user_hierarchy_groups')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    SearchFilter={
        'AttributeFilter': {
            'OrConditions': [
                {
                    'TagConditions': [
                        {
                            'TagKey': 'string',
                            'TagValue': 'string'
                        },
                    ]
                },
            ],
            'AndCondition': {
                'TagConditions': [
                    {
                        'TagKey': 'string',
                        'TagValue': 'string'
                    },
                ]
            },
            'TagCondition': {
                'TagKey': 'string',
                'TagValue': 'string'
            }
        }
    },
    SearchCriteria={
        'OrConditions': [
            {'... recursive ...'},
        ],
        'AndConditions': [
            {'... recursive ...'},
        ],
        'StringCondition': {
            'FieldName': 'string',
            'Value': 'string',
            'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
        }
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

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

• SearchFilter (dict) –

  Filters to be applied to search results.

  • AttributeFilter (dict) –

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

    • The top level list specifies conditions that need to be applied with OR operator.

    • The 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.

      • (dict) –

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

        • TagConditions (list) –

          A leaf node condition which can be used to specify a tag 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.

    • AndCondition (dict) –

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

      • TagConditions (list) –

        A leaf node condition which can be used to specify a tag 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, for example, HAVE BPO = 123.

      • TagKey (string) –

        The tag key in the tag condition.

      • TagValue (string) –

        The tag value in the tag condition.

• SearchCriteria (dict) –

  The search criteria to be used to return UserHierarchyGroups.

  • OrConditions (list) –

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

    • (dict) –

      The search criteria to be used to return userHierarchyGroup.

  • AndConditions (list) –

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

    • (dict) –

      The search criteria to be used to return userHierarchyGroup.

  • StringCondition (dict) –

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

    Note

    The currently supported values for FieldName are name,

parentId, levelId, and resourceID.

• 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.

type PaginationConfig:

dict

param PaginationConfig:

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.

rtype:

dict

returns:

Response Syntax

{
    'UserHierarchyGroups': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'LevelId': 'string',
            'HierarchyPath': {
                'LevelOne': {
                    'Id': 'string',
                    'Arn': 'string',
                    'Name': 'string',
                    'LastModifiedTime': datetime(2015, 1, 1),
                    'LastModifiedRegion': 'string'
                },
                'LevelTwo': {
                    'Id': 'string',
                    'Arn': 'string',
                    'Name': 'string',
                    'LastModifiedTime': datetime(2015, 1, 1),
                    'LastModifiedRegion': 'string'
                },
                'LevelThree': {
                    'Id': 'string',
                    'Arn': 'string',
                    'Name': 'string',
                    'LastModifiedTime': datetime(2015, 1, 1),
                    'LastModifiedRegion': 'string'
                },
                'LevelFour': {
                    'Id': 'string',
                    'Arn': 'string',
                    'Name': 'string',
                    'LastModifiedTime': datetime(2015, 1, 1),
                    'LastModifiedRegion': 'string'
                },
                'LevelFive': {
                    'Id': 'string',
                    'Arn': 'string',
                    'Name': 'string',
                    'LastModifiedTime': datetime(2015, 1, 1),
                    'LastModifiedRegion': 'string'
                }
            },
            'Tags': {
                'string': 'string'
            },
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ],
    'ApproximateTotalCount': 123
}

Response Structure

• (dict) –

  • UserHierarchyGroups (list) –

    Information about the userHierarchyGroups.

    • (dict) –

      Contains 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.

      • 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.

          • LastModifiedTime (datetime) –

            The timestamp when this resource was last modified.

          • LastModifiedRegion (string) –

            The Amazon Web Services Region where this resource was last modified.

        • 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.

          • LastModifiedTime (datetime) –

            The timestamp when this resource was last modified.

          • LastModifiedRegion (string) –

            The Amazon Web Services Region where this resource was last modified.

        • 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.

          • LastModifiedTime (datetime) –

            The timestamp when this resource was last modified.

          • LastModifiedRegion (string) –

            The Amazon Web Services Region where this resource was last modified.

        • 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.

          • LastModifiedTime (datetime) –

            The timestamp when this resource was last modified.

          • LastModifiedRegion (string) –

            The Amazon Web Services Region where this resource was last modified.

        • 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.

          • LastModifiedTime (datetime) –

            The timestamp when this resource was last modified.

          • LastModifiedRegion (string) –

            The Amazon Web Services Region where this resource was last modified.

      • Tags (dict) –

        The tags used to organize, track, or control access for this resource. For example, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.

        • (string) –

          • (string) –

      • LastModifiedTime (datetime) –

        The timestamp when this resource was last modified.

      • LastModifiedRegion (string) –

        The Amazon Web Services Region where this resource was last modified.

  • ApproximateTotalCount (integer) –

    The total number of userHierarchyGroups which matched your search query.