Skip to content

Update Identity Pool

cognitoidentity_update_identity_pool R Documentation

Updates an identity pool

Description

Updates an identity pool.

You must use AWS Developer credentials to call this API.

Usage

cognitoidentity_update_identity_pool(IdentityPoolId, IdentityPoolName,
  AllowUnauthenticatedIdentities, AllowClassicFlow,
  SupportedLoginProviders, DeveloperProviderName,
  OpenIdConnectProviderARNs, CognitoIdentityProviders, SamlProviderARNs,
  IdentityPoolTags)

Arguments

IdentityPoolId

[required] An identity pool ID in the format REGION:GUID.

IdentityPoolName

[required] A string that you provide.

AllowUnauthenticatedIdentities

[required] TRUE if the identity pool supports unauthenticated logins.

AllowClassicFlow

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

SupportedLoginProviders

Optional key:value pairs mapping provider names to provider app IDs.

DeveloperProviderName

The "domain" by which Cognito will refer to your users.

OpenIdConnectProviderARNs

The ARNs of the OpenID Connect providers.

CognitoIdentityProviders

A list representing an Amazon Cognito user pool and its client ID.

SamlProviderARNs

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

IdentityPoolTags

The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

Value

A list with the following syntax: 

list(
  IdentityPoolId = "string",
  IdentityPoolName = "string",
  AllowUnauthenticatedIdentities = TRUE|FALSE,
  AllowClassicFlow = TRUE|FALSE,
  SupportedLoginProviders = list(
    "string"
  ),
  DeveloperProviderName = "string",
  OpenIdConnectProviderARNs = list(
    "string"
  ),
  CognitoIdentityProviders = list(
    list(
      ProviderName = "string",
      ClientId = "string",
      ServerSideTokenCheck = TRUE|FALSE
    )
  ),
  SamlProviderARNs = list(
    "string"
  ),
  IdentityPoolTags = list(
    "string"
  )
)

Request syntax

svc$update_identity_pool(
  IdentityPoolId = "string",
  IdentityPoolName = "string",
  AllowUnauthenticatedIdentities = TRUE|FALSE,
  AllowClassicFlow = TRUE|FALSE,
  SupportedLoginProviders = list(
    "string"
  ),
  DeveloperProviderName = "string",
  OpenIdConnectProviderARNs = list(
    "string"
  ),
  CognitoIdentityProviders = list(
    list(
      ProviderName = "string",
      ClientId = "string",
      ServerSideTokenCheck = TRUE|FALSE
    )
  ),
  SamlProviderARNs = list(
    "string"
  ),
  IdentityPoolTags = list(
    "string"
  )
)