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

#include <ListRetirableGrantsRequest.h>

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

Public Member Functions

 ListRetirableGrantsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
ListRetirableGrantsRequestWithLimit (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)
 
ListRetirableGrantsRequestWithMarker (const Aws::String &value)
 
ListRetirableGrantsRequestWithMarker (Aws::String &&value)
 
ListRetirableGrantsRequestWithMarker (const char *value)
 
const Aws::StringGetRetiringPrincipal () const
 
bool RetiringPrincipalHasBeenSet () const
 
void SetRetiringPrincipal (const Aws::String &value)
 
void SetRetiringPrincipal (Aws::String &&value)
 
void SetRetiringPrincipal (const char *value)
 
ListRetirableGrantsRequestWithRetiringPrincipal (const Aws::String &value)
 
ListRetirableGrantsRequestWithRetiringPrincipal (Aws::String &&value)
 
ListRetirableGrantsRequestWithRetiringPrincipal (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 ListRetirableGrantsRequest.h.

Constructor & Destructor Documentation

◆ ListRetirableGrantsRequest()

Aws::KMS::Model::ListRetirableGrantsRequest::ListRetirableGrantsRequest ( )

Member Function Documentation

◆ GetLimit()

int Aws::KMS::Model::ListRetirableGrantsRequest::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 44 of file ListRetirableGrantsRequest.h.

◆ GetMarker()

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

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::KMS::KMSRequest.

◆ GetRetiringPrincipal()

const Aws::String& Aws::KMS::Model::ListRetirableGrantsRequest::GetRetiringPrincipal ( ) const
inline

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 142 of file ListRetirableGrantsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file ListRetirableGrantsRequest.h.

◆ LimitHasBeenSet()

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

◆ MarkerHasBeenSet()

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

◆ RetiringPrincipalHasBeenSet()

bool Aws::KMS::Model::ListRetirableGrantsRequest::RetiringPrincipalHasBeenSet ( ) const
inline

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 155 of file ListRetirableGrantsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetLimit()

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

◆ SetMarker() [1/3]

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

◆ SetMarker() [2/3]

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

◆ SetMarker() [3/3]

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

◆ SetRetiringPrincipal() [1/3]

void Aws::KMS::Model::ListRetirableGrantsRequest::SetRetiringPrincipal ( const Aws::String value)
inline

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 168 of file ListRetirableGrantsRequest.h.

◆ SetRetiringPrincipal() [2/3]

void Aws::KMS::Model::ListRetirableGrantsRequest::SetRetiringPrincipal ( Aws::String &&  value)
inline

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 181 of file ListRetirableGrantsRequest.h.

◆ SetRetiringPrincipal() [3/3]

void Aws::KMS::Model::ListRetirableGrantsRequest::SetRetiringPrincipal ( const char *  value)
inline

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 194 of file ListRetirableGrantsRequest.h.

◆ WithLimit()

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

◆ WithMarker() [1/3]

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

◆ WithMarker() [2/3]

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

◆ WithMarker() [3/3]

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

◆ WithRetiringPrincipal() [1/3]

ListRetirableGrantsRequest& Aws::KMS::Model::ListRetirableGrantsRequest::WithRetiringPrincipal ( const Aws::String value)
inline

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 207 of file ListRetirableGrantsRequest.h.

◆ WithRetiringPrincipal() [2/3]

ListRetirableGrantsRequest& Aws::KMS::Model::ListRetirableGrantsRequest::WithRetiringPrincipal ( Aws::String &&  value)
inline

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 220 of file ListRetirableGrantsRequest.h.

◆ WithRetiringPrincipal() [3/3]

ListRetirableGrantsRequest& Aws::KMS::Model::ListRetirableGrantsRequest::WithRetiringPrincipal ( const char *  value)
inline

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 233 of file ListRetirableGrantsRequest.h.


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