UpdateIdentityPoolRequest (AWS SDK for Android

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class UpdateIdentityPoolRequest
extends AmazonWebServiceRequest
implements Serializable
```
Updates an identity pool.

You must use AWS Developer credentials to call this API.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UpdateIdentityPoolRequest()

Constructors
Constructor and Description
`UpdateIdentityPoolRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateIdentityPoolRequest`	`addIdentityPoolTagsEntry(String key, String value)` The tags that are assigned to the identity pool.
`UpdateIdentityPoolRequest`	`addSupportedLoginProvidersEntry(String key, String value)` Optional key:value pairs mapping provider names to provider app IDs.
`UpdateIdentityPoolRequest`	`clearIdentityPoolTagsEntries()` Removes all the entries added into IdentityPoolTags.
`UpdateIdentityPoolRequest`	`clearSupportedLoginProvidersEntries()` Removes all the entries added into SupportedLoginProviders.
`boolean`	`equals(Object obj)`
`Boolean`	`getAllowUnauthenticatedIdentities()` TRUE if the identity pool supports unauthenticated logins.
`List<CognitoIdentityProvider>`	`getCognitoIdentityProviders()` A list representing an Amazon Cognito user pool and its client ID.
`String`	`getDeveloperProviderName()` The "domain" by which Cognito will refer to your users.
`String`	`getIdentityPoolId()` An identity pool ID in the format REGION:GUID.
`String`	`getIdentityPoolName()` A string that you provide.
`Map<String,String>`	`getIdentityPoolTags()` The tags that are assigned to the identity pool.
`List<String>`	`getOpenIdConnectProviderARNs()` A list of OpendID Connect provider ARNs.
`List<String>`	`getSamlProviderARNs()` An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
`Map<String,String>`	`getSupportedLoginProviders()` Optional key:value pairs mapping provider names to provider app IDs.
`int`	`hashCode()`
`Boolean`	`isAllowUnauthenticatedIdentities()` TRUE if the identity pool supports unauthenticated logins.
`void`	`setAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)` TRUE if the identity pool supports unauthenticated logins.
`void`	`setCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders)` A list representing an Amazon Cognito user pool and its client ID.
`void`	`setDeveloperProviderName(String developerProviderName)` The "domain" by which Cognito will refer to your users.
`void`	`setIdentityPoolId(String identityPoolId)` An identity pool ID in the format REGION:GUID.
`void`	`setIdentityPoolName(String identityPoolName)` A string that you provide.
`void`	`setIdentityPoolTags(Map<String,String> identityPoolTags)` The tags that are assigned to the identity pool.
`void`	`setOpenIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs)` A list of OpendID Connect provider ARNs.
`void`	`setSamlProviderARNs(Collection<String> samlProviderARNs)` An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
`void`	`setSupportedLoginProviders(Map<String,String> supportedLoginProviders)` Optional key:value pairs mapping provider names to provider app IDs.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UpdateIdentityPoolRequest`	`withAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)` TRUE if the identity pool supports unauthenticated logins.
`UpdateIdentityPoolRequest`	`withCognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders)` A list representing an Amazon Cognito user pool and its client ID.
`UpdateIdentityPoolRequest`	`withCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders)` A list representing an Amazon Cognito user pool and its client ID.
`UpdateIdentityPoolRequest`	`withDeveloperProviderName(String developerProviderName)` The "domain" by which Cognito will refer to your users.
`UpdateIdentityPoolRequest`	`withIdentityPoolId(String identityPoolId)` An identity pool ID in the format REGION:GUID.
`UpdateIdentityPoolRequest`	`withIdentityPoolName(String identityPoolName)` A string that you provide.
`UpdateIdentityPoolRequest`	`withIdentityPoolTags(Map<String,String> identityPoolTags)` The tags that are assigned to the identity pool.
`UpdateIdentityPoolRequest`	`withOpenIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs)` A list of OpendID Connect provider ARNs.
`UpdateIdentityPoolRequest`	`withOpenIdConnectProviderARNs(String... openIdConnectProviderARNs)` A list of OpendID Connect provider ARNs.
`UpdateIdentityPoolRequest`	`withSamlProviderARNs(Collection<String> samlProviderARNs)` An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
`UpdateIdentityPoolRequest`	`withSamlProviderARNs(String... samlProviderARNs)` An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
`UpdateIdentityPoolRequest`	`withSupportedLoginProviders(Map<String,String> supportedLoginProviders)` Optional key:value pairs mapping provider names to provider app IDs.

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
  - UpdateIdentityPoolRequest
```
public UpdateIdentityPoolRequest()
```
- Method Detail
  - getIdentityPoolId
