Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . cognito-sync ]

get-identity-pool-configuration

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-identity-pool-configuration
--identity-pool-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--identity-pool-id (string)

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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

IdentityPoolId -> (string)

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.

PushSync -> (structure)

Options to apply to this identity pool for push synchronization.

ApplicationArns -> (list)

List of SNS platform application ARNs that could be used by clients.

(string)

RoleArn -> (string)

A role configured to allow Cognito to call SNS on behalf of the developer.

CognitoStreams -> (structure)

Options to apply to this identity pool for Amazon Cognito streams.

StreamName -> (string)

The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.

RoleArn -> (string)

The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.

StreamingStatus -> (string)

Status of the Cognito streams. Valid values are:

ENABLED - Streaming of updates to identity pool is enabled.

DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.