GetTagsCommand

Suggest an Edit

Gets the Tags collection for a given resource.

Example Syntax

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

import { APIGatewayClient, GetTagsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
// const { APIGatewayClient, GetTagsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
const client = new APIGatewayClient(config);
const input = { // GetTagsRequest
  resourceArn: "STRING_VALUE", // required
  position: "STRING_VALUE",
  limit: Number("int"),
};
const command = new GetTagsCommand(input);
const response = await client.send(command);
// { // Tags
//   tags: { // MapOfStringToString
//     "<keys>": "STRING_VALUE",
//   },
// };

GetTagsCommand Input

See GetTagsCommandInput for more details

Parameter
Type
Description
resourceArn
Required
string | undefined

The ARN of a resource that can be tagged.

limit
number | undefined

(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position
string | undefined

(Not currently supported) The current pagination position in the paged result set.

GetTagsCommand Output

See GetTagsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
tags
Record<string, string> | undefined

The collection of tags. Each tag element is associated with a given resource.

Throws

Name
Fault
Details
BadRequestException
client

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

NotFoundException
client

The requested resource is not found. Make sure that the request URI is correct.

TooManyRequestsException
client

The request has reached its throttling limit. Retry after the specified time period.

UnauthorizedException
client

The request is denied because the caller has insufficient permissions.

APIGatewayServiceException
Base exception class for all service exceptions from APIGateway service.