Container for the parameters to the ListResourceTags operation. Returns all tags on the specified KMS key.
For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference. For information about using tags in KMS, see Tagging keys.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:ListResourceTags (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
Amazon.KeyManagementService.Model.ListResourceTagsRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class ListResourceTagsRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The ListResourceTagsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListResourceTagsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
KeyId | System.String |
Gets and sets the property KeyId. Gets tags on the specified KMS key. Specify the key ID or key ARN of the KMS key. For example:
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. |
|
|
Limit | System.Int32 |
Gets and sets the property Limit. Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 50, inclusive. If you do not include a value, it defaults to 50. |
|
|
Marker | System.String |
Gets and sets the property Marker.
Use this parameter in a subsequent request after you receive a response with truncated
results. Set it to the value of
Do not attempt to construct this value. Use only the value of |
Examples
The following example lists tags for a KMS key.
To list tags for a KMS key
var client = new AmazonKeyManagementServiceClient();
var response = client.ListResourceTags(new ListResourceTagsRequest
{
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab" // The identifier of the KMS key whose tags you are listing. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
});
List<Tag> tags = response.Tags; // A list of tags.
bool truncated = response.Truncated; // A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5