```
public String getIdentityPoolId()
```
    An identity pool ID in the format REGION:GUID.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+:[0-9a-f-]+
    
    Returns:
    
    An identity pool ID in the format REGION:GUID.
  - setIdentityPoolId
```
public void setIdentityPoolId(String identityPoolId)
```
    An identity pool ID in the format REGION:GUID.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+:[0-9a-f-]+
    
    Parameters:
    
    identityPoolId -
    An identity pool ID in the format REGION:GUID.
  - withIdentityPoolId
```
public UpdateIdentityPoolRequest withIdentityPoolId(String identityPoolId)
```
    An identity pool ID 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:
    
    identityPoolId -
    An identity pool ID in the format REGION:GUID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getIdentityPoolName
```
public String getIdentityPoolName()
```
    A string that you provide.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w ]+
    
    Returns:
    
    A string that you provide.
  - setIdentityPoolName
```
public void setIdentityPoolName(String identityPoolName)
```
    A string that you provide.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w ]+
    
    Parameters:
    
    identityPoolName -
    A string that you provide.
  - withIdentityPoolName
```
public UpdateIdentityPoolRequest withIdentityPoolName(String identityPoolName)
```
    A string that you provide.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w ]+
    
    Parameters:
    
    identityPoolName -
    A string that you provide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isAllowUnauthenticatedIdentities
```
public Boolean isAllowUnauthenticatedIdentities()
```
    TRUE if the identity pool supports unauthenticated logins.
    
    Returns:
    
    TRUE if the identity pool supports unauthenticated logins.
  - getAllowUnauthenticatedIdentities
```
public Boolean getAllowUnauthenticatedIdentities()
```
    TRUE if the identity pool supports unauthenticated logins.
    
    Returns:
    
    TRUE if the identity pool supports unauthenticated logins.
  - setAllowUnauthenticatedIdentities
```
public void setAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)
```
    TRUE if the identity pool supports unauthenticated logins.
    
    Parameters:
    
    allowUnauthenticatedIdentities -
    TRUE if the identity pool supports unauthenticated logins.
  - withAllowUnauthenticatedIdentities
```
public UpdateIdentityPoolRequest withAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)
```
    TRUE if the identity pool supports unauthenticated logins.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    allowUnauthenticatedIdentities -
    TRUE if the identity pool supports unauthenticated logins.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSupportedLoginProviders
```
public Map<String,String> getSupportedLoginProviders()
```
    Optional key:value pairs mapping provider names to provider app IDs.
    
    Returns:
    
    Optional key:value pairs mapping provider names to provider app IDs.
  - setSupportedLoginProviders
```
public void setSupportedLoginProviders(Map<String,String> supportedLoginProviders)
```
    Optional key:value pairs mapping provider names to provider app IDs.
    
    Parameters:
    
    supportedLoginProviders -
    Optional key:value pairs mapping provider names to provider app IDs.
  - withSupportedLoginProviders
```
public UpdateIdentityPoolRequest withSupportedLoginProviders(Map<String,String> supportedLoginProviders)
```
    Optional key:value pairs mapping provider names to provider app IDs.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    supportedLoginProviders -
    Optional key:value pairs mapping provider names to provider app IDs.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addSupportedLoginProvidersEntry
```
public UpdateIdentityPoolRequest addSupportedLoginProvidersEntry(String key,
                                                                 String value)
```
    Optional key:value pairs mapping provider names to provider app IDs.
    
    The method adds a new key-value pair into SupportedLoginProviders 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 SupportedLoginProviders.
    
    value - The corresponding value of the entry to be added into SupportedLoginProviders.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearSupportedLoginProvidersEntries
```
public UpdateIdentityPoolRequest clearSupportedLoginProvidersEntries()
```
    Removes all the entries added into SupportedLoginProviders.
    Returns a reference to this object so that method calls can be chained together.
  - getDeveloperProviderName
```
public String getDeveloperProviderName()
```
    The "domain" by which Cognito will refer to your users.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w._-]+
    
    Returns:
    
    The "domain" by which Cognito will refer to your users.
  - setDeveloperProviderName
```
public void setDeveloperProviderName(String developerProviderName)
```
    The "domain" by which Cognito will refer to your users.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w._-]+
    
    Parameters:
    
    developerProviderName -
    The "domain" by which Cognito will refer to your users.
  - withDeveloperProviderName
```
public UpdateIdentityPoolRequest withDeveloperProviderName(String developerProviderName)
```
    The "domain" by which Cognito will refer to your users.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w._-]+
    
    Parameters:
    
    developerProviderName -
    The "domain" by which Cognito will refer to your users.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getOpenIdConnectProviderARNs
```
public List<String> getOpenIdConnectProviderARNs()
```
    A list of OpendID Connect provider ARNs.
    
    Returns:
    
    A list of OpendID Connect provider ARNs.
  - setOpenIdConnectProviderARNs
```
public void setOpenIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs)
```
    A list of OpendID Connect provider ARNs.
    
    Parameters:
    
    openIdConnectProviderARNs -
    A list of OpendID Connect provider ARNs.
  - withOpenIdConnectProviderARNs
```
public UpdateIdentityPoolRequest withOpenIdConnectProviderARNs(String... openIdConnectProviderARNs)
```
    A list of OpendID Connect provider ARNs.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    openIdConnectProviderARNs -
    A list of OpendID Connect provider ARNs.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withOpenIdConnectProviderARNs
```
public UpdateIdentityPoolRequest withOpenIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs)
```
    A list of OpendID Connect provider ARNs.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    openIdConnectProviderARNs -
    A list of OpendID Connect provider ARNs.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCognitoIdentityProviders
```
public List<CognitoIdentityProvider> getCognitoIdentityProviders()
```
    A list representing an Amazon Cognito user pool and its client ID.
    
    Returns:
    
    A list representing an Amazon Cognito user pool and its client ID.
  - setCognitoIdentityProviders
```
public void setCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders)
```
    A list representing an Amazon Cognito user pool and its client ID.
    
    Parameters:
    
    cognitoIdentityProviders -
    A list representing an Amazon Cognito user pool and its client ID.
  - withCognitoIdentityProviders
```
public UpdateIdentityPoolRequest withCognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders)
```
    A list representing an Amazon Cognito user pool and its client ID.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    cognitoIdentityProviders -
    A list representing an Amazon Cognito user pool and its client ID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withCognitoIdentityProviders
```
public UpdateIdentityPoolRequest withCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders)
```
    A list representing an Amazon Cognito user pool and its client ID.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    cognitoIdentityProviders -
    A list representing an Amazon Cognito user pool and its client ID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSamlProviderARNs
```
public List<String> getSamlProviderARNs()
```
    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
    
    Returns:
    
    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
  - setSamlProviderARNs
```
public void setSamlProviderARNs(Collection<String> samlProviderARNs)
```
    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
    
    Parameters:
    
    samlProviderARNs -
    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
  - withSamlProviderARNs
```
public UpdateIdentityPoolRequest withSamlProviderARNs(String... samlProviderARNs)
```
    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    samlProviderARNs -
    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withSamlProviderARNs
```
public UpdateIdentityPoolRequest withSamlProviderARNs(Collection<String> samlProviderARNs)
```
    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    samlProviderARNs -
    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getIdentityPoolTags
```
public Map<String,String> getIdentityPoolTags()
```
    The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
    
    Returns:
    
    The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
  - setIdentityPoolTags
```
public void setIdentityPoolTags(Map<String,String> identityPoolTags)
```
    The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
    
    Parameters:
    
    identityPoolTags -
    The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
  - withIdentityPoolTags
```
public UpdateIdentityPoolRequest withIdentityPoolTags(Map<String,String> identityPoolTags)
```
    The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    identityPoolTags -
    The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addIdentityPoolTagsEntry
```
public UpdateIdentityPoolRequest addIdentityPoolTagsEntry(String key,
                                                          String value)
```
    The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
    
    The method adds a new key-value pair into IdentityPoolTags 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 IdentityPoolTags.
    
    value - The corresponding value of the entry to be added into IdentityPoolTags.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearIdentityPoolTagsEntries
```
public UpdateIdentityPoolRequest clearIdentityPoolTagsEntries()
```
    Removes all the entries added into IdentityPoolTags.
    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; 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 UpdateIdentityPoolRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateIdentityPoolRequest

Method Detail

getIdentityPoolId

setIdentityPoolId

withIdentityPoolId

getIdentityPoolName

setIdentityPoolName

withIdentityPoolName

isAllowUnauthenticatedIdentities

getAllowUnauthenticatedIdentities

setAllowUnauthenticatedIdentities

withAllowUnauthenticatedIdentities

getSupportedLoginProviders

setSupportedLoginProviders

withSupportedLoginProviders

addSupportedLoginProvidersEntry

clearSupportedLoginProvidersEntries

getDeveloperProviderName

setDeveloperProviderName

withDeveloperProviderName

getOpenIdConnectProviderARNs

setOpenIdConnectProviderARNs

withOpenIdConnectProviderARNs

withOpenIdConnectProviderARNs

getCognitoIdentityProviders

setCognitoIdentityProviders

withCognitoIdentityProviders

withCognitoIdentityProviders

getSamlProviderARNs

setSamlProviderARNs

withSamlProviderARNs

withSamlProviderARNs

getIdentityPoolTags

setIdentityPoolTags

withIdentityPoolTags

addIdentityPoolTagsEntry

clearIdentityPoolTagsEntries

toString

hashCode

equals