public class ListResourceTagsRequest extends AmazonWebServiceRequest implements java.io.Serializable
Returns all tags on the specified customer master key (CMK).
For general information about tags, including the format and syntax, see Tagging AWS resources in the Amazon Web Services General Reference. For information about using tags in AWS KMS, see Tagging keys.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:ListResourceTags (key policy)
Related operations:
Constructor and Description |
---|
ListResourceTagsRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getKeyId()
A unique identifier for the customer master key (CMK).
|
java.lang.Integer |
getLimit()
Use this parameter to specify the maximum number of items to return.
|
java.lang.String |
getMarker()
Use this parameter in a subsequent request after you receive a response
with truncated results.
|
int |
hashCode() |
void |
setKeyId(java.lang.String keyId)
A unique identifier for the customer master key (CMK).
|
void |
setLimit(java.lang.Integer limit)
Use this parameter to specify the maximum number of items to return.
|
void |
setMarker(java.lang.String marker)
Use this parameter in a subsequent request after you receive a response
with truncated results.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ListResourceTagsRequest |
withKeyId(java.lang.String keyId)
A unique identifier for the customer master key (CMK).
|
ListResourceTagsRequest |
withLimit(java.lang.Integer limit)
Use this parameter to specify the maximum number of items to return.
|
ListResourceTagsRequest |
withMarker(java.lang.String marker)
Use this parameter in a subsequent request after you receive a response
with truncated results.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.String getKeyId()
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
Constraints:
Length: 1 - 2048
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
public void setKeyId(java.lang.String keyId)
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
Constraints:
Length: 1 - 2048
keyId
- A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
public ListResourceTagsRequest withKeyId(java.lang.String keyId)
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 2048
keyId
- A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
public java.lang.Integer getLimit()
Use this parameter to specify the maximum number of items to return. When this value is present, AWS 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.
Constraints:
Range: 1 - 1000
Use this parameter to specify the maximum number of items to return. When this value is present, AWS 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.
public void setLimit(java.lang.Integer limit)
Use this parameter to specify the maximum number of items to return. When this value is present, AWS 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.
Constraints:
Range: 1 - 1000
limit
- Use this parameter to specify the maximum number of items to return. When this value is present, AWS 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.
public ListResourceTagsRequest withLimit(java.lang.Integer limit)
Use this parameter to specify the maximum number of items to return. When this value is present, AWS 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 1000
limit
- Use this parameter to specify the maximum number of items to return. When this value is present, AWS 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.
public java.lang.String getMarker()
Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of NextMarker
from the truncated response you just received.
Do not attempt to construct this value. Use only the value of
NextMarker
from the truncated response you just received.
Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*
Use this parameter in a subsequent request after you receive a
response with truncated results. Set it to the value of
NextMarker
from the truncated response you just
received.
Do not attempt to construct this value. Use only the value of
NextMarker
from the truncated response you just
received.
public void setMarker(java.lang.String marker)
Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of NextMarker
from the truncated response you just received.
Do not attempt to construct this value. Use only the value of
NextMarker
from the truncated response you just received.
Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*
marker
-
Use this parameter in a subsequent request after you receive a
response with truncated results. Set it to the value of
NextMarker
from the truncated response you just
received.
Do not attempt to construct this value. Use only the value of
NextMarker
from the truncated response you just
received.
public ListResourceTagsRequest withMarker(java.lang.String marker)
Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of NextMarker
from the truncated response you just received.
Do not attempt to construct this value. Use only the value of
NextMarker
from the truncated response you just received.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*
marker
-
Use this parameter in a subsequent request after you receive a
response with truncated results. Set it to the value of
NextMarker
from the truncated response you just
received.
Do not attempt to construct this value. Use only the value of
NextMarker
from the truncated response you just
received.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.