Class CognitoIdentityClient
Client to interact with Amazon Cognito Identity
- Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
- Guzzle\Http\Client implements Guzzle\Http\ClientInterface
- Guzzle\Service\Client implements Guzzle\Service\ClientInterface
- Aws\Common\Client\AbstractClient implements Aws\Common\Client\AwsClientInterface
- Aws\CognitoIdentity\CognitoIdentityClient
Link: User guide
Link: API docs
Located at Aws/CognitoIdentity/CognitoIdentityClient.php
Methods summary
-
public static
factory ( array $config = array() )
Executes the UpdateIdentityPool operation.
-
public
createIdentityPool ( array $args = array() )
Executes the CreateIdentityPool operation.
-
public
deleteIdentities ( array $args = array() )
Executes the DeleteIdentities operation.
-
public
deleteIdentityPool ( array $args = array() )
Executes the DeleteIdentityPool operation.
-
public
describeIdentity ( array $args = array() )
Executes the DescribeIdentity operation.
-
public
describeIdentityPool ( array $args = array() )
Executes the DescribeIdentityPool operation.
-
public
getCredentialsForIdentity ( array $args = array() )
Executes the GetCredentialsForIdentity operation.
-
public
getId ( array $args = array() )
Executes the GetId operation.
-
public
getIdentityPoolRoles ( array $args = array() )
Executes the GetIdentityPoolRoles operation.
-
public
getOpenIdToken ( array $args = array() )
Executes the GetOpenIdToken operation.
-
public
getOpenIdTokenForDeveloperIdentity ( array $args = array() )
Executes the GetOpenIdTokenForDeveloperIdentity operation.
-
public
listIdentities ( array $args = array() )
Executes the ListIdentities operation.
-
public
listIdentityPools ( array $args = array() )
Executes the ListIdentityPools operation.
-
public
lookupDeveloperIdentity ( array $args = array() )
Executes the LookupDeveloperIdentity operation.
-
public
mergeDeveloperIdentities ( array $args = array() )
Executes the MergeDeveloperIdentities operation.
-
public
setIdentityPoolRoles ( array $args = array() )
Executes the SetIdentityPoolRoles operation.
-
public
unlinkDeveloperIdentity ( array $args = array() )
Executes the UnlinkDeveloperIdentity operation.
-
public
unlinkIdentity ( array $args = array() )
Executes the UnlinkIdentity operation.
-
public
updateIdentityPool ( array $args = array() )
Executes the UpdateIdentityPool operation.
Methods detail
Executes the UpdateIdentityPool operation.
Updates a user pool.
You must use AWS Developer credentials to call this API.
Parameters
- $config
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID. -
IdentityPoolName => (string)A string that you provide.
-
AllowUnauthenticatedIdentities => (bool)TRUE if the identity pool supports unauthenticated logins. -
SupportedLoginProviders => (associative-array<string>)Associative array of <IdentityProviderName> keys mapping to (string) values. Each array key should be changed to an appropriate <IdentityProviderName>.
Optional key:value pairs mapping provider names to provider app IDs.
-
<IdentityProviderName> => (string)
-
-
DeveloperProviderName => (string)The "domain" by which Cognito will refer to your users.
-
OpenIdConnectProviderARNs => (array<string>)A list of OpendID Connect provider ARNs.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID. -
IdentityPoolName => (string)A string that you provide.
-
AllowUnauthenticatedIdentities => (bool)TRUE if the identity pool supports unauthenticated logins. -
SupportedLoginProviders => (associative-array<string>)Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.
Optional key:value pairs mapping provider names to provider app IDs.
-
<string> => (string)
-
-
DeveloperProviderName => (string)The "domain" by which Cognito will refer to your users.
-
OpenIdConnectProviderARNs => (array<string>)A list of OpendID Connect provider ARNs.
Overrides
Executes the CreateIdentityPool operation.
Creates a new identity pool. The identity pool is a store of user identity
information that is specific to your AWS account. The limit on identity pools is
60 per account. The keys for
- Facebook:
graph.facebook.com - Google:
accounts.google.com - Amazon:
www.amazon.com - Twitter:
api.twitter.com - Digits:
www.digits.com
Examples
- Basic formatting example
$result = $client->createIdentityPool(array( // IdentityPoolName is required 'IdentityPoolName' => 'string', // AllowUnauthenticatedIdentities is required 'AllowUnauthenticatedIdentities' => true || false, 'SupportedLoginProviders' => array( // Associative array of custom 'IdentityProviderName' key names 'IdentityProviderName' => 'string', // ... repeated ), 'DeveloperProviderName' => 'string', 'OpenIdConnectProviderARNs' => array('string', ... ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityPoolName => (string)A string that you provide.
-
AllowUnauthenticatedIdentities => (bool)TRUE if the identity pool supports unauthenticated logins.
-
SupportedLoginProviders => (associative-array<string>)Associative array of <IdentityProviderName> keys mapping to (string) values. Each array key should be changed to an appropriate <IdentityProviderName>.
Optional key:value pairs mapping provider names to provider app IDs.
-
<IdentityProviderName> => (string)
-
-
DeveloperProviderName => (string)The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).
Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
-
OpenIdConnectProviderARNs => (array<string>)A list of OpendID Connect provider ARNs.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID. -
IdentityPoolName => (string)A string that you provide.
-
AllowUnauthenticatedIdentities => (bool)TRUE if the identity pool supports unauthenticated logins. -
SupportedLoginProviders => (associative-array<string>)Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.
Optional key:value pairs mapping provider names to provider app IDs.
-
<string> => (string)
-
-
DeveloperProviderName => (string)The "domain" by which Cognito will refer to your users.
-
OpenIdConnectProviderARNs => (array<string>)A list of OpendID Connect provider ARNs.
Executes the DeleteIdentities operation.
Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.
You must use AWS Developer credentials to call this API.
Examples
- Basic formatting example
$result = $client->deleteIdentities(array( // IdentityIdsToDelete is required 'IdentityIdsToDelete' => array('string', ... ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityIdsToDelete => (array<string>)A list of 1-60 identities that you want to delete.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
UnprocessedIdentityIds => (array<associative-array>)An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.
- (associative-array)
An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.
-
IdentityId => (string)A unique identifier in the format REGION:GUID.
-
ErrorCode => (string)The error code indicating the type of error that occurred.
-
- (associative-array)
Executes the DeleteIdentityPool operation.
Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
You must use AWS Developer credentials to call this API.
Examples
- Basic formatting example
$result = $client->deleteIdentityPool(array( // IdentityPoolId is required 'IdentityPoolId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID.
-
Returns
Executes the DescribeIdentity operation.
Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
You must use AWS Developer credentials to call this API.
Examples
- Basic formatting example
$result = $client->describeIdentity(array( // IdentityId is required 'IdentityId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityId => (string)A unique identifier in the format REGION:GUID.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
IdentityId => (string)A unique identifier in the format REGION:GUID. -
Logins => (array<string>)A set of optional name-value pairs that map provider names to provider tokens. -
CreationDate => (string)Date on which the identity was created.
-
LastModifiedDate => (string)Date on which the identity was last modified.
Executes the DescribeIdentityPool operation.
Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
You must use AWS Developer credentials to call this API.
Examples
- Basic formatting example
$result = $client->describeIdentityPool(array( // IdentityPoolId is required 'IdentityPoolId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID. -
IdentityPoolName => (string)A string that you provide.
-
AllowUnauthenticatedIdentities => (bool)TRUE if the identity pool supports unauthenticated logins. -
SupportedLoginProviders => (associative-array<string>)Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.
Optional key:value pairs mapping provider names to provider app IDs.
-
<string> => (string)
-
-
DeveloperProviderName => (string)The "domain" by which Cognito will refer to your users.
-
OpenIdConnectProviderARNs => (array<string>)A list of OpendID Connect provider ARNs.
Executes 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.
Examples
- Basic formatting example
$result = $client->getCredentialsForIdentity(array( // IdentityId is required 'IdentityId' => 'string', 'Logins' => array( // Associative array of custom 'IdentityProviderName' key names 'IdentityProviderName' => 'string', // ... repeated ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityId => (string)A unique identifier in the format REGION:GUID.
-
Logins => (associative-array<string>)Associative array of <IdentityProviderName> keys mapping to (string) values. Each array key should be changed to an appropriate <IdentityProviderName>.
A set of optional name-value pairs that map provider names to provider tokens.
-
<IdentityProviderName> => (string)
-
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
IdentityId => (string)A unique identifier in the format REGION:GUID.
-
Credentials => (associative-array)Credentials for the provided identity ID.
-
AccessKeyId => (string)The Access Key portion of the credentials.
-
SecretKey => (string)The Secret Access Key portion of the credentials
-
SessionToken => (string)The Session Token portion of the credentials
-
Expiration => (string)The date at which these credentials will expire.
-
Executes the GetId operation.
Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
This is a public API. You do not need any credentials to call this API.
Examples
- Basic formatting example
$result = $client->getId(array( 'AccountId' => 'string', // IdentityPoolId is required 'IdentityPoolId' => 'string', 'Logins' => array( // Associative array of custom 'IdentityProviderName' key names 'IdentityProviderName' => 'string', // ... repeated ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
AccountId => (string)A standard AWS account ID (9+ digits). -
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID. -
Logins => (associative-array<string>)Associative array of <IdentityProviderName> keys mapping to (string) values. Each array key should be changed to an appropriate <IdentityProviderName>.
A set of optional name-value pairs that map provider names to provider tokens.
The available provider names for Logins are as follows:
- Facebook: graph.facebook.com
- Google: accounts.google.com
- Amazon: www.amazon.com
- Twitter: api.twitter.com
- Digits: www.digits.com
-
<IdentityProviderName> => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
IdentityId => (string)A unique identifier in the format REGION:GUID.
Executes the GetIdentityPoolRoles operation.
Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
Examples
- Basic formatting example
$result = $client->getIdentityPoolRoles(array( // IdentityPoolId is required 'IdentityPoolId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID.
-
Roles => (associative-array<string>)Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.
The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
-
<string> => (string)
-
Executes the GetOpenIdToken operation.
Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.
The OpenId token is valid for 15 minutes.
This is a public API. You do not need any credentials to call this API.
Examples
- Basic formatting example
$result = $client->getOpenIdToken(array( // IdentityId is required 'IdentityId' => 'string', 'Logins' => array( // Associative array of custom 'IdentityProviderName' key names 'IdentityProviderName' => 'string', // ... repeated ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityId => (string)A unique identifier in the format REGION:GUID. -
Logins => (associative-array<string>)Associative array of <IdentityProviderName> keys mapping to (string) values. Each array key should be changed to an appropriate <IdentityProviderName>.
A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com or any other OpenId Connect provider, always include the id_token.-
<IdentityProviderName> => (string)
-
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
IdentityId => (string)A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input. -
Token => (string)An OpenID token, valid for 15 minutes.
Executes the GetOpenIdTokenForDeveloperIdentity operation.
Registers (or retrieves) a Cognito
You can use
You must use AWS Developer credentials to call this API.
Examples
- Basic formatting example
$result = $client->getOpenIdTokenForDeveloperIdentity(array( // IdentityPoolId is required 'IdentityPoolId' => 'string', 'IdentityId' => 'string', // Logins is required 'Logins' => array( // Associative array of custom 'IdentityProviderName' key names 'IdentityProviderName' => 'string', // ... repeated ), 'TokenDuration' => integer, ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID.
-
IdentityId => (string)A unique identifier in the format REGION:GUID.
-
Logins => (associative-array<string>)Associative array of <IdentityProviderName> keys mapping to (string) values. Each array key should be changed to an appropriate <IdentityProviderName>.
A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier". The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.
-
<IdentityProviderName> => (string)
-
-
TokenDuration => (int)The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
IdentityId => (string)A unique identifier in the format REGION:GUID.
-
Token => (string)An OpenID token.
Executes the ListIdentities operation.
Lists the identities in a pool.
You must use AWS Developer credentials to call this API.
Examples
- Basic formatting example
$result = $client->listIdentities(array( // IdentityPoolId is required 'IdentityPoolId' => 'string', // MaxResults is required 'MaxResults' => integer, 'NextToken' => 'string', 'HideDisabled' => true || false, ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID. -
MaxResults => (int)The maximum number of identities to return. -
NextToken => (string)A pagination token. -
HideDisabled => (bool)An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID. -
Identities => (array<associative-array>)An object containing a set of identities and associated mappings.- (associative-array)
A description of the identity.
-
IdentityId => (string)A unique identifier in the format REGION:GUID. -
Logins => (array<string>)A set of optional name-value pairs that map provider names to provider tokens. -
CreationDate => (string)Date on which the identity was created.
-
LastModifiedDate => (string)Date on which the identity was last modified.
-
- (associative-array)
-
NextToken => (string)A pagination token.
Executes the ListIdentityPools operation.
Lists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
Examples
- Basic formatting example
$result = $client->listIdentityPools(array( // MaxResults is required 'MaxResults' => integer, 'NextToken' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
MaxResults => (int)The maximum number of identities to return. -
NextToken => (string)A pagination token.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
IdentityPools => (array<associative-array>)The identity pools returned by the ListIdentityPools action.- (associative-array)
A description of the identity pool.
-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID. -
IdentityPoolName => (string)A string that you provide.
-
- (associative-array)
-
NextToken => (string)A pagination token.
Executes the LookupDeveloperIdentity operation.
Retrieves the
You must use AWS Developer credentials to call this API.
Examples
- Basic formatting example
$result = $client->lookupDeveloperIdentity(array( // IdentityPoolId is required 'IdentityPoolId' => 'string', 'IdentityId' => 'string', 'DeveloperUserIdentifier' => 'string', 'MaxResults' => integer, 'NextToken' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID.
-
IdentityId => (string)A unique identifier in the format REGION:GUID.
-
DeveloperUserIdentifier => (string)A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.
-
MaxResults => (int)The maximum number of identities to return.
-
NextToken => (string)A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
IdentityId => (string)A unique identifier in the format REGION:GUID.
-
DeveloperUserIdentifierList => (array<string>)This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.
-
NextToken => (string)A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.
Executes the MergeDeveloperIdentities operation.
Merges two users having different
You must use AWS Developer credentials to call this API.
Examples
- Basic formatting example
$result = $client->mergeDeveloperIdentities(array( // SourceUserIdentifier is required 'SourceUserIdentifier' => 'string', // DestinationUserIdentifier is required 'DestinationUserIdentifier' => 'string', // DeveloperProviderName is required 'DeveloperProviderName' => 'string', // IdentityPoolId is required 'IdentityPoolId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
SourceUserIdentifier => (string)User identifier for the source user. The value should be a DeveloperUserIdentifier.
-
DestinationUserIdentifier => (string)User identifier for the destination user. The value should be a DeveloperUserIdentifier.
-
DeveloperProviderName => (string)The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).
-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
IdentityId => (string)A unique identifier in the format REGION:GUID.
Executes the SetIdentityPoolRoles operation.
Sets the roles for an identity pool. These roles are used when making calls
to
You must use AWS Developer credentials to call this API.
Examples
- Basic formatting example
$result = $client->setIdentityPoolRoles(array( // IdentityPoolId is required 'IdentityPoolId' => 'string', // Roles is required 'Roles' => array( // Associative array of custom 'RoleType' key names 'RoleType' => 'string', // ... repeated ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID.
-
Roles => (associative-array<string>)Associative array of <RoleType> keys mapping to (string) values. Each array key should be changed to an appropriate <RoleType>.
The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.
-
<RoleType> => (string)
-
-
Returns
Executes the UnlinkDeveloperIdentity operation.
Unlinks a
You must use AWS Developer credentials to call this API.
Examples
- Basic formatting example
$result = $client->unlinkDeveloperIdentity(array( // IdentityId is required 'IdentityId' => 'string', // IdentityPoolId is required 'IdentityPoolId' => 'string', // DeveloperProviderName is required 'DeveloperProviderName' => 'string', // DeveloperUserIdentifier is required 'DeveloperUserIdentifier' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityId => (string)A unique identifier in the format REGION:GUID.
-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID.
-
DeveloperProviderName => (string)The "domain" by which Cognito will refer to your users.
-
DeveloperUserIdentifier => (string)A unique ID used by your backend authentication process to identify a user.
-
Returns
Executes the UnlinkIdentity operation.
Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.
This is a public API. You do not need any credentials to call this API.
Examples
- Basic formatting example
$result = $client->unlinkIdentity(array( // IdentityId is required 'IdentityId' => 'string', // Logins is required 'Logins' => array( // Associative array of custom 'IdentityProviderName' key names 'IdentityProviderName' => 'string', // ... repeated ), // LoginsToRemove is required 'LoginsToRemove' => array('string', ... ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityId => (string)A unique identifier in the format REGION:GUID. -
Logins => (associative-array<string>)Associative array of <IdentityProviderName> keys mapping to (string) values. Each array key should be changed to an appropriate <IdentityProviderName>.
A set of optional name-value pairs that map provider names to provider tokens.-
<IdentityProviderName> => (string)
-
-
LoginsToRemove => (array<string>)Provider names to unlink from this identity.
-
Returns
Executes the UpdateIdentityPool operation.
Updates a user pool.
You must use AWS Developer credentials to call this API.
Examples
- Basic formatting example
$result = $client->updateIdentityPool(array( // IdentityPoolId is required 'IdentityPoolId' => 'string', // IdentityPoolName is required 'IdentityPoolName' => 'string', // AllowUnauthenticatedIdentities is required 'AllowUnauthenticatedIdentities' => true || false, 'SupportedLoginProviders' => array( // Associative array of custom 'IdentityProviderName' key names 'IdentityProviderName' => 'string', // ... repeated ), 'DeveloperProviderName' => 'string', 'OpenIdConnectProviderARNs' => array('string', ... ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID. -
IdentityPoolName => (string)A string that you provide.
-
AllowUnauthenticatedIdentities => (bool)TRUE if the identity pool supports unauthenticated logins. -
SupportedLoginProviders => (associative-array<string>)Associative array of <IdentityProviderName> keys mapping to (string) values. Each array key should be changed to an appropriate <IdentityProviderName>.
Optional key:value pairs mapping provider names to provider app IDs.
-
<IdentityProviderName> => (string)
-
-
DeveloperProviderName => (string)The "domain" by which Cognito will refer to your users.
-
OpenIdConnectProviderARNs => (array<string>)A list of OpendID Connect provider ARNs.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
IdentityPoolId => (string)An identity pool ID in the format REGION:GUID. -
IdentityPoolName => (string)A string that you provide.
-
AllowUnauthenticatedIdentities => (bool)TRUE if the identity pool supports unauthenticated logins. -
SupportedLoginProviders => (associative-array<string>)Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.
Optional key:value pairs mapping provider names to provider app IDs.
-
<string> => (string)
-
-
DeveloperProviderName => (string)The "domain" by which Cognito will refer to your users.
-
OpenIdConnectProviderARNs => (array<string>)A list of OpendID Connect provider ARNs.
Methods inherited from Aws\Common\Client\AbstractClient
__call()
,
__construct()
,
createRequest()
,
getAllEvents()
,
getApiVersion()
,
getCredentials()
,
getRegion()
,
getRegions()
,
getSignature()
,
getWaiter()
,
getWaiterFactory()
,
send()
,
setCredentials()
,
setRegion()
,
setWaiterFactory()
,
waitUntil()
Methods inherited from Guzzle\Service\Client
execute()
,
executeMultiple()
,
getCommand()
,
getCommandFactory()
,
getDescription()
,
getInflector()
,
getIterator()
,
getResourceIteratorFactory()
,
prepareCommand()
,
setCommandFactory()
,
setDescription()
,
setInflector()
,
setResourceIteratorFactory()
Methods inherited from Guzzle\Http\Client
delete()
,
expandTemplate()
,
extractPharCacert()
,
get()
,
getBaseUrl()
,
getConfig()
,
getCurlMulti()
,
getDefaultOption()
,
getDefaultUserAgent()
,
getUriTemplate()
,
head()
,
initSsl()
,
options()
,
patch()
,
post()
,
prepareRequest()
,
put()
,
sendMultiple()
,
setBaseUrl()
,
setConfig()
,
setCurlMulti()
,
setDefaultOption()
,
setRequestFactory()
,
setSslVerification()
,
setUriTemplate()
,
setUserAgent()
Methods inherited from Guzzle\Common\AbstractHasDispatcher
addSubscriber()
,
dispatch()
,
getEventDispatcher()
,
setEventDispatcher()
Magic methods summary
Constants summary
string |
LATEST_API_VERSION |
'2014-06-30' |
Constants inherited from Guzzle\Service\Client
Constants inherited from Guzzle\Http\Client
CURL_OPTIONS
,
DEFAULT_SELECT_TIMEOUT
,
DISABLE_REDIRECTS
,
MAX_HANDLES
,
REQUEST_OPTIONS
,
SSL_CERT_AUTHORITY
Constants inherited from Guzzle\Http\ClientInterface
Properties summary
Properties inherited from Aws\Common\Client\AbstractClient
$aggregator
,
$credentials
,
$signature
,
$waiterFactory
Properties inherited from Guzzle\Service\Client
$commandFactory
,
$inflector
,
$resourceIteratorFactory
,
$serviceDescription
Properties inherited from Guzzle\Http\Client
$defaultHeaders
,
$requestFactory
,
$userAgent