AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::KMS::Model::ListKeyPoliciesRequest Class Reference

#include <ListKeyPoliciesRequest.h>

+ Inheritance diagram for Aws::KMS::Model::ListKeyPoliciesRequest:

Public Member Functions

 ListKeyPoliciesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetKeyId () const
 
bool KeyIdHasBeenSet () const
 
void SetKeyId (const Aws::String &value)
 
void SetKeyId (Aws::String &&value)
 
void SetKeyId (const char *value)
 
ListKeyPoliciesRequestWithKeyId (const Aws::String &value)
 
ListKeyPoliciesRequestWithKeyId (Aws::String &&value)
 
ListKeyPoliciesRequestWithKeyId (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
ListKeyPoliciesRequestWithLimit (int value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
ListKeyPoliciesRequestWithMarker (const Aws::String &value)
 
ListKeyPoliciesRequestWithMarker (Aws::String &&value)
 
ListKeyPoliciesRequestWithMarker (const char *value)
 
- Public Member Functions inherited from Aws::KMS::KMSRequest
virtual ~KMSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 21 of file ListKeyPoliciesRequest.h.

Constructor & Destructor Documentation

◆ ListKeyPoliciesRequest()

Aws::KMS::Model::ListKeyPoliciesRequest::ListKeyPoliciesRequest ( )

Member Function Documentation

◆ GetKeyId()

const Aws::String& Aws::KMS::Model::ListKeyPoliciesRequest::GetKeyId ( ) const
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

Definition at line 46 of file ListKeyPoliciesRequest.h.

◆ GetLimit()

int Aws::KMS::Model::ListKeyPoliciesRequest::GetLimit ( ) const
inline

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 1000, inclusive. If you do not include a value, it defaults to 100.

Only one policy can be attached to a key.

Definition at line 133 of file ListKeyPoliciesRequest.h.

◆ GetMarker()

const Aws::String& Aws::KMS::Model::ListKeyPoliciesRequest::GetMarker ( ) const
inline

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.

Definition at line 168 of file ListKeyPoliciesRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::KMS::Model::ListKeyPoliciesRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

virtual const char* Aws::KMS::Model::ListKeyPoliciesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file ListKeyPoliciesRequest.h.

◆ KeyIdHasBeenSet()

bool Aws::KMS::Model::ListKeyPoliciesRequest::KeyIdHasBeenSet ( ) const
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

Definition at line 57 of file ListKeyPoliciesRequest.h.

◆ LimitHasBeenSet()

bool Aws::KMS::Model::ListKeyPoliciesRequest::LimitHasBeenSet ( ) const
inline

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 1000, inclusive. If you do not include a value, it defaults to 100.

Only one policy can be attached to a key.

Definition at line 142 of file ListKeyPoliciesRequest.h.

◆ MarkerHasBeenSet()

bool Aws::KMS::Model::ListKeyPoliciesRequest::MarkerHasBeenSet ( ) const
inline

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.

Definition at line 175 of file ListKeyPoliciesRequest.h.

◆ SerializePayload()

Aws::String Aws::KMS::Model::ListKeyPoliciesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetKeyId() [1/3]

void Aws::KMS::Model::ListKeyPoliciesRequest::SetKeyId ( const Aws::String value)
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

Definition at line 68 of file ListKeyPoliciesRequest.h.

◆ SetKeyId() [2/3]

void Aws::KMS::Model::ListKeyPoliciesRequest::SetKeyId ( Aws::String &&  value)
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

Definition at line 79 of file ListKeyPoliciesRequest.h.

◆ SetKeyId() [3/3]

void Aws::KMS::Model::ListKeyPoliciesRequest::SetKeyId ( const char *  value)
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

Definition at line 90 of file ListKeyPoliciesRequest.h.

◆ SetLimit()

void Aws::KMS::Model::ListKeyPoliciesRequest::SetLimit ( int  value)
inline

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 1000, inclusive. If you do not include a value, it defaults to 100.

Only one policy can be attached to a key.

Definition at line 151 of file ListKeyPoliciesRequest.h.

◆ SetMarker() [1/3]

void Aws::KMS::Model::ListKeyPoliciesRequest::SetMarker ( const Aws::String value)
inline

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.

Definition at line 182 of file ListKeyPoliciesRequest.h.

◆ SetMarker() [2/3]

void Aws::KMS::Model::ListKeyPoliciesRequest::SetMarker ( Aws::String &&  value)
inline

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.

Definition at line 189 of file ListKeyPoliciesRequest.h.

◆ SetMarker() [3/3]

void Aws::KMS::Model::ListKeyPoliciesRequest::SetMarker ( const char *  value)
inline

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.

Definition at line 196 of file ListKeyPoliciesRequest.h.

◆ WithKeyId() [1/3]

ListKeyPoliciesRequest& Aws::KMS::Model::ListKeyPoliciesRequest::WithKeyId ( const Aws::String value)
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

Definition at line 101 of file ListKeyPoliciesRequest.h.

◆ WithKeyId() [2/3]

ListKeyPoliciesRequest& Aws::KMS::Model::ListKeyPoliciesRequest::WithKeyId ( Aws::String &&  value)
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

Definition at line 112 of file ListKeyPoliciesRequest.h.

◆ WithKeyId() [3/3]

ListKeyPoliciesRequest& Aws::KMS::Model::ListKeyPoliciesRequest::WithKeyId ( const char *  value)
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

Definition at line 123 of file ListKeyPoliciesRequest.h.

◆ WithLimit()

ListKeyPoliciesRequest& Aws::KMS::Model::ListKeyPoliciesRequest::WithLimit ( int  value)
inline

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 1000, inclusive. If you do not include a value, it defaults to 100.

Only one policy can be attached to a key.

Definition at line 160 of file ListKeyPoliciesRequest.h.

◆ WithMarker() [1/3]

ListKeyPoliciesRequest& Aws::KMS::Model::ListKeyPoliciesRequest::WithMarker ( const Aws::String value)
inline

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.

Definition at line 203 of file ListKeyPoliciesRequest.h.

◆ WithMarker() [2/3]

ListKeyPoliciesRequest& Aws::KMS::Model::ListKeyPoliciesRequest::WithMarker ( Aws::String &&  value)
inline

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.

Definition at line 210 of file ListKeyPoliciesRequest.h.

◆ WithMarker() [3/3]

ListKeyPoliciesRequest& Aws::KMS::Model::ListKeyPoliciesRequest::WithMarker ( const char *  value)
inline

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.

Definition at line 217 of file ListKeyPoliciesRequest.h.


The documentation for this class was generated from the following file: