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

ListTagSyncTasks

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

Request Syntax


POST /list-tag-sync-tasks HTTP/1.1
Content-type: application/json

{
   "Filters": [ 
      { 
         "GroupArn": "string",
         "GroupName": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Filters

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

Type: Array of ListTagSyncTasksFilter objects

Required: No

MaxResults

The maximum number of results to be included in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

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.

Type: String

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

Pattern: ^[a-zA-Z0-9+/]*={0,2}$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "TagSyncTasks": [ 
      { 
         "CreatedAt": number,
         "ErrorMessage": "string",
         "GroupArn": "string",
         "GroupName": "string",
         "ResourceQuery": { 
            "Query": "string",
            "Type": "string"
         },
         "RoleArn": "string",
         "Status": "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.

NextToken

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.

Type: String

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

Pattern: ^[a-zA-Z0-9+/]*={0,2}$

TagSyncTasks

A list of tag-sync tasks and information about each task.

Type: Array of TagSyncTaskItem objects

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

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