AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class CognitoIdentityProviderInfo

A provider representing an Amazon Cognito Identity User Pool and its client ID.

Class ConcurrentModificationException

CognitoIdentity exception

Class CreateIdentityPoolRequest

Container for the parameters to the CreateIdentityPool operation. Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for SupportedLoginProviders are as follows:

  • Facebook: graph.facebook.com

  • Google: accounts.google.com

  • Amazon: www.amazon.com

  • Twitter: api.twitter.com

  • Digits: www.digits.com

You must use AWS Developer credentials to call this API.

Class CreateIdentityPoolResponse

An object representing an Amazon Cognito identity pool.

Class Credentials

AWS credentials for API authentication.

Class DeleteIdentitiesRequest

Container for the parameters to the DeleteIdentities operation. Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

You must use AWS Developer credentials to call this API.

Class DeleteIdentitiesResponse

Returned in response to a successful DeleteIdentities operation.

Class DeleteIdentityPoolRequest

Container for the parameters to the DeleteIdentityPool operation. Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.

You must use AWS Developer credentials to call this API.

Class DeleteIdentityPoolResponse

This is the response object from the DeleteIdentityPool operation.

Class DescribeIdentityPoolRequest

Container for the parameters to the DescribeIdentityPool operation. 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.

Class DescribeIdentityPoolResponse

An object representing an Amazon Cognito identity pool.

Class DescribeIdentityRequest

Container for the parameters to the DescribeIdentity operation. Returns metadata related to the given identity, including when the identity was created and any associated linked logins.

You must use AWS Developer credentials to call this API.

Class DescribeIdentityResponse

A description of the identity.

Class DeveloperUserAlreadyRegisteredException

CognitoIdentity exception

Class ExternalServiceException

CognitoIdentity exception

Class GetCredentialsForIdentityRequest

Container for the parameters to the GetCredentialsForIdentity operation. Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.

This is a public API. You do not need any credentials to call this API.

Class GetCredentialsForIdentityResponse

Returned in response to a successful GetCredentialsForIdentity operation.

Class GetIdentityPoolRolesRequest

Container for the parameters to the GetIdentityPoolRoles operation. Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

Class GetIdentityPoolRolesResponse

Returned in response to a successful GetIdentityPoolRoles operation.

Class GetIdRequest

Container for the parameters to the GetId operation. Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.

This is a public API. You do not need any credentials to call this API.

Class GetIdResponse

Returned in response to a GetId request.

Class GetOpenIdTokenForDeveloperIdentityRequest

Container for the parameters to the GetOpenIdTokenForDeveloperIdentity operation. Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.

You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId. This API will create the identity in the specified IdentityPoolId.

You must use AWS Developer credentials to call this API.

Class GetOpenIdTokenForDeveloperIdentityResponse

Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.

Class GetOpenIdTokenRequest

Container for the parameters to the GetOpenIdToken operation. Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.

The OpenId token is valid for 15 minutes.

This is a public API. You do not need any credentials to call this API.

Class GetOpenIdTokenResponse

Returned in response to a successful GetOpenIdToken request.

Class IdentityDescription

A description of the identity.

Class IdentityPoolShortDescription

A description of the identity pool.

Class InternalErrorException

CognitoIdentity exception

Class InvalidIdentityPoolConfigurationException

CognitoIdentity exception

Class InvalidParameterException

CognitoIdentity exception

Class LimitExceededException

CognitoIdentity exception

Class ListIdentitiesRequest

Container for the parameters to the ListIdentities operation. Lists the identities in a pool.

You must use AWS Developer credentials to call this API.

Class ListIdentitiesResponse

The response to a ListIdentities request.

Class ListIdentityPoolsRequest

Container for the parameters to the ListIdentityPools operation. Lists all of the Cognito identity pools registered for your account.

You must use AWS Developer credentials to call this API.

Class ListIdentityPoolsResponse

The result of a successful ListIdentityPools action.

Class LookupDeveloperIdentityRequest

Container for the parameters to the LookupDeveloperIdentity operation. Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifiers associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown.

You must use AWS Developer credentials to call this API.

Class LookupDeveloperIdentityResponse

Returned in response to a successful LookupDeveloperIdentity action.

Class MappingRule

A rule that maps a claim name, a claim value, and a match type to a role ARN.

Class MergeDeveloperIdentitiesRequest

Container for the parameters to the MergeDeveloperIdentities operation. Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.

You must use AWS Developer credentials to call this API.

Class MergeDeveloperIdentitiesResponse

Returned in response to a successful MergeDeveloperIdentities action.

Class NotAuthorizedException

CognitoIdentity exception

Class ResourceConflictException

CognitoIdentity exception

Class ResourceNotFoundException

CognitoIdentity exception

Class RoleMapping

A role mapping.

Class RulesConfigurationType

A container for rules.

Class SetIdentityPoolRolesRequest

Container for the parameters to the SetIdentityPoolRoles operation. Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

You must use AWS Developer credentials to call this API.

Class SetIdentityPoolRolesResponse

This is the response object from the SetIdentityPoolRoles operation.

Class TooManyRequestsException

CognitoIdentity exception

Class UnlinkDeveloperIdentityRequest

Container for the parameters to the UnlinkDeveloperIdentity operation. Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.

You must use AWS Developer credentials to call this API.

Class UnlinkDeveloperIdentityResponse

This is the response object from the UnlinkDeveloperIdentity operation.

Class UnlinkIdentityRequest

Container for the parameters to the UnlinkIdentity operation. Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

This is a public API. You do not need any credentials to call this API.

Class UnlinkIdentityResponse

This is the response object from the UnlinkIdentity operation.

Class UnprocessedIdentityId

An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.

Class UpdateIdentityPoolRequest

Container for the parameters to the UpdateIdentityPool operation. Updates a user pool.

You must use AWS Developer credentials to call this API.

Class UpdateIdentityPoolResponse

An object representing an Amazon Cognito identity pool.