@Generated(value="software.amazon.awssdk:codegen") public final class ListGrantsRequest extends KmsRequest implements ToCopyableBuilder<ListGrantsRequest.Builder,ListGrantsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ListGrantsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static ListGrantsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
String |
granteePrincipal()
Returns only grants where the specified principal is the grantee principal for the grant.
|
String |
grantId()
Returns only the grant with the specified grant ID.
|
int |
hashCode() |
String |
keyId()
Returns only grants for the specified KMS key.
|
Integer |
limit()
Use this parameter to specify the maximum number of items to return.
|
String |
marker()
Use this parameter in a subsequent request after you receive a response with truncated results.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListGrantsRequest.Builder> |
serializableBuilderClass() |
ListGrantsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final Integer 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 100, inclusive. If you do not include a value, it defaults to 50.
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 final 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.
NextMarker
from the truncated response you just received.public final String keyId()
Returns only grants for the specified KMS key. This parameter is required.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.
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 KMS key, use ListKeys or DescribeKey.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.
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 KMS key, use ListKeys or DescribeKey.
public final String grantId()
Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
public final String granteePrincipal()
Returns only grants where the specified principal is the grantee principal for the grant.
public ListGrantsRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ListGrantsRequest.Builder,ListGrantsRequest>
toBuilder
in class KmsRequest
public static ListGrantsRequest.Builder builder()
public static Class<? extends ListGrantsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2022. All rights reserved.