AddTagsCommand

Adds or modifies tags for the specified pipeline.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataPipelineClient, AddTagsCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import
// const { DataPipelineClient, AddTagsCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import
const client = new DataPipelineClient(config);
const input = { // AddTagsInput
  pipelineId: "STRING_VALUE", // required
  tags: [ // tagList // required
    { // Tag
      key: "STRING_VALUE", // required
      value: "STRING_VALUE", // required
    },
  ],
};
const command = new AddTagsCommand(input);
const response = await client.send(command);
// {};

AddTagsCommand Input

See AddTagsCommandInput for more details

Parameter
Type
Description
pipelineId
Required
string | undefined

The ID of the pipeline.

tags
Required
Tag[] | undefined

The tags to add, as key/value pairs.

AddTagsCommand Output

See AddTagsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InternalServiceError
server

An internal service error occurred.

InvalidRequestException
client

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

PipelineDeletedException
client

The specified pipeline has been deleted.

PipelineNotFoundException
client

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

DataPipelineServiceException
Base exception class for all service exceptions from DataPipeline service.