Describe Identity Pool

cognitoidentity_describe_identity_pool

R Documentation

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users¶

Description¶

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use AWS Developer credentials to call this API.

Usage¶

cognitoidentity_describe_identity_pool(IdentityPoolId)

Arguments¶

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

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$describe_identity_pool(
  IdentityPoolId = "string"
)