Package software.amazon.awssdk.services.kms.model

Class ListGrantsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kms.model.KmsRequest

software.amazon.awssdk.services.kms.model.ListGrantsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListGrantsRequest.Builder,ListGrantsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListGrantsRequest
extends KmsRequest
implements ToCopyableBuilder<ListGrantsRequest.Builder,ListGrantsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListGrantsRequest.Builder

Method Summary

Modifier and Type	Method	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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

limit

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.

Returns:

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.

marker

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.

Returns:

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.

keyId

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.

Returns:

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.

grantId

public final String grantId()

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

Returns:

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

granteePrincipal

public final String granteePrincipal()

Returns only grants where the specified principal is the grantee principal for the grant.

Returns:

Returns only grants where the specified principal is the grantee principal for the grant.

toBuilder

public ListGrantsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListGrantsRequest.Builder,ListGrantsRequest>

Specified by:

toBuilder in class KmsRequest

builder

public static ListGrantsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListGrantsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo