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

#include <ListGrantsRequest.h>

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

Public Member Functions

 ListGrantsRequest ()
 
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)
 
ListGrantsRequestWithLimit (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)
 
ListGrantsRequestWithMarker (const Aws::String &value)
 
ListGrantsRequestWithMarker (Aws::String &&value)
 
ListGrantsRequestWithMarker (const char *value)
 
const Aws::StringGetKeyId () const
 
bool KeyIdHasBeenSet () const
 
void SetKeyId (const Aws::String &value)
 
void SetKeyId (Aws::String &&value)
 
void SetKeyId (const char *value)
 
ListGrantsRequestWithKeyId (const Aws::String &value)
 
ListGrantsRequestWithKeyId (Aws::String &&value)
 
ListGrantsRequestWithKeyId (const char *value)
 
const Aws::StringGetGrantId () const
 
bool GrantIdHasBeenSet () const
 
void SetGrantId (const Aws::String &value)
 
void SetGrantId (Aws::String &&value)
 
void SetGrantId (const char *value)
 
ListGrantsRequestWithGrantId (const Aws::String &value)
 
ListGrantsRequestWithGrantId (Aws::String &&value)
 
ListGrantsRequestWithGrantId (const char *value)
 
const Aws::StringGetGranteePrincipal () const
 
bool GranteePrincipalHasBeenSet () const
 
void SetGranteePrincipal (const Aws::String &value)
 
void SetGranteePrincipal (Aws::String &&value)
 
void SetGranteePrincipal (const char *value)
 
ListGrantsRequestWithGranteePrincipal (const Aws::String &value)
 
ListGrantsRequestWithGranteePrincipal (Aws::String &&value)
 
