GetCredentialsForIdentityRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentity.model.GetCredentialsForIdentityRequest

All Implemented Interfaces:

Serializable
```
public class GetCredentialsForIdentityRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the GetCredentialsForIdentity operation.
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:

AmazonCognitoIdentity.getCredentialsForIdentity(GetCredentialsForIdentityRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetCredentialsForIdentityRequest()

Constructors
Constructor and Description
`GetCredentialsForIdentityRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
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()` Returns the value of the CustomRoleArn property for this object.
`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)` Sets the value of the CustomRoleArn property for this object.
`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)` Sets the value of the CustomRoleArn property for this object.
`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
getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
clone, 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.
    Constraints:
    Length: 0 - 10
    
    Returns:
    
    A set of optional name-value pairs that map provider names to provider tokens.
  - setLogins
```
public void setLogins(Map<String,String> logins)
```
    A set of optional name-value pairs that map provider names to provider tokens.
    Constraints:
    Length: 0 - 10
    
    Parameters:
    
    logins - A set of optional name-value pairs that map provider names to provider tokens.
  - withLogins
```
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.
    Constraints:
    Length: 0 - 10
    
    Parameters:
    
    logins - A set of optional name-value pairs that map provider names to provider tokens.
    
    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 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.
    Constraints:
    Length: 0 - 10
    
    Parameters:
    
    key - The key of the entry to be added into Logins.
    
    value - The corresponding value of the entry to be added into Logins.
  - 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()
```
    Returns the value of the CustomRoleArn property for this object.
    Constraints:
    Length: 20 - 2048
    
    Returns:
    
    The value of the CustomRoleArn property for this object.
  - setCustomRoleArn
```
public void setCustomRoleArn(String customRoleArn)
```
    Sets the value of the CustomRoleArn property for this object.
    Constraints:
    Length: 20 - 2048
    
    Parameters:
    
    customRoleArn - The new value for the CustomRoleArn property for this object.
  - withCustomRoleArn
```
public GetCredentialsForIdentityRequest withCustomRoleArn(String customRoleArn)
```
    Sets the value of the CustomRoleArn property for this object.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    
    Parameters:
    
    customRoleArn - The new value for the CustomRoleArn property for this object.
    
    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

Class GetCredentialsForIdentityRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GetCredentialsForIdentityRequest

Method Detail

getIdentityId

setIdentityId

withIdentityId

getLogins

setLogins

withLogins

addLoginsEntry

clearLoginsEntries

getCustomRoleArn

setCustomRoleArn

withCustomRoleArn

toString

hashCode

equals