を使用した Amazon Cognito ID の例 AWS CLI

次のコード例は、Amazon Cognito Identity AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には、完全なソースコードへのリンクが含まれています。このリンクには、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

アクション

create-identity-pool

次のコード例は、create-identity-pool を使用する方法を示しています。

AWS CLI

Cognito アイデンティティプールプロバイダーを含むアイデンティティプールを作成するには

この例では、 という名前の ID プールを作成します MyIdentityPool。これには Cognito アイデンティティプールプロバイダーが含まれます。認証されていないアイデンティティは許可されません。

コマンド:

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

出力:

{
  "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
      }
  ]
}

• API 詳細については、「 コマンドリファレンスCreateIdentityPool」の「」を参照してください。 AWS CLI

delete-identities

次のコード例は、delete-identities を使用する方法を示しています。

AWS CLI

アイデンティティプールを削除するには

この例では、ID プールを削除します。

コマンド:

aws cognito-identity delete-identity-pool --identity-ids-to-delete "us-west-2:11111111-1111-1111-1111-111111111111"

出力:

{
  "UnprocessedIdentityIds": []
}

• API 詳細については、「 コマンドリファレンスDeleteIdentities」の「」を参照してください。 AWS CLI

delete-identity-pool

次のコード例は、delete-identity-pool を使用する方法を示しています。

AWS CLI

アイデンティティプールを削除するには

次の delete-identity-pool 例では、指定したアイデンティティプールを削除します。

コマンド:

aws cognito-identity delete-identity-pool \
    --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111"

このコマンドでは何も出力されません。

• API 詳細については、「 コマンドリファレンスDeleteIdentityPool」の「」を参照してください。 AWS CLI

describe-identity-pool

次の例は、describe-identity-pool を使用する方法を説明しています。

AWS CLI

ID プールを記述するには

この例では、ID プールについて説明します。

コマンド:

aws cognito-identity describe-identity-pool --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111"

出力:

{
  "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
      }
  ]
}

• API 詳細については、「 コマンドリファレンスDescribeIdentityPool」の「」を参照してください。 AWS CLI

get-identity-pool-roles

次のコード例は、get-identity-pool-roles を使用する方法を示しています。

AWS CLI

ID プールロールを取得するには

この例では、ID プールロールを取得します。

コマンド:

aws cognito-identity get-identity-pool-roles --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111"

出力:

{
  "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"
  }
}

• API 詳細については、「 コマンドリファレンスGetIdentityPoolRoles」の「」を参照してください。 AWS CLI

list-identity-pools

次のコード例は、list-identity-pools を使用する方法を示しています。

AWS CLI

アイデンティティプールを一覧表示するには

この例ではアイデンティティプールを一覧表示します。最大 20 個のアイデンティティが一覧表示されます。

コマンド:

aws cognito-identity list-identity-pools --max-results 20

出力:

{
  "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"
      }
  ]
}

• API 詳細については、「 コマンドリファレンスListIdentityPools」の「」を参照してください。 AWS CLI

set-identity-pool-roles

次のコード例は、set-identity-pool-roles を使用する方法を示しています。

AWS CLI

ID プールロールを設定するには

次のset-identity-pool-roles例では、ID プールロールを設定します。

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"

• API 詳細については、「 コマンドリファレンスSetIdentityPoolRoles」の「」を参照してください。 AWS CLI

update-identity-pool

次の例は、update-identity-pool を使用する方法を説明しています。

AWS CLI

ID プールを更新するには

この例では、ID プールを更新します。名前を に設定します MyIdentityPool。Cognito を ID プロバイダーとして追加します。認証されていない ID は許可されません。

コマンド:

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

出力:

{
  "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
      }
  ]
}

• API 詳細については、「 コマンドリファレンスUpdateIdentityPool」の「」を参照してください。 AWS CLI