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. To start a tag-sync task, you need a resource tagging role. The resource tagging role grants permissions to tag and untag applications resources and must include a trust policy that allows Resource Groups to assume the role and perform resource tagging tasks on your behalf.

For instructions on creating a tag-sync task, see Create a tag-sync using the Resource Groups API in the Amazon Web Services Service Catalog AppRegistry Administrator Guide.

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

Request Syntax

response = client.start_tag_sync_task(
    Group='string',
    TagKey='string',
    TagValue='string',
    ResourceQuery={
        'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
        'Query': '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) –
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.

When using the TagKey parameter, you must also specify the TagValue parameter. If you specify a tag key-value pair, you can’t use the ResourceQuery parameter.
TagValue (string) –
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.

When using the TagValue parameter, you must also specify the TagKey parameter. If you specify a tag key-value pair, you can’t use the ResourceQuery parameter.
ResourceQuery (dict) –
The query you can use to create the tag-sync task. With this method, all resources matching the query are added to the specified application group. A ResourceQuery specifies both a query Type and a Query string as JSON string objects. For more information on defining a resource query for a tag-sync task, see the tag-based query type in Types of resource group queries in Resource Groups User Guide.

When using the ResourceQuery parameter, you cannot use the TagKey and TagValue parameters.

When you combine all of the elements together into a single string, any double quotes that are embedded inside another double quote pair must be escaped by preceding the embedded double quote with a backslash character (). For example, a complete ResourceQuery parameter must be formatted like the following CLI parameter example:

--resource-query '{"Type":"TAG_FILTERS_1_0","Query":"{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}"}'

In the preceding example, all of the double quote characters in the value part of the Query element must be escaped because the value itself is surrounded by double quotes. For more information, see Quoting strings in the Command Line Interface User Guide.

For the complete list of resource types that you can use in the array value for ResourceTypeFilters, see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide. For example:

"ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]
- Type (string) – [REQUIRED]
  
  The type of the query to perform. This can have one of two values:
  - CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an Amazon resource name (ARN) for a CloudFormation stack.
  - TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.
- Query (string) – [REQUIRED]
  
  The query that defines a group or a search. The contents depends on the value of the Type element.
  - ResourceTypeFilters – Applies to all ResourceQuery objects of either Type. This element contains one of the following two items:
    - The value AWS::AllSupported. This causes the ResourceQuery to match resources of any resource type that also match the query.
    - A list (a JSON array) of resource type identifiers that limit the query to only resources of the specified types. For the complete list of resource types that you can use in the array value for ResourceTypeFilters, see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide.
  Example: "ResourceTypeFilters": ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]
  - TagFilters – applicable only if Type = TAG_FILTERS_1_0. The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values. For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] The results of this resource query could include the following.
    - An Amazon EC2 instance that has the following two tags: {"Stage":"Deploy"}, and {"Version":"2"}
    - An S3 bucket that has the following two tags: {"Stage":"Test"}, and {"Version":"1"}
  The resource query results would not include the following items in the results, however.
  - An Amazon EC2 instance that has only the following tag: {"Stage":"Deploy"}. The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.
  - An RDS database that has the following two tags: {"Stage":"Archived"} and {"Version":"4"} The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.
  Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }
  - StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0. The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.
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',
    'ResourceQuery': {
        'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
        'Query': '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.
- ResourceQuery (dict) –
  
  The query you can use to define a resource group or a search for resources. A ResourceQuery specifies both a query Type and a Query string as JSON string objects. See the examples section for example JSON strings. For more information about creating a resource group with a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide
  
  When you combine all of the elements together into a single string, any double quotes that are embedded inside another double quote pair must be escaped by preceding the embedded double quote with a backslash character (). For example, a complete ResourceQuery parameter must be formatted like the following CLI parameter example:
  
  --resource-query '{"Type":"TAG_FILTERS_1_0","Query":"{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}"}'
  
  In the preceding example, all of the double quote characters in the value part of the Query element must be escaped because the value itself is surrounded by double quotes. For more information, see Quoting strings in the Command Line Interface User Guide.
  
  For the complete list of resource types that you can use in the array value for ResourceTypeFilters, see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide. For example:
  
  "ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]
  - Type (string) –
    
    The type of the query to perform. This can have one of two values:
    - CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an Amazon resource name (ARN) for a CloudFormation stack.
    - TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.
  - Query (string) –
    
    The query that defines a group or a search. The contents depends on the value of the Type element.
    - ResourceTypeFilters – Applies to all ResourceQuery objects of either Type. This element contains one of the following two items:
      - The value AWS::AllSupported. This causes the ResourceQuery to match resources of any resource type that also match the query.
      - A list (a JSON array) of resource type identifiers that limit the query to only resources of the specified types. For the complete list of resource types that you can use in the array value for ResourceTypeFilters, see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide.
    Example: "ResourceTypeFilters": ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]
    - TagFilters – applicable only if Type = TAG_FILTERS_1_0. The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values. For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] The results of this resource query could include the following.
      - An Amazon EC2 instance that has the following two tags: {"Stage":"Deploy"}, and {"Version":"2"}
      - An S3 bucket that has the following two tags: {"Stage":"Test"}, and {"Version":"1"}
    The resource query results would not include the following items in the results, however.
    An Amazon EC2 instance that has only the following tag: {"Stage":"Deploy"}. The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.
    
    An RDS database that has the following two tags: {"Stage":"Archived"} and {"Version":"4"} The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.
    Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }
    - StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0. The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.
- RoleArn (string) –
  
  The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.

Exceptions

ResourceGroups.Client.exceptions.UnauthorizedException
ResourceGroups.Client.exceptions.BadRequestException
ResourceGroups.Client.exceptions.ForbiddenException
ResourceGroups.Client.exceptions.NotFoundException
ResourceGroups.Client.exceptions.MethodNotAllowedException
ResourceGroups.Client.exceptions.TooManyRequestsException
ResourceGroups.Client.exceptions.InternalServerErrorException