Esta documentação é somente para a versão 1 da AWS CLI. Para obter a documentação relacionada à AWS CLI versão 2, consulte o Guia do usuário da versão 2.
Exemplos do Amazon Cognito Identity usando a AWS CLI
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Amazon Cognito Identity.
Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
Tópicos
Ações
O código de exemplo a seguir mostra como usar create-identity-pool
.
- AWS CLI
-
Como criar um banco de identidades com o provedor de banco de identidades Cognito
Este exemplo cria um banco de identidades chamado MyIdentityPool. Ele tem um provedor de banco de identidades Cognito. Identidades não autenticadas não são permitidas.
Comando:
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=falseSaída:
{ "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 } ] }
-
Para ver detalhes da API, consulte CreateIdentityPool
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar delete-identities
.
- AWS CLI
-
Como excluir um banco de identidades
Este exemplo exclui um banco de identidades.
Comando:
aws cognito-identity delete-identity-pool --identity-ids-to-delete
"us-west-2:11111111-1111-1111-1111-111111111111"
Saída:
{ "UnprocessedIdentityIds": [] }
-
Para ver detalhes da API, consulte DeleteIdentities
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar delete-identity-pool
.
- AWS CLI
-
Como excluir um banco de identidades
O exemplo
delete-identity-pool
a seguir exclui o banco de identidades especificado.Comando:
aws cognito-identity delete-identity-pool \ --identity-pool-id
"us-west-2:11111111-1111-1111-1111-111111111111"
Este comando não produz saída.
-
Para obter detalhes da API, consulte DeleteIdentityPool
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar describe-identity-pool
.
- AWS CLI
-
Para descrever um banco de identidades
Este exemplo descreve um banco de identidades.
Comando:
aws cognito-identity describe-identity-pool --identity-pool-id
"us-west-2:11111111-1111-1111-1111-111111111111"
Saída:
{ "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 } ] }
-
Para ver detalhes da API, consulte DescribeIdentityPool
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar get-identity-pool-roles
.
- AWS CLI
-
Para obter funções no banco de identidades
Este exemplo lista bancos de identidades.
Comando:
aws cognito-identity get-identity-pool-roles --identity-pool-id
"us-west-2:11111111-1111-1111-1111-111111111111"
Saída:
{ "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" } }
-
Para ver detalhes da API, consulte GetIdentityPoolRoles
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-identity-pools
.
- AWS CLI
-
Para listar bancos de identidades
Este exemplo lista bancos de identidades. Há no máximo vinte identidades listadas.
Comando:
aws cognito-identity list-identity-pools --max-results
20
Saída:
{ "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" } ] }
-
Para ver detalhes da API, consulte ListIdentityPools
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar set-identity-pool-roles
.
- AWS CLI
-
Como definir funções do banco de identidades
O exemplo
set-identity-pool-roles
a seguir define funções para um banco de identidades.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"-
Para obter detalhes sobre a API, consulte SetIdentityPoolRoles
na AWS CLI Command Reference.
-
O código de exemplo a seguir mostra como usar update-identity-pool
.
- AWS CLI
-
Para atualizar um banco de identidades
Este exemplo atualiza um banco de identidades. Ele define o nome como MyIdentityPool. Ele tem um provedor de banco de identidades Cognito. Ele não permite identidades não autenticadas.
Comando:
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=falseSaída:
{ "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 } ] }
-
Para ver detalhes da API, consulte UpdateIdentityPool
na Referência de comandos da AWS CLI.
-