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

#include <RetireGrantRequest.h>

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

Public Member Functions

 RetireGrantRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetGrantToken () const
 
bool GrantTokenHasBeenSet () const
 
void SetGrantToken (const Aws::String &value)
 
void SetGrantToken (Aws::String &&value)
 
void SetGrantToken (const char *value)
 
RetireGrantRequestWithGrantToken (const Aws::String &value)
 
RetireGrantRequestWithGrantToken (Aws::String &&value)
 
RetireGrantRequestWithGrantToken (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)
 
RetireGrantRequestWithKeyId (const Aws::String &value)
 
RetireGrantRequestWithKeyId (Aws::String &&value)
 
RetireGrantRequestWithKeyId (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)
 
RetireGrantRequestWithGrantId (const Aws::String &value)
 
RetireGrantRequestWithGrantId (Aws::String &&value)
 
RetireGrantRequestWithGrantId (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 RetireGrantRequest.h.

Constructor & Destructor Documentation

◆ RetireGrantRequest()

Aws::KMS::Model::RetireGrantRequest::RetireGrantRequest ( )

Member Function Documentation

◆ GetGrantId()

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

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Definition at line 197 of file RetireGrantRequest.h.

◆ GetGrantToken()

const Aws::String& Aws::KMS::Model::RetireGrantRequest::GetGrantToken ( ) const
inline

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

Definition at line 46 of file RetireGrantRequest.h.

◆ GetKeyId()

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

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

Definition at line 132 of file RetireGrantRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file RetireGrantRequest.h.

◆ GrantIdHasBeenSet()

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

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Definition at line 205 of file RetireGrantRequest.h.

◆ GrantTokenHasBeenSet()

bool Aws::KMS::Model::RetireGrantRequest::GrantTokenHasBeenSet ( ) const
inline

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

Definition at line 57 of file RetireGrantRequest.h.

◆ KeyIdHasBeenSet()

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

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

Definition at line 140 of file RetireGrantRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetGrantId() [1/3]

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

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Definition at line 221 of file RetireGrantRequest.h.

◆ SetGrantId() [2/3]

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

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Definition at line 213 of file RetireGrantRequest.h.

◆ SetGrantId() [3/3]

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

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Definition at line 229 of file RetireGrantRequest.h.

◆ SetGrantToken() [1/3]

void Aws::KMS::Model::RetireGrantRequest::SetGrantToken ( Aws::String &&  value)
inline

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

Definition at line 79 of file RetireGrantRequest.h.

◆ SetGrantToken() [2/3]

void Aws::KMS::Model::RetireGrantRequest::SetGrantToken ( const Aws::String value)
inline

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

Definition at line 68 of file RetireGrantRequest.h.

◆ SetGrantToken() [3/3]

void Aws::KMS::Model::RetireGrantRequest::SetGrantToken ( const char *  value)
inline

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

Definition at line 90 of file RetireGrantRequest.h.

◆ SetKeyId() [1/3]

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

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

Definition at line 156 of file RetireGrantRequest.h.

◆ SetKeyId() [2/3]

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

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

Definition at line 148 of file RetireGrantRequest.h.

◆ SetKeyId() [3/3]

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

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

Definition at line 164 of file RetireGrantRequest.h.

◆ WithGrantId() [1/3]

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

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Definition at line 245 of file RetireGrantRequest.h.

◆ WithGrantId() [2/3]

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

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Definition at line 237 of file RetireGrantRequest.h.

◆ WithGrantId() [3/3]

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

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Definition at line 253 of file RetireGrantRequest.h.

◆ WithGrantToken() [1/3]

RetireGrantRequest& Aws::KMS::Model::RetireGrantRequest::WithGrantToken ( Aws::String &&  value)
inline

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

Definition at line 112 of file RetireGrantRequest.h.

◆ WithGrantToken() [2/3]

RetireGrantRequest& Aws::KMS::Model::RetireGrantRequest::WithGrantToken ( const Aws::String value)
inline

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

Definition at line 101 of file RetireGrantRequest.h.

◆ WithGrantToken() [3/3]

RetireGrantRequest& Aws::KMS::Model::RetireGrantRequest::WithGrantToken ( const char *  value)
inline

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

Definition at line 123 of file RetireGrantRequest.h.

◆ WithKeyId() [1/3]

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

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

Definition at line 180 of file RetireGrantRequest.h.

◆ WithKeyId() [2/3]

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

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

Definition at line 172 of file RetireGrantRequest.h.

◆ WithKeyId() [3/3]

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

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

Definition at line 188 of file RetireGrantRequest.h.


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