Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartTagSyncTask

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

Request Syntax


POST /start-tag-sync-task HTTP/1.1
Content-type: application/json

{
   "Group": "string",
   "RoleArn": "string",
   "TagKey": "string",
   "TagValue": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Group

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: [a-zA-Z0-9_\.-]{1,300}|[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26}|arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/([a-zA-Z0-9_\.-]{1,300}|[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26})

Required: Yes

RoleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Required: Yes

TagKey

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: Yes

TagValue

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

GroupArn

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

Type: String

Length Constraints: Minimum length of 12. Maximum length of 1600.

Pattern: arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/([a-zA-Z0-9_\.-]{1,300}|[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26})

GroupName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

Pattern: [a-zA-Z0-9_\.-]{1,300}|[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26}

RoleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

TagKey

The tag key of the tag-sync task.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

TagValue

The tag value of the tag-sync task.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

TaskArn

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

Type: String

Length Constraints: Minimum length of 12. Maximum length of 1600.

Pattern: arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26}/tag-sync-task/[a-z0-9]{26}

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The request includes one or more parameters that violate validation rules.

HTTP Status Code: 400

ForbiddenException

The caller isn't authorized to make the request. Check permissions.

HTTP Status Code: 403

InternalServerErrorException

An internal error occurred while processing the request. Try again later.

HTTP Status Code: 500

MethodNotAllowedException

The request uses an HTTP method that isn't allowed for the specified resource.

HTTP Status Code: 405

NotFoundException

One or more of the specified resources don't exist.

HTTP Status Code: 404

TooManyRequestsException

You've exceeded throttling limits by making too many requests in a period of time.

HTTP Status Code: 429

UnauthorizedException

The request was rejected because it doesn't have valid credentials for the target resource.

HTTP Status Code: 401