Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

ListRoleTagsCommand

Lists the tags that are attached to the specified role. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

Example Syntax

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

import { IAMClient, ListRoleTagsCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, ListRoleTagsCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // ListRoleTagsRequest
  RoleName: "STRING_VALUE", // required
  Marker: "STRING_VALUE",
  MaxItems: Number("int"),
};
const command = new ListRoleTagsCommand(input);
const response = await client.send(command);
// { // ListRoleTagsResponse
//   Tags: [ // tagListType // required
//     { // Tag
//       Key: "STRING_VALUE", // required
//       Value: "STRING_VALUE", // required
//     },
//   ],
//   IsTruncated: true || false,
//   Marker: "STRING_VALUE",
// };

Example Usage

There was an error loading the code editor. Retry

ListRoleTagsCommand Input

See ListRoleTagsCommandInput for more details

Parameter	Type	Description
`RoleName` Required	`string \| undefined`	The name of the IAM role for which you want to see the list of tags. This parameter accepts (through its regex pattern ) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.-
`Marker`	`string \| undefined`	Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the `Marker` element in the response that you received to indicate where the next call should start.
`MaxItems`	`number \| undefined`	Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the `IsTruncated` response element is `true`. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the `IsTruncated` response element returns `true`, and `Marker` contains a value to include in the subsequent call that tells the service where to continue from.

ListRoleTagsCommand Output

See ListRoleTagsCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`Tags` Required	`Tag[] \| undefined`	The list of tags that are currently attached to the role. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.
`IsTruncated`	`boolean \| undefined`	A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the `Marker` request parameter to retrieve more items. Note that IAM might return fewer than the `MaxItems` number of results even when there are more results available. We recommend that you check `IsTruncated` after every call to ensure that you receive all your results.
`Marker`	`string \| undefined`	When `IsTruncated` is `true`, this element is present and contains the value to use for the `Marker` parameter in a subsequent pagination request.

Throws

Name	Fault	Details
NoSuchEntityException	client	The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
ServiceFailureException	server	The request processing has failed because of an unknown error, exception or failure.
IAMServiceException		Base exception class for all service exceptions from IAM service.

Getting Started