ResourceGroups / Client / list_tag_sync_tasks

list_tag_sync_tasks#

ResourceGroups.Client.list_tag_sync_tasks(**kwargs)#

Returns a list of tag-sync tasks.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:ListTagSyncTasks with the group passed in the filters as the resource or * if using no filters

See also: AWS API Documentation

Request Syntax

response = client.list_tag_sync_tasks(
    Filters=[
        {
            'GroupArn': 'string',
            'GroupName': 'string'
        },
    ],
    MaxResults=123,
    NextToken='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.

  • MaxResults (integer) – The maximum number of results to be included in the response.

  • 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

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

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.

    • 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