AWS SDK for C++  1.8.71
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::STS::Model::GetSessionTokenRequest Class Reference

#include <GetSessionTokenRequest.h>

+ Inheritance diagram for Aws::STS::Model::GetSessionTokenRequest:

Public Member Functions

 GetSessionTokenRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
int GetDurationSeconds () const
 
bool DurationSecondsHasBeenSet () const
 
void SetDurationSeconds (int value)
 
GetSessionTokenRequestWithDurationSeconds (int value)
 
const Aws::StringGetSerialNumber () const
 
bool SerialNumberHasBeenSet () const
 
void SetSerialNumber (const Aws::String &value)
 
void SetSerialNumber (Aws::String &&value)
 
void SetSerialNumber (const char *value)
 
GetSessionTokenRequestWithSerialNumber (const Aws::String &value)
 
GetSessionTokenRequestWithSerialNumber (Aws::String &&value)
 
GetSessionTokenRequestWithSerialNumber (const char *value)
 
const Aws::StringGetTokenCode () const
 
bool TokenCodeHasBeenSet () const
 
void SetTokenCode (const Aws::String &value)
 
void SetTokenCode (Aws::String &&value)
 
void SetTokenCode (const char *value)
 
GetSessionTokenRequestWithTokenCode (const Aws::String &value)
 
GetSessionTokenRequestWithTokenCode (Aws::String &&value)
 
GetSessionTokenRequestWithTokenCode (const char *value)
 
- Public Member Functions inherited from Aws::STS::STSRequest
virtual ~STSRequest ()
 
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
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::STS::STSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 21 of file GetSessionTokenRequest.h.

Constructor & Destructor Documentation

◆ GetSessionTokenRequest()

Aws::STS::Model::GetSessionTokenRequest::GetSessionTokenRequest ( )

Member Function Documentation

◆ DumpBodyToUrl()

void Aws::STS::Model::GetSessionTokenRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ DurationSecondsHasBeenSet()

bool Aws::STS::Model::GetSessionTokenRequest::DurationSecondsHasBeenSet ( ) const
inline

The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.

Definition at line 57 of file GetSessionTokenRequest.h.

◆ GetDurationSeconds()

int Aws::STS::Model::GetSessionTokenRequest::GetDurationSeconds ( ) const
inline

The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.

Definition at line 47 of file GetSessionTokenRequest.h.

◆ GetSerialNumber()

const Aws::String& Aws::STS::Model::GetSessionTokenRequest::GetSerialNumber ( ) const
inline

The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 93 of file GetSessionTokenRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::STS::Model::GetSessionTokenRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file GetSessionTokenRequest.h.

◆ GetTokenCode()

const Aws::String& Aws::STS::Model::GetSessionTokenRequest::GetTokenCode ( ) const
inline

The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication.

The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

Definition at line 210 of file GetSessionTokenRequest.h.

◆ SerializePayload()

Aws::String Aws::STS::Model::GetSessionTokenRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SerialNumberHasBeenSet()

bool Aws::STS::Model::GetSessionTokenRequest::SerialNumberHasBeenSet ( ) const
inline

The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 108 of file GetSessionTokenRequest.h.

◆ SetDurationSeconds()

void Aws::STS::Model::GetSessionTokenRequest::SetDurationSeconds ( int  value)
inline

The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.

Definition at line 67 of file GetSessionTokenRequest.h.

◆ SetSerialNumber() [1/3]

void Aws::STS::Model::GetSessionTokenRequest::SetSerialNumber ( const Aws::String value)
inline

The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 123 of file GetSessionTokenRequest.h.

◆ SetSerialNumber() [2/3]

void Aws::STS::Model::GetSessionTokenRequest::SetSerialNumber ( Aws::String &&  value)
inline

The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 138 of file GetSessionTokenRequest.h.

◆ SetSerialNumber() [3/3]

void Aws::STS::Model::GetSessionTokenRequest::SetSerialNumber ( const char *  value)
inline

The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 153 of file GetSessionTokenRequest.h.

◆ SetTokenCode() [1/3]

void Aws::STS::Model::GetSessionTokenRequest::SetTokenCode ( const Aws::String value)
inline

The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication.

The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

Definition at line 232 of file GetSessionTokenRequest.h.

◆ SetTokenCode() [2/3]

void Aws::STS::Model::GetSessionTokenRequest::SetTokenCode ( Aws::String &&  value)
inline

The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication.

The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

Definition at line 243 of file GetSessionTokenRequest.h.

◆ SetTokenCode() [3/3]

void Aws::STS::Model::GetSessionTokenRequest::SetTokenCode ( const char *  value)
inline

The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication.

The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

Definition at line 254 of file GetSessionTokenRequest.h.

◆ TokenCodeHasBeenSet()

bool Aws::STS::Model::GetSessionTokenRequest::TokenCodeHasBeenSet ( ) const
inline

The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication.

The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

Definition at line 221 of file GetSessionTokenRequest.h.

◆ WithDurationSeconds()

GetSessionTokenRequest& Aws::STS::Model::GetSessionTokenRequest::WithDurationSeconds ( int  value)
inline

The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.

Definition at line 77 of file GetSessionTokenRequest.h.

◆ WithSerialNumber() [1/3]

GetSessionTokenRequest& Aws::STS::Model::GetSessionTokenRequest::WithSerialNumber ( const Aws::String value)
inline

The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 168 of file GetSessionTokenRequest.h.

◆ WithSerialNumber() [2/3]

GetSessionTokenRequest& Aws::STS::Model::GetSessionTokenRequest::WithSerialNumber ( Aws::String &&  value)
inline

The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 183 of file GetSessionTokenRequest.h.

◆ WithSerialNumber() [3/3]

GetSessionTokenRequest& Aws::STS::Model::GetSessionTokenRequest::WithSerialNumber ( const char *  value)
inline

The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 198 of file GetSessionTokenRequest.h.

◆ WithTokenCode() [1/3]

GetSessionTokenRequest& Aws::STS::Model::GetSessionTokenRequest::WithTokenCode ( const Aws::String value)
inline

The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication.

The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

Definition at line 265 of file GetSessionTokenRequest.h.

◆ WithTokenCode() [2/3]

GetSessionTokenRequest& Aws::STS::Model::GetSessionTokenRequest::WithTokenCode ( Aws::String &&  value)
inline

The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication.

The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

Definition at line 276 of file GetSessionTokenRequest.h.

◆ WithTokenCode() [3/3]

GetSessionTokenRequest& Aws::STS::Model::GetSessionTokenRequest::WithTokenCode ( const char *  value)
inline

The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication.

The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

Definition at line 287 of file GetSessionTokenRequest.h.


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