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

フォーカスモード

を使用した Amazon Cognito ID の例 AWS CLI - AWS SDK コードの例

アクション

Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 AWS

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 AWS

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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

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

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

トピック

アクション

アクション

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

AWS CLI

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

この例では 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 の詳細については、「AWS CLI コマンドリファレンス」の「CreateIdentityPool」を参照してください。

create-identity-pool

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

AWS CLI

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 の詳細については、「AWS CLI コマンドリファレンス」の「CreateIdentityPool」を参照してください。

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

AWS CLI

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

この例ではアイデンティティプールを削除しています。

コマンド:


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

出力:


{
  "UnprocessedIdentityIds": []
}

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

delete-identities

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

AWS CLI

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

この例ではアイデンティティプールを削除しています。

コマンド:


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

出力:


{
  "UnprocessedIdentityIds": []
}

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

次の例は、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 の詳細については、AWS CLI コマンドリファレンスの「DeleteIdentityPool」を参照してください。

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 の詳細については、AWS CLI コマンドリファレンスの「DeleteIdentityPool」を参照してください。

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

AWS CLI

アイデンティティプールを記述するには

この例では、アイデンティティプールをを記述します。

コマンド:


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 の詳細については、「AWS CLI コマンドリファレンス」の「DescribeIdentityPool」を参照してください。

describe-identity-pool

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

AWS CLI

アイデンティティプールを記述するには

この例では、アイデンティティプールをを記述します。

コマンド:


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 の詳細については、「AWS CLI コマンドリファレンス」の「DescribeIdentityPool」を参照してください。

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

AWS CLI

アイデンティティプールのロールを取得するには

この例ではアイデンティティプールのロールを取得しています。

コマンド:


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 の詳細については、「AWS CLI コマンドリファレンス」の「GetIdentityPoolRoles」を参照してください。

get-identity-pool-roles

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

AWS CLI

アイデンティティプールのロールを取得するには

この例ではアイデンティティプールのロールを取得しています。

コマンド:


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 の詳細については、「AWS CLI コマンドリファレンス」の「GetIdentityPoolRoles」を参照してください。

次の例は、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 の詳細については、「AWS CLI コマンドリファレンス」の「ListIdentityPools」を参照してください。

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 の詳細については、「AWS CLI コマンドリファレンス」の「ListIdentityPools」を参照してください。

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

AWS CLI

アイデンティティプールのロールを設定するには

次の set-identity-pool-roles の例では、アイデンティティプールのロールを設定しています。


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 の詳細については、「AWS CLI コマンドリファレンス」の「SetIdentityPoolRoles」を参照してください。

set-identity-pool-roles

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

AWS CLI

アイデンティティプールのロールを設定するには

次の set-identity-pool-roles の例では、アイデンティティプールのロールを設定しています。


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 の詳細については、「AWS CLI コマンドリファレンス」の「SetIdentityPoolRoles」を参照してください。

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

AWS CLI

アイデンティティプールを更新するには

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

コマンド:


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 の詳細については、「AWS CLI コマンドリファレンス」の「UpdateIdentityPool」を参照してください。

update-identity-pool

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

AWS CLI

アイデンティティプールを更新するには

コマンド:


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 の詳細については、「AWS CLI コマンドリファレンス」の「UpdateIdentityPool」を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

CodeConnections

Amazon Cognito Identity Provider

次のトピック

Amazon Cognito Identity Provider

前のトピック:

CodeConnections

ヘルプが必要ですか?

このページの内容

このページは役に立ちましたか?

フィードバックを送信

プライバシーサイト規約 Cookie の設定

Cookie の設定を選択する

Cookie の設定をカスタマイズする

Essential

Performance

Functional

Advertising

Cookie の設定を保存できません

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

トピック

アクション

create-identity-pool

delete-identities

delete-identity-pool

describe-identity-pool

get-identity-pool-roles

list-identity-pools

set-identity-pool-roles

update-identity-pool

次のトピック

前のトピック:

ヘルプが必要ですか?

このページの内容

このページは役に立ちましたか?