ListGrantsRequestWithGranteePrincipal (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 ListGrantsRequest.h.

Constructor & Destructor Documentation

◆ ListGrantsRequest()

Aws::KMS::Model::ListGrantsRequest::ListGrantsRequest ( )

Member Function Documentation

◆ GetGranteePrincipal()

const Aws::String& Aws::KMS::Model::ListGrantsRequest::GetGranteePrincipal ( ) const
inline

Returns only grants where the specified principal is the grantee principal for the grant.

Definition at line 281 of file ListGrantsRequest.h.

◆ GetGrantId()

const Aws::String& Aws::KMS::Model::ListGrantsRequest::GetGrantId ( ) const
inline

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

Definition at line 232 of file ListGrantsRequest.h.

◆ GetKeyId()

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

Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

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

Definition at line 141 of file ListGrantsRequest.h.

◆ GetLimit()

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

Use this parameter to specify the maximum number of items to return. When this value is present, 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 ListGrantsRequest.h.

◆ GetMarker()

const Aws::String& Aws::KMS::Model::ListGrantsRequest::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 ListGrantsRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file ListGrantsRequest.h.

◆ GranteePrincipalHasBeenSet()

bool Aws::KMS::Model::ListGrantsRequest::GranteePrincipalHasBeenSet ( ) const
inline

Returns only grants where the specified principal is the grantee principal for the grant.

Definition at line 287 of file ListGrantsRequest.h.

◆ GrantIdHasBeenSet()

bool Aws::KMS::Model::ListGrantsRequest::GrantIdHasBeenSet ( ) const
inline

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

Definition at line 238 of file ListGrantsRequest.h.

◆ KeyIdHasBeenSet()

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

Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

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

Definition at line 153 of file ListGrantsRequest.h.

◆ LimitHasBeenSet()

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

Use this parameter to specify the maximum number of items to return. When this value is present, 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 ListGrantsRequest.h.

◆ MarkerHasBeenSet()

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

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetGranteePrincipal() [1/3]

void Aws::KMS::Model::ListGrantsRequest::SetGranteePrincipal ( Aws::String &&  value)
inline

Returns only grants where the specified principal is the grantee principal for the grant.

Definition at line 299 of file ListGrantsRequest.h.

◆ SetGranteePrincipal() [2/3]

void Aws::KMS::Model::ListGrantsRequest::SetGranteePrincipal ( const Aws::String value)
inline

Returns only grants where the specified principal is the grantee principal for the grant.

Definition at line 293 of file ListGrantsRequest.h.

◆ SetGranteePrincipal() [3/3]

void Aws::KMS::Model::ListGrantsRequest::SetGranteePrincipal ( const char *  value)
inline

Returns only grants where the specified principal is the grantee principal for the grant.

Definition at line 305 of file ListGrantsRequest.h.

◆ SetGrantId() [1/3]

void Aws::KMS::Model::ListGrantsRequest::SetGrantId ( Aws::String &&  value)
inline

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

Definition at line 250 of file ListGrantsRequest.h.

◆ SetGrantId() [2/3]

void Aws::KMS::Model::ListGrantsRequest::SetGrantId ( const Aws::String value)
inline

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

Definition at line 244 of file ListGrantsRequest.h.

◆ SetGrantId() [3/3]

void Aws::KMS::Model::ListGrantsRequest::SetGrantId ( const char *  value)
inline

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

Definition at line 256 of file ListGrantsRequest.h.

◆ SetKeyId() [1/3]

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

Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

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

Definition at line 177 of file ListGrantsRequest.h.

◆ SetKeyId() [2/3]

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

Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

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

Definition at line 165 of file ListGrantsRequest.h.

◆ SetKeyId() [3/3]

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

Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

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

Definition at line 189 of file ListGrantsRequest.h.

◆ SetLimit()

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

Use this parameter to specify the maximum number of items to return. When this value is present, 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 ListGrantsRequest.h.

◆ SetMarker() [1/3]

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

◆ SetMarker() [2/3]

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

◆ SetMarker() [3/3]

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

◆ WithGranteePrincipal() [1/3]

ListGrantsRequest& Aws::KMS::Model::ListGrantsRequest::WithGranteePrincipal ( Aws::String &&  value)
inline

Returns only grants where the specified principal is the grantee principal for the grant.

Definition at line 317 of file ListGrantsRequest.h.

◆ WithGranteePrincipal() [2/3]

ListGrantsRequest& Aws::KMS::Model::ListGrantsRequest::WithGranteePrincipal ( const Aws::String value)
inline

Returns only grants where the specified principal is the grantee principal for the grant.

Definition at line 311 of file ListGrantsRequest.h.

◆ WithGranteePrincipal() [3/3]

ListGrantsRequest& Aws::KMS::Model::ListGrantsRequest::WithGranteePrincipal ( const char *  value)
inline

Returns only grants where the specified principal is the grantee principal for the grant.

Definition at line 323 of file ListGrantsRequest.h.

◆ WithGrantId() [1/3]

ListGrantsRequest& Aws::KMS::Model::ListGrantsRequest::WithGrantId ( Aws::String &&  value)
inline

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

Definition at line 268 of file ListGrantsRequest.h.

◆ WithGrantId() [2/3]

ListGrantsRequest& Aws::KMS::Model::ListGrantsRequest::WithGrantId ( const Aws::String value)
inline

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

Definition at line 262 of file ListGrantsRequest.h.

◆ WithGrantId() [3/3]

ListGrantsRequest& Aws::KMS::Model::ListGrantsRequest::WithGrantId ( const char *  value)
inline

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

Definition at line 274 of file ListGrantsRequest.h.

◆ WithKeyId() [1/3]

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

Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

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

Definition at line 213 of file ListGrantsRequest.h.

◆ WithKeyId() [2/3]

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

Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

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

Definition at line 201 of file ListGrantsRequest.h.

◆ WithKeyId() [3/3]

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

Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

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

Definition at line 225 of file ListGrantsRequest.h.

◆ WithLimit()

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

Use this parameter to specify the maximum number of items to return. When this value is present, 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 ListGrantsRequest.h.

◆ WithMarker() [1/3]

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

◆ WithMarker() [2/3]

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

◆ WithMarker() [3/3]

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


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