- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
TagResourceCommand
The ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ChimeSDKMediaPipelinesClient, TagResourceCommand } from "@aws-sdk/client-chime-sdk-media-pipelines"; // ES Modules import
// const { ChimeSDKMediaPipelinesClient, TagResourceCommand } = require("@aws-sdk/client-chime-sdk-media-pipelines"); // CommonJS import
const client = new ChimeSDKMediaPipelinesClient(config);
const input = { // TagResourceRequest
ResourceARN: "STRING_VALUE", // required
Tags: [ // TagList // required
{ // Tag
Key: "STRING_VALUE", // required
Value: "STRING_VALUE", // required
},
],
};
const command = new TagResourceCommand(input);
const response = await client.send(command);
// {};
TagResourceCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ResourceARN Required | string | undefined | The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's endpoint region, resource ID, and pipeline ID. |
Tags Required | Tag[] | undefined | The tags associated with the specified media pipeline. |
TagResourceCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
BadRequestException | client | The input parameters don't match the service's restrictions. |
ForbiddenException | client | The client is permanently forbidden from making the request. |
NotFoundException | client | One or more of the resources in the request does not exist in the system. |
ServiceFailureException | server | The service encountered an unexpected error. |
ServiceUnavailableException | server | The service is currently unavailable. |
ThrottledClientException | client | The client exceeded its request rate limit. |
UnauthorizedClientException | client | The client is not currently authorized to make the request. |
ChimeSDKMediaPipelinesServiceException | Base exception class for all service exceptions from ChimeSDKMediaPipelines service. |