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.
Constructor and Description |
---|
GetCredentialsForIdentityRequest() |
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.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getIdentityId()
A unique identifier in the format REGION:GUID.
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
A unique identifier in the format REGION:GUID.
public void setIdentityId(String identityId)
A unique identifier in the format REGION:GUID.
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
identityId
- A unique identifier in the format REGION:GUID.
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-]+
identityId
- A unique identifier in the format REGION:GUID.
public Map<String,String> getLogins()
A set of optional name-value pairs that map provider names to provider tokens.
A set of optional name-value pairs that map provider names to provider tokens.
public void setLogins(Map<String,String> logins)
A set of optional name-value pairs that map provider names to provider tokens.
logins
- A set of optional name-value pairs that map provider names to provider tokens.
public GetCredentialsForIdentityRequest withLogins(Map<String,String> logins)
A set of optional name-value pairs that map provider names to provider tokens.
Returns a reference to this object so that method calls can be chained together.
logins
- A set of optional name-value pairs that map provider names to provider tokens.
public GetCredentialsForIdentityRequest addLoginsEntry(String key, String value)
A set of optional name-value pairs that map provider names to provider tokens.
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.
key
- The key of the entry to be added into Logins.value
- The corresponding value of the entry to be added into
Logins.public GetCredentialsForIdentityRequest clearLoginsEntries()
Returns a reference to this object so that method calls can be chained together.
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
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.
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
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.
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
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.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2018. All rights reserved.