com.amazonaws.services.cognitoidentity.model

Class GetCredentialsForIdentityRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentity.model.GetCredentialsForIdentityRequest

All Implemented Interfaces:

Serializable, Cloneable

public class GetCredentialsForIdentityRequest
extends AmazonWebServiceRequest
implements Serializable

Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.

This is a public API. You do not need any credentials to call this API.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetCredentialsForIdentityRequest()

Method Summary

Modifier and Type	Method and Description
GetCredentialsForIdentityRequest	addLoginsEntry(String key, String value) A set of optional name-value pairs that map provider names to provider tokens.
GetCredentialsForIdentityRequest	clearLoginsEntries() Removes all the entries added into Logins.
boolean	equals(Object obj)
String	getCustomRoleArn() The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider.
String	getIdentityId() A unique identifier in the format REGION:GUID.
Map<String,String>	getLogins() A set of optional name-value pairs that map provider names to provider tokens.
int	hashCode()
void	setCustomRoleArn(String customRoleArn) The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider.
void	setIdentityId(String identityId) A unique identifier in the format REGION:GUID.
void	setLogins(Map<String,String> logins) A set of optional name-value pairs that map provider names to provider tokens.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetCredentialsForIdentityRequest	withCustomRoleArn(String customRoleArn) The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider.
GetCredentialsForIdentityRequest	withIdentityId(String identityId) A unique identifier in the format REGION:GUID.
GetCredentialsForIdentityRequest	withLogins(Map<String,String> logins) A set of optional name-value pairs that map provider names to provider tokens.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetCredentialsForIdentityRequest

public GetCredentialsForIdentityRequest()

Method Detail

getIdentityId

public String getIdentityId()

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Returns:

A unique identifier in the format REGION:GUID.

setIdentityId

public void setIdentityId(String identityId)

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityId -

A unique identifier in the format REGION:GUID.

withIdentityId

public GetCredentialsForIdentityRequest withIdentityId(String identityId)

A unique identifier in the format REGION:GUID.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityId -

A unique identifier in the format REGION:GUID.

Returns:

A reference to this updated object so that method calls can be chained together.

getLogins

public Map<String,String> getLogins()

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.

Returns:

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.

setLogins

public void setLogins(Map<String,String> logins)

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.

Parameters:

logins -

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.

withLogins

public GetCredentialsForIdentityRequest withLogins(Map<String,String> logins)

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

logins -

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.

Returns:

A reference to this updated object so that method calls can be chained together.

addLoginsEntry

public GetCredentialsForIdentityRequest addLoginsEntry(String key,
                                                       String value)

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.

The method adds a new key-value pair into Logins parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Logins.

value - The corresponding value of the entry to be added into Logins.

Returns:

A reference to this updated object so that method calls can be chained together.

clearLoginsEntries

public GetCredentialsForIdentityRequest clearLoginsEntries()

Removes all the entries added into Logins.

Returns a reference to this object so that method calls can be chained together.

getCustomRoleArn

public String getCustomRoleArn()

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.

Constraints:
Length: 20 - 2048

Returns:

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.

setCustomRoleArn

public void setCustomRoleArn(String customRoleArn)

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.

Constraints:
Length: 20 - 2048

Parameters:

customRoleArn -

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.

withCustomRoleArn

public GetCredentialsForIdentityRequest withCustomRoleArn(String customRoleArn)

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 20 - 2048

Parameters:

customRoleArn -

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.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object