ResourceGroups / Paginator / ListTagSyncTasks

ListTagSyncTasks

class ResourceGroups.Paginator.ListTagSyncTasks

paginator = client.get_paginator('list_tag_sync_tasks')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'GroupArn': 'string',
            'GroupName': 'string'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (list) –

  The Amazon resource name (ARN) or name of the application group for which you want to return a list of tag-sync tasks.

  • (dict) –

    Returns tag-sync tasks filtered by the Amazon resource name (ARN) or name of a specified application group.

    • GroupArn (string) –

      The Amazon resource name (ARN) of the application group.

    • GroupName (string) –

      The name of the application group.

• 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

{
    'TagSyncTasks': [
        {
            'GroupArn': 'string',
            'GroupName': 'string',
            'TaskArn': 'string',
            'TagKey': 'string',
            'TagValue': 'string',
            'RoleArn': 'string',
            'Status': 'ACTIVE'|'ERROR',
            'ErrorMessage': 'string',
            'CreatedAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • TagSyncTasks (list) –

    A list of tag-sync tasks and information about each task.

    • (dict) –

      The Amazon resource name (ARN) of the tag-sync task.

      • GroupArn (string) –

        The Amazon resource name (ARN) of the application group.

      • GroupName (string) –

        The name of the application group.

      • TaskArn (string) –

        The Amazon resource name (ARN) of the tag-sync task.

      • TagKey (string) –

        The tag key.

      • TagValue (string) –

        The tag value.

      • RoleArn (string) –

        The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.

      • Status (string) –

        The status of the tag-sync task.

        Valid values include:

        • ACTIVE - The tag-sync task is actively managing resources in the application by adding or removing the awsApplication tag from resources when they are tagged or untagged with the specified tag key-value pair.

        • ERROR - The tag-sync task is not actively managing resources in the application. Review the ErrorMessage for more information about resolving the error.

      • ErrorMessage (string) –

        The specific error message in cases where the tag-sync task status is Error.

      • CreatedAt (datetime) –

        The timestamp of when the tag-sync task was created.