Skip to content

Lists the identities in an identity pool

Description

Lists the identities in an identity pool.

You must use Amazon Web Services developer credentials to call this operation.

Usage

cognitoidentity_list_identities(IdentityPoolId, MaxResults, NextToken,
  HideDisabled)

Arguments

  • IdentityPoolId

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

  • MaxResults

    [required] The maximum number of identities to return.

  • NextToken

    A pagination token.

  • HideDisabled

    An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

Value

A list with the following syntax:

list(
  IdentityPoolId = "string",
  Identities = list(
    list(
      IdentityId = "string",
      Logins = list(
        "string"
      ),
      CreationDate = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_identities(
  IdentityPoolId = "string",
  MaxResults = 123,
  NextToken = "string",
  HideDisabled = TRUE|FALSE
)