ResourceGroups / Client / list_grouping_statuses

list_grouping_statuses#

ResourceGroups.Client.list_grouping_statuses(**kwargs)#

Returns the status of the last grouping or ungrouping action for each resource in the specified application group.

See also: AWS API Documentation

Request Syntax

response = client.list_grouping_statuses(
    Group='string',
    MaxResults=123,
    Filters=[
        {
            'Name': 'status'|'resource-arn',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string'
)
Parameters:

  • Group (string) –

    [REQUIRED]

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

  • MaxResults (integer) – The maximum number of resources and their statuses returned in the response.

  • 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) –

  • NextToken (string) – The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call’s NextToken response to indicate where the output should continue from.

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)
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

Exceptions