ResourceGroups / Client / start_tag_sync_task

start_tag_sync_task#

ResourceGroups.Client.start_tag_sync_task(**kwargs)#

Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application.

Minimum permissions

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

  • resource-groups:StartTagSyncTask on the application group

  • resource-groups:CreateGroup

  • iam:PassRole on the role provided in the request

See also: AWS API Documentation

Request Syntax

response = client.start_tag_sync_task(
    Group='string',
    TagKey='string',
    TagValue='string',
    RoleArn='string'
)
Parameters:

  • Group (string) –

    [REQUIRED]

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

  • TagKey (string) –

    [REQUIRED]

    The tag key. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application.

  • TagValue (string) –

    [REQUIRED]

    The tag value. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application.

  • RoleArn (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'GroupArn': 'string',
    'GroupName': 'string',
    'TaskArn': 'string',
    'TagKey': 'string',
    'TagValue': 'string',
    'RoleArn': 'string'
}

Response Structure

  • (dict) –

    • GroupArn (string) –

      The Amazon resource name (ARN) of the application group for which you want to add or remove resources.

    • GroupName (string) –

      The name of the application group to onboard and sync resources.

    • TaskArn (string) –

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

    • TagKey (string) –

      The tag key of the tag-sync task.

    • TagValue (string) –

      The tag value of the tag-sync task.

    • RoleArn (string) –

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

Exceptions