AWS SDK for C++  1.9.44
AWS SDK for C++
Public Member Functions | List of all members
Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest Class Reference

#include <GetCredentialsForIdentityRequest.h>

+ Inheritance diagram for Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest:

Public Member Functions

 GetCredentialsForIdentityRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetIdentityId () const
 
bool IdentityIdHasBeenSet () const
 
void SetIdentityId (const Aws::String &value)
 
void SetIdentityId (Aws::String &&value)
 
void SetIdentityId (const char *value)
 
GetCredentialsForIdentityRequestWithIdentityId (const Aws::String &value)
 
GetCredentialsForIdentityRequestWithIdentityId (Aws::String &&value)
 
GetCredentialsForIdentityRequestWithIdentityId (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetLogins () const
 
bool LoginsHasBeenSet () const
 
void SetLogins (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetLogins (Aws::Map< Aws::String, Aws::String > &&value)
 
GetCredentialsForIdentityRequestWithLogins (const Aws::Map< Aws::String, Aws::String > &value)
 
GetCredentialsForIdentityRequestWithLogins (Aws::Map< Aws::String, Aws::String > &&value)
 
GetCredentialsForIdentityRequestAddLogins (const Aws::String &key, const Aws::String &value)
 
GetCredentialsForIdentityRequestAddLogins (Aws::String &&key, const Aws::String &value)
 
GetCredentialsForIdentityRequestAddLogins (const Aws::String &key, Aws::String &&value)
 
GetCredentialsForIdentityRequestAddLogins (Aws::String &&key, Aws::String &&value)
 
GetCredentialsForIdentityRequestAddLogins (const char *key, Aws::String &&value)
 
GetCredentialsForIdentityRequestAddLogins (Aws::String &&key, const char *value)
 
GetCredentialsForIdentityRequestAddLogins (const char *key, const char *value)
 
const Aws::StringGetCustomRoleArn () const
 
bool CustomRoleArnHasBeenSet () const
 
void SetCustomRoleArn (const Aws::String &value)
 
void SetCustomRoleArn (Aws::String &&value)
 
void SetCustomRoleArn (const char *value)
 
GetCredentialsForIdentityRequestWithCustomRoleArn (const Aws::String &value)
 
GetCredentialsForIdentityRequestWithCustomRoleArn (Aws::String &&value)
 
GetCredentialsForIdentityRequestWithCustomRoleArn (const char *value)
 
- Public Member Functions inherited from Aws::CognitoIdentity::CognitoIdentityRequest
virtual ~CognitoIdentityRequest ()
 
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

Input to the GetCredentialsForIdentity action.

See Also:

AWS API Reference

Definition at line 26 of file GetCredentialsForIdentityRequest.h.

Constructor & Destructor Documentation

◆ GetCredentialsForIdentityRequest()

Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::GetCredentialsForIdentityRequest ( )

Member Function Documentation

◆ AddLogins() [1/7]

GetCredentialsForIdentityRequest& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::AddLogins ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

Definition at line 211 of file GetCredentialsForIdentityRequest.h.

◆ AddLogins() [2/7]

GetCredentialsForIdentityRequest& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::AddLogins ( Aws::String &&  key,
const Aws::String value 
)
inline

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

Definition at line 185 of file GetCredentialsForIdentityRequest.h.

◆ AddLogins() [3/7]

GetCredentialsForIdentityRequest& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::AddLogins ( Aws::String &&  key,
const char *  value 
)
inline

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

Definition at line 237 of file GetCredentialsForIdentityRequest.h.

◆ AddLogins() [4/7]

GetCredentialsForIdentityRequest& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::AddLogins ( const Aws::String key,
Aws::String &&  value 
)
inline

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

Definition at line 198 of file GetCredentialsForIdentityRequest.h.

◆ AddLogins() [5/7]

GetCredentialsForIdentityRequest& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::AddLogins ( const Aws::String key,
const Aws::String value 
)
inline

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

Definition at line 172 of file GetCredentialsForIdentityRequest.h.

◆ AddLogins() [6/7]

GetCredentialsForIdentityRequest& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::AddLogins ( const char *  key,
Aws::String &&  value 
)
inline

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

Definition at line 224 of file GetCredentialsForIdentityRequest.h.

◆ AddLogins() [7/7]

GetCredentialsForIdentityRequest& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::AddLogins ( const char *  key,
const char *  value 
)
inline

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

Definition at line 250 of file GetCredentialsForIdentityRequest.h.

◆ CustomRoleArnHasBeenSet()

bool Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::CustomRoleArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

Definition at line 267 of file GetCredentialsForIdentityRequest.h.

◆ GetCustomRoleArn()

const Aws::String& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::GetCustomRoleArn ( ) const
inline

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

Definition at line 259 of file GetCredentialsForIdentityRequest.h.

◆ GetIdentityId()

const Aws::String& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::GetIdentityId ( ) const
inline

A unique identifier in the format REGION:GUID.

Definition at line 45 of file GetCredentialsForIdentityRequest.h.

◆ GetLogins()

const Aws::Map<Aws::String, Aws::String>& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::GetLogins ( ) const
inline

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

Definition at line 94 of file GetCredentialsForIdentityRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file GetCredentialsForIdentityRequest.h.

◆ IdentityIdHasBeenSet()

bool Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::IdentityIdHasBeenSet ( ) const
inline

A unique identifier in the format REGION:GUID.

Definition at line 50 of file GetCredentialsForIdentityRequest.h.

◆ LoginsHasBeenSet()

bool Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::LoginsHasBeenSet ( ) const
inline

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

Definition at line 107 of file GetCredentialsForIdentityRequest.h.

◆ SerializePayload()

Aws::String Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCustomRoleArn() [1/3]

void Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::SetCustomRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

Definition at line 283 of file GetCredentialsForIdentityRequest.h.

◆ SetCustomRoleArn() [2/3]

void Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::SetCustomRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

Definition at line 275 of file GetCredentialsForIdentityRequest.h.

◆ SetCustomRoleArn() [3/3]

void Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::SetCustomRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

Definition at line 291 of file GetCredentialsForIdentityRequest.h.

◆ SetIdentityId() [1/3]

void Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::SetIdentityId ( Aws::String &&  value)
inline

A unique identifier in the format REGION:GUID.

Definition at line 60 of file GetCredentialsForIdentityRequest.h.

◆ SetIdentityId() [2/3]

void Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::SetIdentityId ( const Aws::String value)
inline

A unique identifier in the format REGION:GUID.

Definition at line 55 of file GetCredentialsForIdentityRequest.h.

◆ SetIdentityId() [3/3]

void Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::SetIdentityId ( const char *  value)
inline

A unique identifier in the format REGION:GUID.

Definition at line 65 of file GetCredentialsForIdentityRequest.h.

◆ SetLogins() [1/2]

void Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::SetLogins ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

Definition at line 133 of file GetCredentialsForIdentityRequest.h.

◆ SetLogins() [2/2]

void Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::SetLogins ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

Definition at line 120 of file GetCredentialsForIdentityRequest.h.

◆ WithCustomRoleArn() [1/3]

GetCredentialsForIdentityRequest& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::WithCustomRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

Definition at line 307 of file GetCredentialsForIdentityRequest.h.

◆ WithCustomRoleArn() [2/3]

GetCredentialsForIdentityRequest& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::WithCustomRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

Definition at line 299 of file GetCredentialsForIdentityRequest.h.

◆ WithCustomRoleArn() [3/3]

GetCredentialsForIdentityRequest& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::WithCustomRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

Definition at line 315 of file GetCredentialsForIdentityRequest.h.

◆ WithIdentityId() [1/3]

GetCredentialsForIdentityRequest& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::WithIdentityId ( Aws::String &&  value)
inline

A unique identifier in the format REGION:GUID.

Definition at line 75 of file GetCredentialsForIdentityRequest.h.

◆ WithIdentityId() [2/3]

GetCredentialsForIdentityRequest& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::WithIdentityId ( const Aws::String value)
inline

A unique identifier in the format REGION:GUID.

Definition at line 70 of file GetCredentialsForIdentityRequest.h.

◆ WithIdentityId() [3/3]

GetCredentialsForIdentityRequest& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::WithIdentityId ( const char *  value)
inline

A unique identifier in the format REGION:GUID.

Definition at line 80 of file GetCredentialsForIdentityRequest.h.

◆ WithLogins() [1/2]

GetCredentialsForIdentityRequest& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::WithLogins ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

Definition at line 159 of file GetCredentialsForIdentityRequest.h.

◆ WithLogins() [2/2]

GetCredentialsForIdentityRequest& Aws::CognitoIdentity::Model::GetCredentialsForIdentityRequest::WithLogins ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

Definition at line 146 of file GetCredentialsForIdentityRequest.h.


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