public class ListAliasesRequest extends AmazonWebServiceRequest implements java.io.Serializable
Gets a list of aliases in the caller's AWS account and region. For more information about aliases, see CreateAlias.
By default, the ListAliases
operation returns all aliases in the
account and region. To get only the aliases associated with a particular
customer master key (CMK), use the KeyId
parameter.
The ListAliases
response can include aliases that you created
and associated with your customer managed CMKs, and aliases that AWS created
and associated with AWS managed CMKs in your account. You can recognize AWS
aliases because their names have the format
aws/<service-name>
, such as aws/dynamodb
.
The response might also include aliases that have no TargetKeyId
field. These are predefined aliases that AWS has created but has not yet
associated with a CMK. Aliases that AWS creates in your account, including
predefined aliases, do not count against your AWS KMS aliases quota.
Cross-account use: No. ListAliases
does not return
aliases in other AWS accounts.
Required permissions: kms:ListAliases (IAM policy)
For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.
Related operations:
Constructor and Description |
---|
ListAliasesRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getKeyId()
Lists only aliases that are associated with the specified 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)
Lists only aliases that are associated with the specified 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.
|
ListAliasesRequest |
withKeyId(java.lang.String keyId)
Lists only aliases that are associated with the specified CMK.
|
ListAliasesRequest |
withLimit(java.lang.Integer limit)
Use this parameter to specify the maximum number of items to return.
|
ListAliasesRequest |
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()
Lists only aliases that are associated with the specified CMK. Enter a CMK in your AWS account.
This parameter is optional. If you omit it, ListAliases
returns all aliases in the account and Region.
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
Lists only aliases that are associated with the specified CMK. Enter a CMK in your AWS account.
This parameter is optional. If you omit it,
ListAliases
returns all aliases in the account and
Region.
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)
Lists only aliases that are associated with the specified CMK. Enter a CMK in your AWS account.
This parameter is optional. If you omit it, ListAliases
returns all aliases in the account and Region.
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
- Lists only aliases that are associated with the specified CMK. Enter a CMK in your AWS account.
This parameter is optional. If you omit it,
ListAliases
returns all aliases in the account
and Region.
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 ListAliasesRequest withKeyId(java.lang.String keyId)
Lists only aliases that are associated with the specified CMK. Enter a CMK in your AWS account.
This parameter is optional. If you omit it, ListAliases
returns all aliases in the account and Region.
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
- Lists only aliases that are associated with the specified CMK. Enter a CMK in your AWS account.
This parameter is optional. If you omit it,
ListAliases
returns all aliases in the account
and Region.
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 100, 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 100, 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 100, 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 100, inclusive. If you do not include a value, it defaults to 50.
public ListAliasesRequest 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 100, 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 100, 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.
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.
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.
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.
public ListAliasesRequest 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.
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.
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.