TagResource - Amazon CodeGuru Security


Use to add one or more tags to an existing scan.

Request Syntax

POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } }

URI Request Parameters

The request uses the following URI parameters.


The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.

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

Pattern: ^arn:aws:codeguru-security:[\S]+:[\d]{12}:scans\/[a-zA-Z0-9-_$:.]*$

Required: Yes

Request Body

The request accepts the following data in JSON format.


An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:

  • A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.

  • An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

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

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

Required: Yes

Response Syntax

HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.


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


You do not have sufficient access to perform this action.

HTTP Status Code: 403


The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

HTTP Status Code: 409


The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 500


The resource specified in the request was not found.

HTTP Status Code: 404


The request was denied due to request throttling.

HTTP Status Code: 429


The input fails to satisfy the specified constraints.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: