com.amazonaws.services.cognitoidentity.model

Class GetCredentialsForIdentityRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentity.model.GetCredentialsForIdentityRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetCredentialsForIdentityRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Input to the GetCredentialsForIdentity action.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetCredentialsForIdentityRequest()

Method Summary

Modifier and Type	Method and Description
GetCredentialsForIdentityRequest	addLoginsEntry(String key, String value) Add a single Logins entry
GetCredentialsForIdentityRequest	clearLoginsEntries() Removes all the entries added into Logins.
GetCredentialsForIdentityRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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.
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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetCredentialsForIdentityRequest

public GetCredentialsForIdentityRequest()

Method Detail

setIdentityId

public void setIdentityId(String identityId)

A unique identifier in the format REGION:GUID.

Parameters:

identityId - A unique identifier in the format REGION:GUID.

getIdentityId

public String getIdentityId()

A unique identifier in the format REGION:GUID.

Returns:

A unique identifier in the format REGION:GUID.

withIdentityId

public GetCredentialsForIdentityRequest withIdentityId(String identityId)

A unique identifier in the format REGION:GUID.

Parameters:

identityId - A unique identifier in the format REGION:GUID.

Returns:

Returns a reference to this 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.

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:

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

addLoginsEntry

public GetCredentialsForIdentityRequest addLoginsEntry(String key,
                                                       String value)

Add a single Logins entry

See Also:

withLogins(java.util.Map<java.lang.String, java.lang.String>)

clearLoginsEntries

public GetCredentialsForIdentityRequest clearLoginsEntries()

Removes all the entries added into Logins.

Returns:

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

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.

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.

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.

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.

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.

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:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetCredentialsForIdentityRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()