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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeIdentity and EndDescribeIdentity. For Unity the operation does not take CancellationToken as a parameter, and instead takes AmazonServiceCallback<DescribeIdentityRequest, DescribeIdentityResponse> and AsyncOptions as additional parameters.

Namespace: Amazon.CognitoIdentity
Assembly: AWSSDK.CognitoIdentity.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<DescribeIdentityResponse> DescribeIdentityAsync(
         String identityId,
         CancellationToken cancellationToken
)
Parameters
identityId
Type: System.String

A unique identifier in the format REGION:GUID.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value
The response from the DescribeIdentity service method, as returned by CognitoIdentity.

Exceptions

ExceptionCondition
InternalErrorException Thrown when the service encounters an error during processing the request.
InvalidParameterException Thrown for missing or bad input parameter(s).
NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
TooManyRequestsException Thrown when a request is throttled.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also