Request Syntax Request Parameters Response Elements Errors Examples See Also

TagResource

Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.

Request Syntax


{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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 that you want to update tags for.

It must be the ARN of an App Runner resource.

Type: String

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

Pattern: arn:aws(-[\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\w|\/|-){1,1011}

Required: Yes

Tags

A list of tag key-value pairs to add or update. If a key is new to the resource, the tag is added with the provided value. If a key is already associated with the resource, the value of the tag is updated.

Type: Array of Tag objects

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.

InternalServiceErrorException

An unexpected service exception occurred.

HTTP Status Code: 500

InvalidRequestException

One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.

HTTP Status Code: 400

InvalidStateException

You can't perform this action when the resource is in its current state.

HTTP Status Code: 400

ResourceNotFoundException

A resource doesn't exist for the specified Amazon Resource Name (ARN) in your AWS account.

HTTP Status Code: 400

Examples

Add tags to an App Runner service

This example illustrates how to add two tags to an App Runner service.

Sample Request


$ aws apprunner tag-resource --cli-input-json "`cat`"
{
  "ResourceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa",
  "Tags": [
    {
      "Key": "Department", 
      "Value": "Retail"
    },
    {
      "Key": "CustomerId", 
      "Value": "56439872357912"
    }
  ]
}

Sample Response

{
}