TagResource
Adds or updates tags for a resource in Amazon CodeCommit. For a list of valid resources in Amazon CodeCommit, see CodeCommit Resources and Operations in the Amazon CodeCommit User Guide.
Request Syntax
{
"resourceArn": "string
",
"tags": {
"string
" : "string
"
}
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- resourceArn
-
The Amazon Resource Name (ARN) of the resource to which you want to add or update tags.
Type: String
Required: Yes
-
The key-value pair to use when tagging this repository.
Type: String to string map
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 Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidRepositoryNameException
-
A specified repository name is not valid.
Note
This exception occurs only when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
HTTP Status Code: 400
- InvalidResourceArnException
-
The value for the resource ARN is not valid. For more information about resources in Amazon CodeCommit, see CodeCommit Resources and Operations in the Amazon CodeCommit User Guide.
HTTP Status Code: 400
- InvalidSystemTagUsageException
-
The specified tag is not valid. Key names cannot be prefixed with aws:.
HTTP Status Code: 400
- InvalidTagsMapException
-
The map of tags is not valid.
HTTP Status Code: 400
- RepositoryDoesNotExistException
-
The specified repository does not exist.
HTTP Status Code: 400
- ResourceArnRequiredException
-
A valid Amazon Resource Name (ARN) for an Amazon CodeCommit resource is required. For a list of valid resources in Amazon CodeCommit, see CodeCommit Resources and Operations in the Amazon CodeCommit User Guide.
HTTP Status Code: 400
- TagPolicyException
-
The tag policy is not valid.
HTTP Status Code: 400
- TagsMapRequiredException
-
A map of tags is required.
HTTP Status Code: 400
- TooManyTagsException
-
The maximum number of tags for an Amazon CodeCommit resource has been exceeded.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of TagResource.
Sample Request
POST / HTTP/1.1
Host: codecommit.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: CodeCommit_20150413.TagResource
X-Amz-Date: 20190228T224019Z
User-Agent: aws-cli/1.11.187 Python/2.7.9 Windows/10
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151028/us-east-1/codecommit/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE
{
"resourceArn": "arn:aws:codecommit:us-east-2:123456789012:MySecretProjectRepo"
"tags": {
"Status": "Secret",
"Team": "Saanvi"
}
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 0728aaa8-EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 186
Date: Thu, 28 Feb 2019 22:40:19 GMT
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: