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

#include <DescribeCustomKeyStoresRequest.h>

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

Public Member Functions

 DescribeCustomKeyStoresRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetCustomKeyStoreId () const
 
bool CustomKeyStoreIdHasBeenSet () const
 
void SetCustomKeyStoreId (const Aws::String &value)
 
void SetCustomKeyStoreId (Aws::String &&value)
 
void SetCustomKeyStoreId (const char *value)
 
DescribeCustomKeyStoresRequestWithCustomKeyStoreId (const Aws::String &value)
 
DescribeCustomKeyStoresRequestWithCustomKeyStoreId (Aws::String &&value)
 
DescribeCustomKeyStoresRequestWithCustomKeyStoreId (const char *value)
 
const Aws::StringGetCustomKeyStoreName () const
 
bool CustomKeyStoreNameHasBeenSet () const
 
void SetCustomKeyStoreName (const Aws::String &value)
 
void SetCustomKeyStoreName (Aws::String &&value)
 
void SetCustomKeyStoreName (const char *value)
 
DescribeCustomKeyStoresRequestWithCustomKeyStoreName (const Aws::String &value)
 
DescribeCustomKeyStoresRequestWithCustomKeyStoreName (Aws::String &&value)
 
DescribeCustomKeyStoresRequestWithCustomKeyStoreName (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribeCustomKeyStoresRequestWithLimit (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)
 
DescribeCustomKeyStoresRequestWithMarker (const Aws::String &value)
 
DescribeCustomKeyStoresRequestWithMarker (Aws::String &&value)
 
DescribeCustomKeyStoresRequestWithMarker (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 DescribeCustomKeyStoresRequest.h.

Constructor & Destructor Documentation

◆ DescribeCustomKeyStoresRequest()

Aws::KMS::Model::DescribeCustomKeyStoresRequest::DescribeCustomKeyStoresRequest ( )

Member Function Documentation

◆ CustomKeyStoreIdHasBeenSet()

bool Aws::KMS::Model::DescribeCustomKeyStoresRequest::CustomKeyStoreIdHasBeenSet ( ) const
inline

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 53 of file DescribeCustomKeyStoresRequest.h.

◆ CustomKeyStoreNameHasBeenSet()

bool Aws::KMS::Model::DescribeCustomKeyStoresRequest::CustomKeyStoreNameHasBeenSet ( ) const
inline

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 128 of file DescribeCustomKeyStoresRequest.h.

◆ GetCustomKeyStoreId()

const Aws::String& Aws::KMS::Model::DescribeCustomKeyStoresRequest::GetCustomKeyStoreId ( ) const
inline

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 44 of file DescribeCustomKeyStoresRequest.h.

◆ GetCustomKeyStoreName()

const Aws::String& Aws::KMS::Model::DescribeCustomKeyStoresRequest::GetCustomKeyStoreName ( ) const
inline

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 118 of file DescribeCustomKeyStoresRequest.h.

◆ GetLimit()

int Aws::KMS::Model::DescribeCustomKeyStoresRequest::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.

Definition at line 196 of file DescribeCustomKeyStoresRequest.h.

◆ GetMarker()

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

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file DescribeCustomKeyStoresRequest.h.

◆ LimitHasBeenSet()

bool Aws::KMS::Model::DescribeCustomKeyStoresRequest::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.

Definition at line 203 of file DescribeCustomKeyStoresRequest.h.

◆ MarkerHasBeenSet()

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

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCustomKeyStoreId() [1/3]

void Aws::KMS::Model::DescribeCustomKeyStoresRequest::SetCustomKeyStoreId ( const Aws::String value)
inline

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 62 of file DescribeCustomKeyStoresRequest.h.

◆ SetCustomKeyStoreId() [2/3]

void Aws::KMS::Model::DescribeCustomKeyStoresRequest::SetCustomKeyStoreId ( Aws::String &&  value)
inline

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 71 of file DescribeCustomKeyStoresRequest.h.

◆ SetCustomKeyStoreId() [3/3]

void Aws::KMS::Model::DescribeCustomKeyStoresRequest::SetCustomKeyStoreId ( const char *  value)
inline

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 80 of file DescribeCustomKeyStoresRequest.h.

◆ SetCustomKeyStoreName() [1/3]

void Aws::KMS::Model::DescribeCustomKeyStoresRequest::SetCustomKeyStoreName ( const Aws::String value)
inline

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 138 of file DescribeCustomKeyStoresRequest.h.

◆ SetCustomKeyStoreName() [2/3]

void Aws::KMS::Model::DescribeCustomKeyStoresRequest::SetCustomKeyStoreName ( Aws::String &&  value)
inline

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 148 of file DescribeCustomKeyStoresRequest.h.

◆ SetCustomKeyStoreName() [3/3]

void Aws::KMS::Model::DescribeCustomKeyStoresRequest::SetCustomKeyStoreName ( const char *  value)
inline

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 158 of file DescribeCustomKeyStoresRequest.h.

◆ SetLimit()

void Aws::KMS::Model::DescribeCustomKeyStoresRequest::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.

Definition at line 210 of file DescribeCustomKeyStoresRequest.h.

◆ SetMarker() [1/3]

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

◆ SetMarker() [2/3]

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

◆ SetMarker() [3/3]

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

◆ WithCustomKeyStoreId() [1/3]

DescribeCustomKeyStoresRequest& Aws::KMS::Model::DescribeCustomKeyStoresRequest::WithCustomKeyStoreId ( const Aws::String value)
inline

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 89 of file DescribeCustomKeyStoresRequest.h.

◆ WithCustomKeyStoreId() [2/3]

DescribeCustomKeyStoresRequest& Aws::KMS::Model::DescribeCustomKeyStoresRequest::WithCustomKeyStoreId ( Aws::String &&  value)
inline

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 98 of file DescribeCustomKeyStoresRequest.h.

◆ WithCustomKeyStoreId() [3/3]

DescribeCustomKeyStoresRequest& Aws::KMS::Model::DescribeCustomKeyStoresRequest::WithCustomKeyStoreId ( const char *  value)
inline

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 107 of file DescribeCustomKeyStoresRequest.h.

◆ WithCustomKeyStoreName() [1/3]

DescribeCustomKeyStoresRequest& Aws::KMS::Model::DescribeCustomKeyStoresRequest::WithCustomKeyStoreName ( const Aws::String value)
inline

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 168 of file DescribeCustomKeyStoresRequest.h.

◆ WithCustomKeyStoreName() [2/3]

DescribeCustomKeyStoresRequest& Aws::KMS::Model::DescribeCustomKeyStoresRequest::WithCustomKeyStoreName ( Aws::String &&  value)
inline

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 178 of file DescribeCustomKeyStoresRequest.h.

◆ WithCustomKeyStoreName() [3/3]

DescribeCustomKeyStoresRequest& Aws::KMS::Model::DescribeCustomKeyStoresRequest::WithCustomKeyStoreName ( const char *  value)
inline

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Definition at line 188 of file DescribeCustomKeyStoresRequest.h.

◆ WithLimit()

DescribeCustomKeyStoresRequest& Aws::KMS::Model::DescribeCustomKeyStoresRequest::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.

Definition at line 217 of file DescribeCustomKeyStoresRequest.h.

◆ WithMarker() [1/3]

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

◆ WithMarker() [2/3]

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

◆ WithMarker() [3/3]

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


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