AWS Greengrass
API Reference

/tags/resource-arn

GET

GET /tags/resource-arn

Operation ID: ListTagsForResource

Lists tags for a resource.

Produces: application/json

CLI

aws greengrass list-tags-for-resource \ --resource-arn <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "ResourceArn": "string" }

Parameters:

ResourceArn

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

where used: path; required: true

type: string

Responses

200

HTTP Status Code 200: OK.

tags

{ "tags": { "keyName0": "value0", "keyName1": "value1", "keyName2": "value2" } }

The resource tags.

type: object

additionalProperties: The key-value pair for the resource tag. Type: string

400

invalid request

GeneralError

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string

POST

POST /tags/resource-arn

Operation ID: TagResource

Adds tags to a resource.

Produces: application/json

CLI

aws greengrass tag-resource \ --resource-arn <value> \ --tags <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "ResourceArn": "string", "tags": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" } }

Parameters:

ResourceArn

The Amazon Resource Name (ARN) of the resource to attach the tags to.

where used: path; required: true

type: string

tags

A map of the key-value pairs for the resource tag.

where used: body; required: true

type: tags

Responses

204

HTTP Status Code 204: Successful response.

400

invalid request

GeneralError

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string

DELETE

DELETE /tags/resource-arn

Operation ID: UntagResource

Removes tags from a resource.

Produces: application/json

CLI

aws greengrass untag-resource \ --resource-arn <value> \ --tag-keys <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "ResourceArn": "string", "TagKeys": [ "string" ] }

Parameters:

TagKeys

An array of tag keys to delete.

where used: query; required: true

type: array of strings

ResourceArn

The Amazon Resource Name (ARN) of the resource to remove the tags from.

where used: path; required: true

type: string

Responses

204

HTTP Status Code 204: Successful response.

400

invalid request

GeneralError

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string

On this page: