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

#include <SignRequest.h>

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

Public Member Functions

 SignRequest ()
 
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)
 
SignRequestWithKeyId (const Aws::String &value)
 
SignRequestWithKeyId (Aws::String &&value)
 
SignRequestWithKeyId (const char *value)
 
const Aws::Utils::CryptoBufferGetMessage () const
 
bool MessageHasBeenSet () const
 
void SetMessage (const Aws::Utils::CryptoBuffer &value)
 
void SetMessage (Aws::Utils::CryptoBuffer &&value)
 
SignRequestWithMessage (const Aws::Utils::CryptoBuffer &value)
 
SignRequestWithMessage (Aws::Utils::CryptoBuffer &&value)
 
const MessageTypeGetMessageType () const
 
bool MessageTypeHasBeenSet () const
 
void SetMessageType (const MessageType &value)
 
void SetMessageType (MessageType &&value)
 
SignRequestWithMessageType (const MessageType &value)
 
SignRequestWithMessageType (MessageType &&value)
 
const Aws::Vector< Aws::String > & GetGrantTokens () const
 
bool GrantTokensHasBeenSet () const
 
void SetGrantTokens (const Aws::Vector< Aws::String > &value)
 
void SetGrantTokens (Aws::Vector< Aws::String > &&value)
 
SignRequestWithGrantTokens (const Aws::Vector< Aws::String > &value)
 
SignRequestWithGrantTokens (Aws::Vector< Aws::String > &&value)
 
SignRequestAddGrantTokens (const Aws::String &value)
 
SignRequestAddGrantTokens (Aws::String &&value)
 
SignRequestAddGrantTokens (const char *value)
 
const SigningAlgorithmSpecGetSigningAlgorithm () const
 
bool SigningAlgorithmHasBeenSet () const
 
void SetSigningAlgorithm (const SigningAlgorithmSpec &value)
 
void SetSigningAlgorithm (SigningAlgorithmSpec &&value)
 
SignRequestWithSigningAlgorithm (const SigningAlgorithmSpec &value)
 
SignRequestWithSigningAlgorithm (SigningAlgorithmSpec &&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 25 of file SignRequest.h.

Constructor & Destructor Documentation

◆ SignRequest()

Aws::KMS::Model::SignRequest::SignRequest ( )

Member Function Documentation

◆ AddGrantTokens() [1/3]

SignRequest& Aws::KMS::Model::SignRequest::AddGrantTokens ( const Aws::String value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 325 of file SignRequest.h.

◆ AddGrantTokens() [2/3]

SignRequest& Aws::KMS::Model::SignRequest::AddGrantTokens ( Aws::String &&  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 332 of file SignRequest.h.

◆ AddGrantTokens() [3/3]

SignRequest& Aws::KMS::Model::SignRequest::AddGrantTokens ( const char *  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 339 of file SignRequest.h.

◆ GetGrantTokens()

const Aws::Vector<Aws::String>& Aws::KMS::Model::SignRequest::GetGrantTokens ( ) const
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 283 of file SignRequest.h.

◆ GetKeyId()

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

Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias 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

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 57 of file SignRequest.h.

◆ GetMessage()

const Aws::Utils::CryptoBuffer& Aws::KMS::Model::SignRequest::GetMessage ( ) const
inline

Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.

If you provide a message, AWS KMS generates a hash digest of the message and then signs it.

Definition at line 192 of file SignRequest.h.

◆ GetMessageType()

const MessageType& Aws::KMS::Model::SignRequest::GetMessageType ( ) const
inline

Tells AWS KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

Definition at line 240 of file SignRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file SignRequest.h.

◆ GetSigningAlgorithm()

const SigningAlgorithmSpec& Aws::KMS::Model::SignRequest::GetSigningAlgorithm ( ) const
inline

Specifies the signing algorithm to use when signing the message.

Choose an algorithm that is compatible with the type and size of the specified asymmetric CMK.

Definition at line 347 of file SignRequest.h.

◆ GrantTokensHasBeenSet()

bool Aws::KMS::Model::SignRequest::GrantTokensHasBeenSet ( ) const
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 290 of file SignRequest.h.

◆ KeyIdHasBeenSet()

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

Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias 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

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 75 of file SignRequest.h.

◆ MessageHasBeenSet()

bool Aws::KMS::Model::SignRequest::MessageHasBeenSet ( ) const
inline

Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.

If you provide a message, AWS KMS generates a hash digest of the message and then signs it.

Definition at line 200 of file SignRequest.h.

◆ MessageTypeHasBeenSet()

bool Aws::KMS::Model::SignRequest::MessageTypeHasBeenSet ( ) const
inline

Tells AWS KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

Definition at line 247 of file SignRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetGrantTokens() [1/2]

void Aws::KMS::Model::SignRequest::SetGrantTokens ( const Aws::Vector< Aws::String > &  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 297 of file SignRequest.h.

◆ SetGrantTokens() [2/2]

void Aws::KMS::Model::SignRequest::SetGrantTokens ( Aws::Vector< Aws::String > &&  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 304 of file SignRequest.h.

◆ SetKeyId() [1/3]

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

Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias 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

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 93 of file SignRequest.h.

◆ SetKeyId() [2/3]

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

Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias 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

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 111 of file SignRequest.h.

◆ SetKeyId() [3/3]

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

Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias 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

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 129 of file SignRequest.h.

◆ SetMessage() [1/2]

void Aws::KMS::Model::SignRequest::SetMessage ( const Aws::Utils::CryptoBuffer value)
inline

Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.

If you provide a message, AWS KMS generates a hash digest of the message and then signs it.

Definition at line 208 of file SignRequest.h.

◆ SetMessage() [2/2]

void Aws::KMS::Model::SignRequest::SetMessage ( Aws::Utils::CryptoBuffer &&  value)
inline

Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.

If you provide a message, AWS KMS generates a hash digest of the message and then signs it.

Definition at line 216 of file SignRequest.h.

◆ SetMessageType() [1/2]

void Aws::KMS::Model::SignRequest::SetMessageType ( const MessageType value)
inline

Tells AWS KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

Definition at line 254 of file SignRequest.h.

◆ SetMessageType() [2/2]

void Aws::KMS::Model::SignRequest::SetMessageType ( MessageType &&  value)
inline

Tells AWS KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

Definition at line 261 of file SignRequest.h.

◆ SetSigningAlgorithm() [1/2]

void Aws::KMS::Model::SignRequest::SetSigningAlgorithm ( const SigningAlgorithmSpec value)
inline

Specifies the signing algorithm to use when signing the message.

Choose an algorithm that is compatible with the type and size of the specified asymmetric CMK.

Definition at line 361 of file SignRequest.h.

◆ SetSigningAlgorithm() [2/2]

void Aws::KMS::Model::SignRequest::SetSigningAlgorithm ( SigningAlgorithmSpec &&  value)
inline

Specifies the signing algorithm to use when signing the message.

Choose an algorithm that is compatible with the type and size of the specified asymmetric CMK.

Definition at line 368 of file SignRequest.h.

◆ SigningAlgorithmHasBeenSet()

bool Aws::KMS::Model::SignRequest::SigningAlgorithmHasBeenSet ( ) const
inline

Specifies the signing algorithm to use when signing the message.

Choose an algorithm that is compatible with the type and size of the specified asymmetric CMK.

Definition at line 354 of file SignRequest.h.

◆ WithGrantTokens() [1/2]

SignRequest& Aws::KMS::Model::SignRequest::WithGrantTokens ( const Aws::Vector< Aws::String > &  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 311 of file SignRequest.h.

◆ WithGrantTokens() [2/2]

SignRequest& Aws::KMS::Model::SignRequest::WithGrantTokens ( Aws::Vector< Aws::String > &&  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 318 of file SignRequest.h.

◆ WithKeyId() [1/3]

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

Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias 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

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 147 of file SignRequest.h.

◆ WithKeyId() [2/3]

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

Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias 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

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 165 of file SignRequest.h.

◆ WithKeyId() [3/3]

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

Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias 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

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 183 of file SignRequest.h.

◆ WithMessage() [1/2]

SignRequest& Aws::KMS::Model::SignRequest::WithMessage ( const Aws::Utils::CryptoBuffer value)
inline

Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.

If you provide a message, AWS KMS generates a hash digest of the message and then signs it.

Definition at line 224 of file SignRequest.h.

◆ WithMessage() [2/2]

SignRequest& Aws::KMS::Model::SignRequest::WithMessage ( Aws::Utils::CryptoBuffer &&  value)
inline

Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.

If you provide a message, AWS KMS generates a hash digest of the message and then signs it.

Definition at line 232 of file SignRequest.h.

◆ WithMessageType() [1/2]

SignRequest& Aws::KMS::Model::SignRequest::WithMessageType ( const MessageType value)
inline

Tells AWS KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

Definition at line 268 of file SignRequest.h.

◆ WithMessageType() [2/2]

SignRequest& Aws::KMS::Model::SignRequest::WithMessageType ( MessageType &&  value)
inline

Tells AWS KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

Definition at line 275 of file SignRequest.h.

◆ WithSigningAlgorithm() [1/2]

SignRequest& Aws::KMS::Model::SignRequest::WithSigningAlgorithm ( const SigningAlgorithmSpec value)
inline

Specifies the signing algorithm to use when signing the message.

Choose an algorithm that is compatible with the type and size of the specified asymmetric CMK.

Definition at line 375 of file SignRequest.h.

◆ WithSigningAlgorithm() [2/2]

SignRequest& Aws::KMS::Model::SignRequest::WithSigningAlgorithm ( SigningAlgorithmSpec &&  value)
inline

Specifies the signing algorithm to use when signing the message.

Choose an algorithm that is compatible with the type and size of the specified asymmetric CMK.

Definition at line 382 of file SignRequest.h.


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