Get Identity Pool Configuration

cognitosync_get_identity_pool_configuration

R Documentation

Gets the configuration settings of an identity pool¶

Description¶

Gets the configuration settings of an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Usage¶

cognitosync_get_identity_pool_configuration(IdentityPoolId)

Arguments¶

IdentityPoolId: [required] A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration.

Value¶

A list with the following syntax:

list(
  IdentityPoolId = "string",
  PushSync = list(
    ApplicationArns = list(
      "string"
    ),
    RoleArn = "string"
  ),
  CognitoStreams = list(
    StreamName = "string",
    RoleArn = "string",
    StreamingStatus = "ENABLED"|"DISABLED"
  )
)

Request syntax¶

svc$get_identity_pool_configuration(
  IdentityPoolId = "string"
)