Table Of Contents


User Guide

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

[ aws . cognito-idp ]



Gets the specified identity provider.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--user-pool-id <value>
--idp-identifier <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--user-pool-id (string)

The user pool ID.

--idp-identifier (string)

The identity provider ID.

--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.


IdentityProvider -> (structure)

The identity provider object.

UserPoolId -> (string)

The user pool ID.

ProviderName -> (string)

The identity provider name.

ProviderType -> (string)

The identity provider type.

ProviderDetails -> (map)

The identity provider details, such as MetadataURL and MetadataFile .

key -> (string)

value -> (string)

AttributeMapping -> (map)

A mapping of identity provider attributes to standard and custom user pool attributes.

key -> (string)

value -> (string)

IdpIdentifiers -> (list)

A list of identity provider identifiers.


LastModifiedDate -> (timestamp)

The date the identity provider was last modified.

CreationDate -> (timestamp)

The date the identity provider was created.