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

#include <ListAliasesRequest.h>

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

Public Member Functions

 ListAliasesRequest ()
 
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)
 
ListAliasesRequestWithKeyId (const Aws::String &value)
 
ListAliasesRequestWithKeyId (Aws::String &&value)
 
ListAliasesRequestWithKeyId (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
ListAliasesRequestWithLimit (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)
 
ListAliasesRequestWithMarker (const Aws::String &value)
 
ListAliasesRequestWithMarker (Aws::String &&value)
 
ListAliasesRequestWithMarker (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 ListAliasesRequest.h.

Constructor & Destructor Documentation

◆ ListAliasesRequest()

Aws::KMS::Model::ListAliasesRequest::ListAliasesRequest ( )

Member Function Documentation

◆ GetKeyId()

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

Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value.

This parameter is optional. If you omit it, ListAliases returns all aliases in the account and region.

Definition at line 44 of file ListAliasesRequest.h.

◆ GetLimit()

int Aws::KMS::Model::ListAliasesRequest::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 100, inclusive. If you do not include a value, it defaults to 50.

Definition at line 117 of file ListAliasesRequest.h.

◆ GetMarker()

const Aws::String& Aws::KMS::Model::ListAliasesRequest::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 152 of file ListAliasesRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file ListAliasesRequest.h.

◆ KeyIdHasBeenSet()

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

Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value.

This parameter is optional. If you omit it, ListAliases returns all aliases in the account and region.

Definition at line 53 of file ListAliasesRequest.h.

◆ LimitHasBeenSet()

bool Aws::KMS::Model::ListAliasesRequest::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 100, inclusive. If you do not include a value, it defaults to 50.

Definition at line 126 of file ListAliasesRequest.h.

◆ MarkerHasBeenSet()

bool Aws::KMS::Model::ListAliasesRequest::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 159 of file ListAliasesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetKeyId() [1/3]

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

Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value.

This parameter is optional. If you omit it, ListAliases returns all aliases in the account and region.

Definition at line 62 of file ListAliasesRequest.h.

◆ SetKeyId() [2/3]

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

Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value.

This parameter is optional. If you omit it, ListAliases returns all aliases in the account and region.

Definition at line 71 of file ListAliasesRequest.h.

◆ SetKeyId() [3/3]

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

Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value.

This parameter is optional. If you omit it, ListAliases returns all aliases in the account and region.

Definition at line 80 of file ListAliasesRequest.h.

◆ SetLimit()

void Aws::KMS::Model::ListAliasesRequest::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 100, inclusive. If you do not include a value, it defaults to 50.

Definition at line 135 of file ListAliasesRequest.h.

◆ SetMarker() [1/3]

void Aws::KMS::Model::ListAliasesRequest::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 166 of file ListAliasesRequest.h.

◆ SetMarker() [2/3]

void Aws::KMS::Model::ListAliasesRequest::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 173 of file ListAliasesRequest.h.

◆ SetMarker() [3/3]

void Aws::KMS::Model::ListAliasesRequest::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 180 of file ListAliasesRequest.h.

◆ WithKeyId() [1/3]

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

Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value.

This parameter is optional. If you omit it, ListAliases returns all aliases in the account and region.

Definition at line 89 of file ListAliasesRequest.h.

◆ WithKeyId() [2/3]

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

Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value.

This parameter is optional. If you omit it, ListAliases returns all aliases in the account and region.

Definition at line 98 of file ListAliasesRequest.h.

◆ WithKeyId() [3/3]

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

Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value.

This parameter is optional. If you omit it, ListAliases returns all aliases in the account and region.

Definition at line 107 of file ListAliasesRequest.h.

◆ WithLimit()

ListAliasesRequest& Aws::KMS::Model::ListAliasesRequest::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 100, inclusive. If you do not include a value, it defaults to 50.

Definition at line 144 of file ListAliasesRequest.h.

◆ WithMarker() [1/3]

ListAliasesRequest& Aws::KMS::Model::ListAliasesRequest::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 187 of file ListAliasesRequest.h.

◆ WithMarker() [2/3]

ListAliasesRequest& Aws::KMS::Model::ListAliasesRequest::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 194 of file ListAliasesRequest.h.

◆ WithMarker() [3/3]

ListAliasesRequest& Aws::KMS::Model::ListAliasesRequest::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 201 of file ListAliasesRequest.h.


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