Class ListKeyPoliciesRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.kms.model.ListKeyPoliciesRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class ListKeyPoliciesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
See Also:
  • Constructor Details

    • ListKeyPoliciesRequest

      public ListKeyPoliciesRequest()
  • Method Details

    • setKeyId

      public void setKeyId(String keyId)

      A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012

      • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

      • Alias Name Example - alias/MyAliasName

      Parameters:
      keyId - A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234 -1234-1234-123456789012

      • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

      • Alias Name Example - alias/MyAliasName

    • getKeyId

      public String getKeyId()

      A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012

      • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

      • Alias Name Example - alias/MyAliasName

      Returns:
      A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678- 1234-1234-1234-123456789012

      • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

      • Alias Name Example - alias/MyAliasName

    • withKeyId

      public ListKeyPoliciesRequest withKeyId(String keyId)

      A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012

      • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

      • Alias Name Example - alias/MyAliasName

      Parameters:
      keyId - A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234 -1234-1234-123456789012

      • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

      • Alias Name Example - alias/MyAliasName

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

      public void setLimit(Integer limit)

      When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

      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.

      Currently only 1 policy can be attached to a key.

      Parameters:
      limit - When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

      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.

      Currently only 1 policy can be attached to a key.

    • getLimit

      public Integer getLimit()

      When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

      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.

      Currently only 1 policy can be attached to a key.

      Returns:
      When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

      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.

      Currently only 1 policy can be attached to a key.

    • withLimit

      public ListKeyPoliciesRequest withLimit(Integer limit)

      When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

      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.

      Currently only 1 policy can be attached to a key.

      Parameters:
      limit - When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

      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.

      Currently only 1 policy can be attached to a key.

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

      public void setMarker(String marker)

      Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.

      Parameters:
      marker - Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.
    • getMarker

      public String getMarker()

      Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.

      Returns:
      Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.
    • withMarker

      public ListKeyPoliciesRequest withMarker(String marker)

      Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.

      Parameters:
      marker - Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public ListKeyPoliciesRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: