There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Code examples for Amazon Cognito Identity using AWS SDKs
The following code examples show you how to use Amazon Cognito Identity with an AWS software development kit (SDK).
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
*Scenarios* are code examples that show you how to accomplish specific tasks by calling multiple functions within a service or combined with other AWS services.
**More resources**
+ **[ Amazon Cognito Identity Developer Guide](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html)** – More information about Amazon Cognito Identity.
+ **[Amazon Cognito Identity API Reference](https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html)** – Details about all available Amazon Cognito Identity actions.
+ **[AWS Developer Center](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23cognito)** – Code examples that you can filter by category or full-text search.
+ **[AWS SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples)** – GitHub repo with complete code in preferred languages. Includes instructions for setting up and running the code.
**Contents**
+ [Basics](cognito-identity_code_examples_basics.md)
+ [Actions](cognito-identity_code_examples_actions.md)
+ [`CreateIdentityPool`](cognito-identity_example_cognito-identity_CreateIdentityPool_section.md)
+ [`DeleteIdentityPool`](cognito-identity_example_cognito-identity_DeleteIdentityPool_section.md)
+ [`DescribeIdentityPool`](cognito-identity_example_cognito-identity_DescribeIdentityPool_section.md)
+ [`GetCredentialsForIdentity`](cognito-identity_example_cognito-identity_GetCredentialsForIdentity_section.md)
+ [`GetIdentityPoolRoles`](cognito-identity_example_cognito-identity_GetIdentityPoolRoles_section.md)
+ [`ListIdentityPools`](cognito-identity_example_cognito-identity_ListIdentityPools_section.md)
+ [`SetIdentityPoolRoles`](cognito-identity_example_cognito-identity_SetIdentityPoolRoles_section.md)
+ [`UpdateIdentityPool`](cognito-identity_example_cognito-identity_UpdateIdentityPool_section.md)
+ [Scenarios](cognito-identity_code_examples_scenarios.md)
+ [Create an Amazon Textract explorer application](cognito-identity_example_cross_TextractExplorer_section.md)
# Basic examples for Amazon Cognito Identity using AWS SDKs
The following code examples show how to use the basics of Amazon Cognito Identity with AWS SDKs.
**Contents**
+ [Actions](cognito-identity_code_examples_actions.md)
+ [`CreateIdentityPool`](cognito-identity_example_cognito-identity_CreateIdentityPool_section.md)
+ [`DeleteIdentityPool`](cognito-identity_example_cognito-identity_DeleteIdentityPool_section.md)
+ [`DescribeIdentityPool`](cognito-identity_example_cognito-identity_DescribeIdentityPool_section.md)
+ [`GetCredentialsForIdentity`](cognito-identity_example_cognito-identity_GetCredentialsForIdentity_section.md)
+ [`GetIdentityPoolRoles`](cognito-identity_example_cognito-identity_GetIdentityPoolRoles_section.md)
+ [`ListIdentityPools`](cognito-identity_example_cognito-identity_ListIdentityPools_section.md)
+ [`SetIdentityPoolRoles`](cognito-identity_example_cognito-identity_SetIdentityPoolRoles_section.md)
+ [`UpdateIdentityPool`](cognito-identity_example_cognito-identity_UpdateIdentityPool_section.md)
# Actions for Amazon Cognito Identity using AWS SDKs
The following code examples demonstrate how to perform individual Amazon Cognito Identity actions with AWS SDKs. Each example includes a link to GitHub, where you can find instructions for setting up and running the code.
These excerpts call the Amazon Cognito Identity API and are code excerpts from larger programs that must be run in context. You can see actions in context in [Scenarios for Amazon Cognito Identity using AWS SDKs](cognito-identity_code_examples_scenarios.md).
The following examples include only the most commonly used actions. For a complete list, see the [Amazon Cognito Identity API Reference](https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html).
**Topics**
+ [`CreateIdentityPool`](cognito-identity_example_cognito-identity_CreateIdentityPool_section.md)
+ [`DeleteIdentityPool`](cognito-identity_example_cognito-identity_DeleteIdentityPool_section.md)
+ [`DescribeIdentityPool`](cognito-identity_example_cognito-identity_DescribeIdentityPool_section.md)
+ [`GetCredentialsForIdentity`](cognito-identity_example_cognito-identity_GetCredentialsForIdentity_section.md)
+ [`GetIdentityPoolRoles`](cognito-identity_example_cognito-identity_GetIdentityPoolRoles_section.md)
+ [`ListIdentityPools`](cognito-identity_example_cognito-identity_ListIdentityPools_section.md)
+ [`SetIdentityPoolRoles`](cognito-identity_example_cognito-identity_SetIdentityPoolRoles_section.md)
+ [`UpdateIdentityPool`](cognito-identity_example_cognito-identity_UpdateIdentityPool_section.md)
# Use `CreateIdentityPool` with an AWS SDK or CLI
The following code examples show how to use `CreateIdentityPool`.
------
#### [ CLI ]
**AWS CLI**
**To create an identity pool with Cognito identity pool provider**
This example creates an identity pool named MyIdentityPool. It has a Cognito identity pool provider. Unauthenticated identities are not allowed.
Command:
```
aws cognito-identity create-identity-pool --identity-pool-name MyIdentityPool --no-allow-unauthenticated-identities --cognito-identity-providers ProviderName="cognito-idp.us-west-2.amazonaws.com/us-west-2_aaaaaaaaa",ClientId="3n4b5urk1ft4fl3mg5e62d9ado",ServerSideTokenCheck=false
```
Output:
```
{
"IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
"IdentityPoolName": "MyIdentityPool",
"AllowUnauthenticatedIdentities": false,
"CognitoIdentityProviders": [
{
"ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111",
"ClientId": "3n4b5urk1ft4fl3mg5e62d9ado",
"ServerSideTokenCheck": false
}
]
}
```
+ For API details, see [CreateIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/create-identity-pool.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/cognito#code-examples).
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.cognitoidentity.CognitoIdentityClient;
import software.amazon.awssdk.services.cognitoidentity.model.CreateIdentityPoolRequest;
import software.amazon.awssdk.services.cognitoidentity.model.CreateIdentityPoolResponse;
import software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderException;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class CreateIdentityPool {
public static void main(String[] args) {
final String usage = """
Usage:
\s
Where:
identityPoolName - The name to give your identity pool.
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String identityPoolName = args[0];
CognitoIdentityClient cognitoClient = CognitoIdentityClient.builder()
.region(Region.US_EAST_1)
.build();
String identityPoolId = createIdPool(cognitoClient, identityPoolName);
System.out.println("Unity pool ID " + identityPoolId);
cognitoClient.close();
}
public static String createIdPool(CognitoIdentityClient cognitoClient, String identityPoolName) {
try {
CreateIdentityPoolRequest poolRequest = CreateIdentityPoolRequest.builder()
.allowUnauthenticatedIdentities(false)
.identityPoolName(identityPoolName)
.build();
CreateIdentityPoolResponse response = cognitoClient.createIdentityPool(poolRequest);
return response.identityPoolId();
} catch (CognitoIdentityProviderException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return "";
}
}
```
+ For API details, see [CreateIdentityPool](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-identity-2014-06-30/CreateIdentityPool) in *AWS SDK for Java 2.x API Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Creates a new Identity Pool which allows unauthenticated identities.**
```
New-CGIIdentityPool -AllowUnauthenticatedIdentities $true -IdentityPoolName CommonTests13
```
**Output:**
```
LoggedAt : 8/12/2015 4:56:07 PM
AllowUnauthenticatedIdentities : True
DeveloperProviderName :
IdentityPoolId : us-east-1:15d49393-ab16-431a-b26e-EXAMPLEGUID3
IdentityPoolName : CommonTests13
OpenIdConnectProviderARNs : {}
SupportedLoginProviders : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 136
HttpStatusCode : OK
```
+ For API details, see [CreateIdentityPool](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Creates a new Identity Pool which allows unauthenticated identities.**
```
New-CGIIdentityPool -AllowUnauthenticatedIdentities $true -IdentityPoolName CommonTests13
```
**Output:**
```
LoggedAt : 8/12/2015 4:56:07 PM
AllowUnauthenticatedIdentities : True
DeveloperProviderName :
IdentityPoolId : us-east-1:15d49393-ab16-431a-b26e-EXAMPLEGUID3
IdentityPoolName : CommonTests13
OpenIdConnectProviderARNs : {}
SupportedLoginProviders : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 136
HttpStatusCode : OK
```
+ For API details, see [CreateIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Swift ]
**SDK for Swift**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/swift/example_code/cognito-identity/FindOrCreateIdentityPool#code-examples).
```
import AWSCognitoIdentity
/// Create a new identity pool and return its ID.
///
/// - Parameters:
/// - name: The name to give the new identity pool.
///
/// - Returns: A string containing the newly created pool's ID, or `nil`
/// if an error occurred.
///
func createIdentityPool(name: String) async throws -> String? {
do {
let cognitoInputCall = CreateIdentityPoolInput(developerProviderName: "com.exampleco.CognitoIdentityDemo",
identityPoolName: name)
let result = try await cognitoIdentityClient.createIdentityPool(input: cognitoInputCall)
guard let poolId = result.identityPoolId else {
return nil
}
return poolId
} catch {
print("ERROR: createIdentityPool:", dump(error))
throw error
}
}
```
+ For more information, see [AWS SDK for Swift developer guide](https://docs.aws.amazon.com/sdk-for-swift/latest/developer-guide/getting-started.html).
+ For API details, see [CreateIdentityPool](https://sdk.amazonaws.com/swift/api/awscognitoidentity/latest/documentation/awscognitoidentity/cognitoidentityclient/createidentitypool(input:)) in *AWS SDK for Swift API reference*.
------
# Use `DeleteIdentityPool` with an AWS SDK or CLI
The following code examples show how to use `DeleteIdentityPool`.
------
#### [ CLI ]
**AWS CLI**
**To delete identity pool**
The following `delete-identity-pool` example deletes the specified identity pool.
Command:
```
aws cognito-identity delete-identity-pool \
--identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111"
```
This command produces no output.
+ For API details, see [DeleteIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/delete-identity-pool.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/cognito#code-examples).
```
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.cognitoidentity.CognitoIdentityClient;
import software.amazon.awssdk.services.cognitoidentity.model.DeleteIdentityPoolRequest;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DeleteIdentityPool {
public static void main(String[] args) {
final String usage = """
Usage:
\s
Where:
identityPoolId - The Id value of your identity pool.
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String identityPoold = args[0];
CognitoIdentityClient cognitoIdClient = CognitoIdentityClient.builder()
.region(Region.US_EAST_1)
.credentialsProvider(ProfileCredentialsProvider.create())
.build();
deleteIdPool(cognitoIdClient, identityPoold);
cognitoIdClient.close();
}
public static void deleteIdPool(CognitoIdentityClient cognitoIdClient, String identityPoold) {
try {
DeleteIdentityPoolRequest identityPoolRequest = DeleteIdentityPoolRequest.builder()
.identityPoolId(identityPoold)
.build();
cognitoIdClient.deleteIdentityPool(identityPoolRequest);
System.out.println("Done");
} catch (AwsServiceException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ For API details, see [DeleteIdentityPool](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-identity-2014-06-30/DeleteIdentityPool) in *AWS SDK for Java 2.x API Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Deletes a specific Identity Pool.**
```
Remove-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
```
+ For API details, see [DeleteIdentityPool](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Deletes a specific Identity Pool.**
```
Remove-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
```
+ For API details, see [DeleteIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Swift ]
**SDK for Swift**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/swift/example_code/cognito-identity/FindOrCreateIdentityPool#code-examples).
```
import AWSCognitoIdentity
/// Delete the specified identity pool.
///
/// - Parameters:
/// - id: The ID of the identity pool to delete.
///
func deleteIdentityPool(id: String) async throws {
do {
let input = DeleteIdentityPoolInput(
identityPoolId: id
)
_ = try await cognitoIdentityClient.deleteIdentityPool(input: input)
} catch {
print("ERROR: deleteIdentityPool:", dump(error))
throw error
}
}
```
+ For more information, see [AWS SDK for Swift developer guide](https://docs.aws.amazon.com/sdk-for-swift/latest/developer-guide/getting-started.html).
+ For API details, see [DeleteIdentityPool](https://sdk.amazonaws.com/swift/api/awscognitoidentity/latest/documentation/awscognitoidentity/cognitoidentityclient/deleteidentitypool(input:)) in *AWS SDK for Swift API reference*.
------
# Use `DescribeIdentityPool` with a CLI
The following code examples show how to use `DescribeIdentityPool`.
------
#### [ CLI ]
**AWS CLI**
**To describe an identity pool**
This example describes an identity pool.
Command:
```
aws cognito-identity describe-identity-pool --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111"
```
Output:
```
{
"IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
"IdentityPoolName": "MyIdentityPool",
"AllowUnauthenticatedIdentities": false,
"CognitoIdentityProviders": [
{
"ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111",
"ClientId": "3n4b5urk1ft4fl3mg5e62d9ado",
"ServerSideTokenCheck": false
}
]
}
```
+ For API details, see [DescribeIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/describe-identity-pool.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Retrieves information about a specific Identity Pool by its id.**
```
Get-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
```
**Output:**
```
LoggedAt : 8/12/2015 4:29:40 PM
AllowUnauthenticatedIdentities : True
DeveloperProviderName :
IdentityPoolId : us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
IdentityPoolName : CommonTests1
OpenIdConnectProviderARNs : {}
SupportedLoginProviders : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 142
HttpStatusCode : OK
```
+ For API details, see [DescribeIdentityPool](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Retrieves information about a specific Identity Pool by its id.**
```
Get-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
```
**Output:**
```
LoggedAt : 8/12/2015 4:29:40 PM
AllowUnauthenticatedIdentities : True
DeveloperProviderName :
IdentityPoolId : us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
IdentityPoolName : CommonTests1
OpenIdConnectProviderARNs : {}
SupportedLoginProviders : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 142
HttpStatusCode : OK
```
+ For API details, see [DescribeIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `GetCredentialsForIdentity` with an AWS SDK
The following code example shows how to use `GetCredentialsForIdentity`.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/cognito#code-examples).
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.cognitoidentity.CognitoIdentityClient;
import software.amazon.awssdk.services.cognitoidentity.model.GetCredentialsForIdentityRequest;
import software.amazon.awssdk.services.cognitoidentity.model.GetCredentialsForIdentityResponse;
import software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderException;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class GetIdentityCredentials {
public static void main(String[] args) {
final String usage = """
Usage:
\s
Where:
identityId - The Id of an existing identity in the format REGION:GUID.
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String identityId = args[0];
CognitoIdentityClient cognitoClient = CognitoIdentityClient.builder()
.region(Region.US_EAST_1)
.build();
getCredsForIdentity(cognitoClient, identityId);
cognitoClient.close();
}
public static void getCredsForIdentity(CognitoIdentityClient cognitoClient, String identityId) {
try {
GetCredentialsForIdentityRequest getCredentialsForIdentityRequest = GetCredentialsForIdentityRequest
.builder()
.identityId(identityId)
.build();
GetCredentialsForIdentityResponse response = cognitoClient
.getCredentialsForIdentity(getCredentialsForIdentityRequest);
System.out.println(
"Identity ID " + response.identityId() + ", Access key ID " + response.credentials().accessKeyId());
} catch (CognitoIdentityProviderException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ For API details, see [GetCredentialsForIdentity](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-identity-2014-06-30/GetCredentialsForIdentity) in *AWS SDK for Java 2.x API Reference*.
------
# Use `GetIdentityPoolRoles` with a CLI
The following code examples show how to use `GetIdentityPoolRoles`.
------
#### [ CLI ]
**AWS CLI**
**To get identity pool roles**
This example gets identity pool roles.
Command:
```
aws cognito-identity get-identity-pool-roles --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111"
```
Output:
```
{
"IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
"Roles": {
"authenticated": "arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolAuth_Role",
"unauthenticated": "arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolUnauth_Role"
}
}
```
+ For API details, see [GetIdentityPoolRoles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/get-identity-pool-roles.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Gets the information about roles for a specific Identity Pool.**
```
Get-CGIIdentityPoolRole -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
```
**Output:**
```
LoggedAt : 8/12/2015 4:33:51 PM
IdentityPoolId : us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
Roles : {[unauthenticated, arn:aws:iam::123456789012:role/CommonTests1Role]}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 165
HttpStatusCode : OK
```
+ For API details, see [GetIdentityPoolRoles](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Gets the information about roles for a specific Identity Pool.**
```
Get-CGIIdentityPoolRole -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
```
**Output:**
```
LoggedAt : 8/12/2015 4:33:51 PM
IdentityPoolId : us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
Roles : {[unauthenticated, arn:aws:iam::123456789012:role/CommonTests1Role]}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 165
HttpStatusCode : OK
```
+ For API details, see [GetIdentityPoolRoles](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ListIdentityPools` with an AWS SDK or CLI
The following code examples show how to use `ListIdentityPools`.
------
#### [ CLI ]
**AWS CLI**
**To list identity pools**
This example lists identity pools. There s a maximum of 20 identities listed.
Command:
```
aws cognito-identity list-identity-pools --max-results 20
```
Output:
```
{
"IdentityPools": [
{
"IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
"IdentityPoolName": "MyIdentityPool"
},
{
"IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
"IdentityPoolName": "AnotherIdentityPool"
},
{
"IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
"IdentityPoolName": "IdentityPoolRegionA"
}
]
}
```
+ For API details, see [ListIdentityPools](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/list-identity-pools.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/cognito#code-examples).
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.cognitoidentity.CognitoIdentityClient;
import software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsRequest;
import software.amazon.awssdk.services.cognitoidentity.model.ListIdentityPoolsResponse;
import software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderException;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class ListIdentityPools {
public static void main(String[] args) {
CognitoIdentityClient cognitoClient = CognitoIdentityClient.builder()
.region(Region.US_EAST_1)
.build();
listIdPools(cognitoClient);
cognitoClient.close();
}
public static void listIdPools(CognitoIdentityClient cognitoClient) {
try {
ListIdentityPoolsRequest poolsRequest = ListIdentityPoolsRequest.builder()
.maxResults(15)
.build();
ListIdentityPoolsResponse response = cognitoClient.listIdentityPools(poolsRequest);
response.identityPools().forEach(pool -> {
System.out.println("Pool ID: " + pool.identityPoolId());
System.out.println("Pool name: " + pool.identityPoolName());
});
} catch (CognitoIdentityProviderException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ For API details, see [ListIdentityPools](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-identity-2014-06-30/ListIdentityPools) in *AWS SDK for Java 2.x API Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Retrieves a list of existing Identity Pools.**
```
Get-CGIIdentityPoolList
```
**Output:**
```
IdentityPoolId IdentityPoolName
-------------- ----------------
us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 CommonTests1
us-east-1:118d242d-204e-4b88-b803-EXAMPLEGUID2 Tests2
us-east-1:15d49393-ab16-431a-b26e-EXAMPLEGUID3 CommonTests13
```
+ For API details, see [ListIdentityPools](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Retrieves a list of existing Identity Pools.**
```
Get-CGIIdentityPoolList
```
**Output:**
```
IdentityPoolId IdentityPoolName
-------------- ----------------
us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 CommonTests1
us-east-1:118d242d-204e-4b88-b803-EXAMPLEGUID2 Tests2
us-east-1:15d49393-ab16-431a-b26e-EXAMPLEGUID3 CommonTests13
```
+ For API details, see [ListIdentityPools](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Swift ]
**SDK for Swift**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/swift/example_code/cognito-identity/FindOrCreateIdentityPool#code-examples).
```
import AWSCognitoIdentity
/// Return the ID of the identity pool with the specified name.
///
/// - Parameters:
/// - name: The name of the identity pool whose ID should be returned.
///
/// - Returns: A string containing the ID of the specified identity pool
/// or `nil` on error or if not found.
///
func getIdentityPoolID(name: String) async throws -> String? {
let listPoolsInput = ListIdentityPoolsInput(maxResults: 25)
// Use "Paginated" to get all the objects.
// This lets the SDK handle the 'nextToken' field in "ListIdentityPoolsOutput".
let pages = cognitoIdentityClient.listIdentityPoolsPaginated(input: listPoolsInput)
do {
for try await page in pages {
guard let identityPools = page.identityPools else {
print("ERROR: listIdentityPoolsPaginated returned nil contents.")
continue
}
/// Read pages of identity pools from Cognito until one is found
/// whose name matches the one specified in the `name` parameter.
/// Return the matching pool's ID.
for pool in identityPools {
if pool.identityPoolName == name {
return pool.identityPoolId!
}
}
}
} catch {
print("ERROR: getIdentityPoolID:", dump(error))
throw error
}
return nil
}
```
Get the ID of an existing identity pool or create it if it doesn't already exist.
```
import AWSCognitoIdentity
/// Return the ID of the identity pool with the specified name.
///
/// - Parameters:
/// - name: The name of the identity pool whose ID should be returned
///
/// - Returns: A string containing the ID of the specified identity pool.
/// Returns `nil` if there's an error or if the pool isn't found.
///
public func getOrCreateIdentityPoolID(name: String) async throws -> String? {
// See if the pool already exists. If it doesn't, create it.
do {
guard let poolId = try await getIdentityPoolID(name: name) else {
return try await createIdentityPool(name: name)
}
return poolId
} catch {
print("ERROR: getOrCreateIdentityPoolID:", dump(error))
throw error
}
}
```
+ For more information, see [AWS SDK for Swift developer guide](https://docs.aws.amazon.com/sdk-for-swift/latest/developer-guide/getting-started.html).
+ For API details, see [ListIdentityPools](https://sdk.amazonaws.com/swift/api/awscognitoidentity/latest/documentation/awscognitoidentity/cognitoidentityclient/listidentitypools(input:)) in *AWS SDK for Swift API reference*.
------
# Use `SetIdentityPoolRoles` with a CLI
The following code examples show how to use `SetIdentityPoolRoles`.
------
#### [ CLI ]
**AWS CLI**
**To set identity pool roles**
The following `set-identity-pool-roles` example sets an identity pool role.
```
aws cognito-identity set-identity-pool-roles \
--identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" \
--roles authenticated="arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolAuth_Role"
```
+ For API details, see [SetIdentityPoolRoles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/set-identity-pool-roles.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Configures the specific Identity Pool to have an unauthenticated IAM role.**
```
Set-CGIIdentityPoolRole -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 -Role @{ "unauthenticated" = "arn:aws:iam::123456789012:role/CommonTests1Role" }
```
+ For API details, see [SetIdentityPoolRoles](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Configures the specific Identity Pool to have an unauthenticated IAM role.**
```
Set-CGIIdentityPoolRole -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 -Role @{ "unauthenticated" = "arn:aws:iam::123456789012:role/CommonTests1Role" }
```
+ For API details, see [SetIdentityPoolRoles](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `UpdateIdentityPool` with a CLI
The following code examples show how to use `UpdateIdentityPool`.
------
#### [ CLI ]
**AWS CLI**
**To update an identity pool**
This example updates an identity pool. It sets the name to MyIdentityPool. It adds Cognito as an identity provider. It disallows unauthenticated identities.
Command:
```
aws cognito-identity update-identity-pool --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" --identity-pool-name "MyIdentityPool" --no-allow-unauthenticated-identities --cognito-identity-providers ProviderName="cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111",ClientId="3n4b5urk1ft4fl3mg5e62d9ado",ServerSideTokenCheck=false
```
Output:
```
{
"IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
"IdentityPoolName": "MyIdentityPool",
"AllowUnauthenticatedIdentities": false,
"CognitoIdentityProviders": [
{
"ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111",
"ClientId": "3n4b5urk1ft4fl3mg5e62d9ado",
"ServerSideTokenCheck": false
}
]
}
```
+ For API details, see [UpdateIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/update-identity-pool.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Updates some of the Identity Pool properties, in this case the name of the Identity Pool.**
```
Update-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 -IdentityPoolName NewPoolName
```
**Output:**
```
LoggedAt : 8/12/2015 4:53:33 PM
AllowUnauthenticatedIdentities : False
DeveloperProviderName :
IdentityPoolId : us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
IdentityPoolName : NewPoolName
OpenIdConnectProviderARNs : {}
SupportedLoginProviders : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 135
HttpStatusCode : OK
```
+ For API details, see [UpdateIdentityPool](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Updates some of the Identity Pool properties, in this case the name of the Identity Pool.**
```
Update-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 -IdentityPoolName NewPoolName
```
**Output:**
```
LoggedAt : 8/12/2015 4:53:33 PM
AllowUnauthenticatedIdentities : False
DeveloperProviderName :
IdentityPoolId : us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
IdentityPoolName : NewPoolName
OpenIdConnectProviderARNs : {}
SupportedLoginProviders : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 135
HttpStatusCode : OK
```
+ For API details, see [UpdateIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Scenarios for Amazon Cognito Identity using AWS SDKs
The following code examples show you how to implement common scenarios in Amazon Cognito Identity with AWS SDKs. These scenarios show you how to accomplish specific tasks by calling multiple functions within Amazon Cognito Identity or combined with other AWS services. Each scenario includes a link to the complete source code, where you can find instructions on how to set up and run the code.
Scenarios target an intermediate level of experience to help you understand service actions in context.
**Topics**
+ [Create an Amazon Textract explorer application](cognito-identity_example_cross_TextractExplorer_section.md)
# Create an Amazon Textract explorer application
The following code examples show how to explore Amazon Textract output through an interactive application.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
Shows how to use the AWS SDK for JavaScript to build a React application that uses Amazon Textract to extract data from a document image and display it in an interactive web page. This example runs in a web browser and requires an authenticated Amazon Cognito identity for credentials. It uses Amazon Simple Storage Service (Amazon S3) for storage, and for notifications it polls an Amazon Simple Queue Service (Amazon SQS) queue that is subscribed to an Amazon Simple Notification Service (Amazon SNS) topic.
For complete source code and instructions on how to set up and run, see the full example on [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/textract-react).
**Services used in this example**
+ Amazon Cognito Identity
+ Amazon S3
+ Amazon SNS
+ Amazon SQS
+ Amazon Textract
------
#### [ Python ]
**SDK for Python (Boto3)**
Shows how to use the AWS SDK for Python (Boto3) with Amazon Textract to detect text, form, and table elements in a document image. The input image and Amazon Textract output are shown in a Tkinter application that lets you explore the detected elements.
+ Submit a document image to Amazon Textract and explore the output of detected elements.
+ Submit images directly to Amazon Textract or through an Amazon Simple Storage Service (Amazon S3) bucket.
+ Use asynchronous APIs to start a job that publishes a notification to an Amazon Simple Notification Service (Amazon SNS) topic when the job completes.
+ Poll an Amazon Simple Queue Service (Amazon SQS) queue for a job completion message and display the results.
For complete source code and instructions on how to set up and run, see the full example on [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/cross_service/textract_explorer).
**Services used in this example**
+ Amazon Cognito Identity
+ Amazon S3
+ Amazon SNS
+ Amazon SQS
+ Amazon Textract
------