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

Interface ListRetirableGrantsRequest.Builder

All Superinterfaces:

CopyableBuilder<ListRetirableGrantsRequest.Builder,ListRetirableGrantsRequest>, SdkBuilder<ListRetirableGrantsRequest.Builder,ListRetirableGrantsRequest>

Enclosing class:

ListRetirableGrantsRequest

public static interface ListRetirableGrantsRequest.Builder
extends CopyableBuilder<ListRetirableGrantsRequest.Builder,ListRetirableGrantsRequest>

Method Summary

Modifier and Type	Method	Description
ListRetirableGrantsRequest.Builder	limit(Integer limit)	Use this parameter to specify the maximum number of items to return.
ListRetirableGrantsRequest.Builder	marker(String marker)	Use this parameter in a subsequent request after you receive a response with truncated results.
ListRetirableGrantsRequest.Builder	retiringPrincipal(String retiringPrincipal)	The retiring principal for which to list grants.

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

copy

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

apply, build

Method Detail

limit

ListRetirableGrantsRequest.Builder limit(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

marker

ListRetirableGrantsRequest.Builder marker(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

retiringPrincipal

ListRetirableGrantsRequest.Builder retiringPrincipal(String retiringPrincipal)

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Parameters:

retiringPrincipal - The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Returns:

Returns a reference to this object so that method calls can be chained together.