ResourceGroups / Paginator / ListGroupingStatuses

ListGroupingStatuses

class ResourceGroups.Paginator.ListGroupingStatuses

paginator = client.get_paginator('list_grouping_statuses')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ResourceGroups.Client.list_grouping_statuses().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Group='string',
    Filters=[
        {
            'Name': 'status'|'resource-arn',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Group (string) –

  [REQUIRED]

  The application group identifier, expressed as an Amazon resource name (ARN) or the application group name.

• Filters (list) –

  The filter name and value pair that is used to return more specific results from a list of resources.

  • (dict) –

    A filter name and value pair that is used to obtain more specific results from the list of grouping statuses.

    • Name (string) – [REQUIRED]

      The name of the filter. Filter names are case-sensitive.

    • Values (list) – [REQUIRED]

      One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.

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

{
    'Group': 'string',
    'GroupingStatuses': [
        {
            'ResourceArn': 'string',
            'Action': 'GROUP'|'UNGROUP',
            'Status': 'SUCCESS'|'FAILED'|'IN_PROGRESS'|'SKIPPED',
            'ErrorMessage': 'string',
            'ErrorCode': 'string',
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Group (string) –

    The application group identifier, expressed as an Amazon resource name (ARN) or the application group name.

  • GroupingStatuses (list) –

    Returns details about the grouping or ungrouping status of the resources in the specified application group.

    • (dict) –

      The information about a grouping or ungrouping resource action.

      • ResourceArn (string) –

        The Amazon resource name (ARN) of a resource.

      • Action (string) –

        Describes the resource grouping action with values of GROUP or UNGROUP.

      • Status (string) –

        Describes the resource grouping status with values of SUCCESS, FAILED, IN_PROGRESS, or SKIPPED.

      • ErrorMessage (string) –

        A message that explains the ErrorCode.

      • ErrorCode (string) –

        Specifies the error code that was raised.

      • UpdatedAt (datetime) –

        A timestamp of when the status was last updated.