Learn R Programming

paws.security.identity (version 0.1.0)

cognitoidentity_update_identity_pool: Updates an identity pool

Description

Updates an identity pool.

Usage

cognitoidentity_update_identity_pool(IdentityPoolId, IdentityPoolName,
  AllowUnauthenticatedIdentities, 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.

SupportedLoginProviders

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

DeveloperProviderName

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

OpenIdConnectProviderARNs

A list of OpendID Connect provider ARNs.

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.

Request syntax

svc$update_identity_pool(
  IdentityPoolId = "string",
  IdentityPoolName = "string",
  AllowUnauthenticatedIdentities = 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"
  )
)

Details

You must use AWS Developer credentials to call this API.