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.ListKeyRotationsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListKeyRotationsRequest.Builder,ListKeyRotationsRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListKeyRotationsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListKeyRotationsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`IncludeKeyMaterial`	`includeKeyMaterial()`	Use this optional parameter to control which key materials associated with this key are listed in the response.
`String`	`includeKeyMaterialAsString()`	Use this optional parameter to control which key materials associated with this key are listed in the response.
`String`	`keyId()`	Gets the key rotations 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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListKeyRotationsRequest.Builder>`	`serializableBuilderClass()`
`ListKeyRotationsRequest.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
  - keyId
```
public final String keyId()
```
    Gets the key rotations for the specified KMS key.
    
    Specify the key ID or key ARN of the KMS key.
    
    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:
    
    Gets the key rotations for the specified KMS key.
    
    Specify the key ID or key ARN of the KMS key.
    
    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.
  - includeKeyMaterial
```
public final IncludeKeyMaterial includeKeyMaterial()
```
    Use this optional parameter to control which key materials associated with this key are listed in the response. The default value of this parameter is ROTATIONS_ONLY. If you omit this parameter, KMS returns information on the key materials created by automatic or on-demand key rotation. When you specify a value of ALL_KEY_MATERIAL, KMS adds the first key material and any imported key material pending rotation to the response. This parameter can only be used with KMS keys that support automatic or on-demand key rotation.
    
    If the service returns an enum value that is not available in the current SDK version, includeKeyMaterial will return IncludeKeyMaterial.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from includeKeyMaterialAsString().
    
    Returns:
    
    Use this optional parameter to control which key materials associated with this key are listed in the response. The default value of this parameter is ROTATIONS_ONLY. If you omit this parameter, KMS returns information on the key materials created by automatic or on-demand key rotation. When you specify a value of ALL_KEY_MATERIAL, KMS adds the first key material and any imported key material pending rotation to the response. This parameter can only be used with KMS keys that support automatic or on-demand key rotation.
    
    See Also:
    
    IncludeKeyMaterial
  - includeKeyMaterialAsString
```
public final String includeKeyMaterialAsString()
```
    Use this optional parameter to control which key materials associated with this key are listed in the response. The default value of this parameter is ROTATIONS_ONLY. If you omit this parameter, KMS returns information on the key materials created by automatic or on-demand key rotation. When you specify a value of ALL_KEY_MATERIAL, KMS adds the first key material and any imported key material pending rotation to the response. This parameter can only be used with KMS keys that support automatic or on-demand key rotation.
    
    If the service returns an enum value that is not available in the current SDK version, includeKeyMaterial will return IncludeKeyMaterial.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from includeKeyMaterialAsString().
    
    Returns:
    
    Use this optional parameter to control which key materials associated with this key are listed in the response. The default value of this parameter is ROTATIONS_ONLY. If you omit this parameter, KMS returns information on the key materials created by automatic or on-demand key rotation. When you specify a value of ALL_KEY_MATERIAL, KMS adds the first key material and any imported key material pending rotation to the response. This parameter can only be used with KMS keys that support automatic or on-demand key rotation.
    
    See Also:
    
    IncludeKeyMaterial
  - 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 1000, inclusive. If you do not include a value, it defaults to 100.
    
    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 1000, inclusive. If you do not include a value, it defaults to 100.
  - 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.
  - toBuilder
```
public ListKeyRotationsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListKeyRotationsRequest.Builder,ListKeyRotationsRequest>
    
    Specified by:
    
    toBuilder in class KmsRequest
  - builder
```
public static ListKeyRotationsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListKeyRotationsRequest.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ListKeyRotationsRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

keyId

includeKeyMaterial

includeKeyMaterialAsString

limit

marker

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField