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

#include <AssumeRoleWithSAMLRequest.h>

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

Public Member Functions

 AssumeRoleWithSAMLRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
AssumeRoleWithSAMLRequestWithRoleArn (const Aws::String &value)
 
AssumeRoleWithSAMLRequestWithRoleArn (Aws::String &&value)
 
AssumeRoleWithSAMLRequestWithRoleArn (const char *value)
 
const Aws::StringGetPrincipalArn () const
 
bool PrincipalArnHasBeenSet () const
 
void SetPrincipalArn (const Aws::String &value)
 
void SetPrincipalArn (Aws::String &&value)
 
void SetPrincipalArn (const char *value)
 
AssumeRoleWithSAMLRequestWithPrincipalArn (const Aws::String &value)
 
AssumeRoleWithSAMLRequestWithPrincipalArn (Aws::String &&value)
 
AssumeRoleWithSAMLRequestWithPrincipalArn (const char *value)
 
const Aws::StringGetSAMLAssertion () const
 
bool SAMLAssertionHasBeenSet () const
 
void SetSAMLAssertion (const Aws::String &value)
 
void SetSAMLAssertion (Aws::String &&value)
 
void SetSAMLAssertion (const char *value)
 
AssumeRoleWithSAMLRequestWithSAMLAssertion (const Aws::String &value)
 
AssumeRoleWithSAMLRequestWithSAMLAssertion (Aws::String &&value)
 
AssumeRoleWithSAMLRequestWithSAMLAssertion (const char *value)
 
const Aws::Vector< PolicyDescriptorType > & GetPolicyArns () const
 
bool PolicyArnsHasBeenSet () const
 
void SetPolicyArns (const Aws::Vector< PolicyDescriptorType > &value)
 
void SetPolicyArns (Aws::Vector< PolicyDescriptorType > &&value)
 
AssumeRoleWithSAMLRequestWithPolicyArns (const Aws::Vector< PolicyDescriptorType > &value)
 
AssumeRoleWithSAMLRequestWithPolicyArns (Aws::Vector< PolicyDescriptorType > &&value)
 
AssumeRoleWithSAMLRequestAddPolicyArns (const PolicyDescriptorType &value)
 
AssumeRoleWithSAMLRequestAddPolicyArns (PolicyDescriptorType &&value)
 
const Aws::StringGetPolicy () const
 
bool PolicyHasBeenSet () const
 
void SetPolicy (const Aws::String &value)
 
void SetPolicy (Aws::String &&value)
 
void SetPolicy (const char *value)
 
AssumeRoleWithSAMLRequestWithPolicy (const Aws::String &value)
 
AssumeRoleWithSAMLRequestWithPolicy (Aws::String &&value)
 
AssumeRoleWithSAMLRequestWithPolicy (const char *value)
 
int GetDurationSeconds () const
 
bool DurationSecondsHasBeenSet () const
 
void SetDurationSeconds (int value)
 
AssumeRoleWithSAMLRequestWithDurationSeconds (int 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 23 of file AssumeRoleWithSAMLRequest.h.

Constructor & Destructor Documentation

◆ AssumeRoleWithSAMLRequest()

Aws::STS::Model::AssumeRoleWithSAMLRequest::AssumeRoleWithSAMLRequest ( )

Member Function Documentation

◆ AddPolicyArns() [1/2]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::AddPolicyArns ( const PolicyDescriptorType value)
inline

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

Definition at line 376 of file AssumeRoleWithSAMLRequest.h.

◆ AddPolicyArns() [2/2]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::AddPolicyArns ( PolicyDescriptorType &&  value)
inline

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

Definition at line 402 of file AssumeRoleWithSAMLRequest.h.

◆ DumpBodyToUrl()

void Aws::STS::Model::AssumeRoleWithSAMLRequest::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::AssumeRoleWithSAMLRequest::DurationSecondsHasBeenSet ( ) const
inline

The duration, in seconds, of the role session. Your role session lasts for the duration that you specify for the DurationSeconds parameter, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide.

By default, the value is set to 3600 seconds.

The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide.

Definition at line 646 of file AssumeRoleWithSAMLRequest.h.

◆ GetDurationSeconds()

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

The duration, in seconds, of the role session. Your role session lasts for the duration that you specify for the DurationSeconds parameter, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide.

By default, the value is set to 3600 seconds.

The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide.

Definition at line 621 of file AssumeRoleWithSAMLRequest.h.

◆ GetPolicy()

const Aws::String& Aws::STS::Model::AssumeRoleWithSAMLRequest::GetPolicy ( ) const
inline

An IAM policy in JSON format that you want to use as an inline session policy.

This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

The plain text that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ). It can also include the tab (), linefeed (), and carriage return () characters.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Definition at line 427 of file AssumeRoleWithSAMLRequest.h.

◆ GetPolicyArns()

const Aws::Vector<PolicyDescriptorType>& Aws::STS::Model::AssumeRoleWithSAMLRequest::GetPolicyArns ( ) const
inline

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

Definition at line 220 of file AssumeRoleWithSAMLRequest.h.

◆ GetPrincipalArn()

const Aws::String& Aws::STS::Model::AssumeRoleWithSAMLRequest::GetPrincipalArn ( ) const
inline

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

Definition at line 86 of file AssumeRoleWithSAMLRequest.h.

◆ GetRoleArn()

const Aws::String& Aws::STS::Model::AssumeRoleWithSAMLRequest::GetRoleArn ( ) const
inline

The Amazon Resource Name (ARN) of the role that the caller is assuming.

Definition at line 44 of file AssumeRoleWithSAMLRequest.h.

◆ GetSAMLAssertion()

const Aws::String& Aws::STS::Model::AssumeRoleWithSAMLRequest::GetSAMLAssertion ( ) const
inline

The base-64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.

Definition at line 137 of file AssumeRoleWithSAMLRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file AssumeRoleWithSAMLRequest.h.

◆ PolicyArnsHasBeenSet()

bool Aws::STS::Model::AssumeRoleWithSAMLRequest::PolicyArnsHasBeenSet ( ) const
inline

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

Definition at line 246 of file AssumeRoleWithSAMLRequest.h.

◆ PolicyHasBeenSet()

bool Aws::STS::Model::AssumeRoleWithSAMLRequest::PolicyHasBeenSet ( ) const
inline

An IAM policy in JSON format that you want to use as an inline session policy.

This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

The plain text that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ). It can also include the tab (), linefeed (), and carriage return () characters.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Definition at line 451 of file AssumeRoleWithSAMLRequest.h.

◆ PrincipalArnHasBeenSet()

bool Aws::STS::Model::AssumeRoleWithSAMLRequest::PrincipalArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

Definition at line 92 of file AssumeRoleWithSAMLRequest.h.

◆ RoleArnHasBeenSet()

bool Aws::STS::Model::AssumeRoleWithSAMLRequest::RoleArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the role that the caller is assuming.

Definition at line 49 of file AssumeRoleWithSAMLRequest.h.

◆ SAMLAssertionHasBeenSet()

bool Aws::STS::Model::AssumeRoleWithSAMLRequest::SAMLAssertionHasBeenSet ( ) const
inline

The base-64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.

Definition at line 145 of file AssumeRoleWithSAMLRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDurationSeconds()

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

The duration, in seconds, of the role session. Your role session lasts for the duration that you specify for the DurationSeconds parameter, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide.

By default, the value is set to 3600 seconds.

The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide.

Definition at line 671 of file AssumeRoleWithSAMLRequest.h.

◆ SetPolicy() [1/3]

void Aws::STS::Model::AssumeRoleWithSAMLRequest::SetPolicy ( const Aws::String value)
inline

An IAM policy in JSON format that you want to use as an inline session policy.

This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

The plain text that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ). It can also include the tab (), linefeed (), and carriage return () characters.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Definition at line 475 of file AssumeRoleWithSAMLRequest.h.

◆ SetPolicy() [2/3]

void Aws::STS::Model::AssumeRoleWithSAMLRequest::SetPolicy ( Aws::String &&  value)
inline

An IAM policy in JSON format that you want to use as an inline session policy.

This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

The plain text that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ). It can also include the tab (), linefeed (), and carriage return () characters.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Definition at line 499 of file AssumeRoleWithSAMLRequest.h.

◆ SetPolicy() [3/3]

void Aws::STS::Model::AssumeRoleWithSAMLRequest::SetPolicy ( const char *  value)
inline

An IAM policy in JSON format that you want to use as an inline session policy.

This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

The plain text that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ). It can also include the tab (), linefeed (), and carriage return () characters.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Definition at line 523 of file AssumeRoleWithSAMLRequest.h.

◆ SetPolicyArns() [1/2]

void Aws::STS::Model::AssumeRoleWithSAMLRequest::SetPolicyArns ( const Aws::Vector< PolicyDescriptorType > &  value)
inline

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

Definition at line 272 of file AssumeRoleWithSAMLRequest.h.

◆ SetPolicyArns() [2/2]

void Aws::STS::Model::AssumeRoleWithSAMLRequest::SetPolicyArns ( Aws::Vector< PolicyDescriptorType > &&  value)
inline

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

Definition at line 298 of file AssumeRoleWithSAMLRequest.h.

◆ SetPrincipalArn() [1/3]

void Aws::STS::Model::AssumeRoleWithSAMLRequest::SetPrincipalArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

Definition at line 98 of file AssumeRoleWithSAMLRequest.h.

◆ SetPrincipalArn() [2/3]

void Aws::STS::Model::AssumeRoleWithSAMLRequest::SetPrincipalArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

Definition at line 104 of file AssumeRoleWithSAMLRequest.h.

◆ SetPrincipalArn() [3/3]

void Aws::STS::Model::AssumeRoleWithSAMLRequest::SetPrincipalArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

Definition at line 110 of file AssumeRoleWithSAMLRequest.h.

◆ SetRoleArn() [1/3]

void Aws::STS::Model::AssumeRoleWithSAMLRequest::SetRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the role that the caller is assuming.

Definition at line 54 of file AssumeRoleWithSAMLRequest.h.

◆ SetRoleArn() [2/3]

void Aws::STS::Model::AssumeRoleWithSAMLRequest::SetRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the role that the caller is assuming.

Definition at line 59 of file AssumeRoleWithSAMLRequest.h.

◆ SetRoleArn() [3/3]

void Aws::STS::Model::AssumeRoleWithSAMLRequest::SetRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the role that the caller is assuming.

Definition at line 64 of file AssumeRoleWithSAMLRequest.h.

◆ SetSAMLAssertion() [1/3]

void Aws::STS::Model::AssumeRoleWithSAMLRequest::SetSAMLAssertion ( const Aws::String value)
inline

The base-64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.

Definition at line 153 of file AssumeRoleWithSAMLRequest.h.

◆ SetSAMLAssertion() [2/3]

void Aws::STS::Model::AssumeRoleWithSAMLRequest::SetSAMLAssertion ( Aws::String &&  value)
inline

The base-64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.

Definition at line 161 of file AssumeRoleWithSAMLRequest.h.

◆ SetSAMLAssertion() [3/3]

void Aws::STS::Model::AssumeRoleWithSAMLRequest::SetSAMLAssertion ( const char *  value)
inline

The base-64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.

Definition at line 169 of file AssumeRoleWithSAMLRequest.h.

◆ WithDurationSeconds()

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

The duration, in seconds, of the role session. Your role session lasts for the duration that you specify for the DurationSeconds parameter, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide.

By default, the value is set to 3600 seconds.

The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide.

Definition at line 696 of file AssumeRoleWithSAMLRequest.h.

◆ WithPolicy() [1/3]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::WithPolicy ( const Aws::String value)
inline

An IAM policy in JSON format that you want to use as an inline session policy.

This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

The plain text that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ). It can also include the tab (), linefeed (), and carriage return () characters.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Definition at line 547 of file AssumeRoleWithSAMLRequest.h.

◆ WithPolicy() [2/3]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::WithPolicy ( Aws::String &&  value)
inline

An IAM policy in JSON format that you want to use as an inline session policy.

This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

The plain text that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ). It can also include the tab (), linefeed (), and carriage return () characters.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Definition at line 571 of file AssumeRoleWithSAMLRequest.h.

◆ WithPolicy() [3/3]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::WithPolicy ( const char *  value)
inline

An IAM policy in JSON format that you want to use as an inline session policy.

This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

The plain text that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ). It can also include the tab (), linefeed (), and carriage return () characters.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Definition at line 595 of file AssumeRoleWithSAMLRequest.h.

◆ WithPolicyArns() [1/2]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::WithPolicyArns ( const Aws::Vector< PolicyDescriptorType > &  value)
inline

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

Definition at line 324 of file AssumeRoleWithSAMLRequest.h.

◆ WithPolicyArns() [2/2]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::WithPolicyArns ( Aws::Vector< PolicyDescriptorType > &&  value)
inline

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

An AWS conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plain text meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

Definition at line 350 of file AssumeRoleWithSAMLRequest.h.

◆ WithPrincipalArn() [1/3]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::WithPrincipalArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

Definition at line 116 of file AssumeRoleWithSAMLRequest.h.

◆ WithPrincipalArn() [2/3]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::WithPrincipalArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

Definition at line 122 of file AssumeRoleWithSAMLRequest.h.

◆ WithPrincipalArn() [3/3]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::WithPrincipalArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

Definition at line 128 of file AssumeRoleWithSAMLRequest.h.

◆ WithRoleArn() [1/3]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::WithRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the role that the caller is assuming.

Definition at line 69 of file AssumeRoleWithSAMLRequest.h.

◆ WithRoleArn() [2/3]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::WithRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the role that the caller is assuming.

Definition at line 74 of file AssumeRoleWithSAMLRequest.h.

◆ WithRoleArn() [3/3]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::WithRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the role that the caller is assuming.

Definition at line 79 of file AssumeRoleWithSAMLRequest.h.

◆ WithSAMLAssertion() [1/3]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::WithSAMLAssertion ( const Aws::String value)
inline

The base-64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.

Definition at line 177 of file AssumeRoleWithSAMLRequest.h.

◆ WithSAMLAssertion() [2/3]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::WithSAMLAssertion ( Aws::String &&  value)
inline

The base-64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.

Definition at line 185 of file AssumeRoleWithSAMLRequest.h.

◆ WithSAMLAssertion() [3/3]

AssumeRoleWithSAMLRequest& Aws::STS::Model::AssumeRoleWithSAMLRequest::WithSAMLAssertion ( const char *  value)
inline

The base-64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.

Definition at line 193 of file AssumeRoleWithSAMLRequest.h.


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