ResourceGroups / Client / get_tag_sync_task

get_tag_sync_task#

ResourceGroups.Client.get_tag_sync_task(**kwargs)#

Returns information about a specified tag-sync task.

Minimum permissions

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

  • resource-groups:GetTagSyncTask on the application group

See also: AWS API Documentation

Request Syntax

response = client.get_tag_sync_task(
    TaskArn='string'
)
Parameters:

TaskArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    '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) –

    • 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 Resource Groups to tag and untag resources on your behalf.

      For more information about this role, review Tag-sync required permissions.

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

Exceptions