AWS Elemental MediaConvert API Reference
API Reference
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

Tags

URI

/2017-08-29/tags

HTTP Methods

POST

Operation ID: TagResource

Add tags to a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html

Responses

Status Code Response Model Description
200 TagResourceResponse

200 response

400 ExceptionBody

The service can't process your request because of a problem in the request. Please check your request form and syntax.

403 ExceptionBody

You don't have permissions for this action with the credentials you sent.

404 ExceptionBody

The resource you requested does not exist.

409 ExceptionBody

The service could not complete your request because there is a conflict with the current state of the resource.

429 ExceptionBody

Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

500 ExceptionBody

The service encountered an unexpected condition and cannot fulfill your request.

DELETE

Operation ID: UntagResourceByDelete

Deprecated: Use PUT operation instead. Remove tags from a MediaConvert queue, preset, or job template.

Responses

Status Code Response Model Description
200 UntagResourceResponse

200 response

400 ExceptionBody

The service can't process your request because of a problem in the request. Please check your request form and syntax.

403 ExceptionBody

You don't have permissions for this action with the credentials you sent.

404 ExceptionBody

The resource you requested does not exist.

409 ExceptionBody

The service could not complete your request because there is a conflict with the current state of the resource.

429 ExceptionBody

Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

500 ExceptionBody

The service encountered an unexpected condition and cannot fulfill your request.

OPTIONS

Supports CORS preflight requests.

Responses

Status Code Response Model Description
200 None

The request completed successfully.

Schemas

Request Bodies

Example POST

{ "arn": "string", "tags": { } }

Example DELETE

{ "arn": "string", "tagKeys": [ "string" ] }

Response Bodies

Example TagResourceResponse

{ }

Example UntagResourceResponse

{ }

Example ExceptionBody

{ "message": "string" }

Properties

ExceptionBody

Property Type Required Description
message

string

False

TagResourceRequest

To add tags to a queue, preset, or job template, send a request with the Amazon Resource Name (ARN) of the resource and the tags that you want to add.

Property Type Required Description
arn

string

True

The Amazon Resource Name (ARN) of the resource that you want to tag. To get the ARN, send a GET request with the resource name.

tags

object

True

The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.

TagResourceResponse

A successful request to add tags to a resource returns an OK message.

UntagResourceRequest

To remove tags from a resource, send a request with the Amazon Resource Name (ARN) of the resource and the keys of the tags that you want to remove.

Property Type Required Description
arn

string

False

The Amazon Resource Name (ARN) of the resource that you want to remove tags from. To get the ARN, send a GET request with the resource name.

tagKeys

Array of type string

False

The keys of the tags that you want to remove from the resource.

UntagResourceResponse

A successful request to remove tags from a resource returns an OK message.

See Also

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

TagResource

UntagResourceByDelete