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

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 BeginGetCredentialsForIdentity and EndGetCredentialsForIdentity.

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

Syntax

C#
public virtual Task<GetCredentialsForIdentityResponse> GetCredentialsForIdentityAsync(
         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 GetCredentialsForIdentity service method, as returned by CognitoIdentity.

Exceptions

ExceptionCondition
ExternalServiceException An exception thrown when a dependent service such as Facebook or Twitter is not responding
InternalErrorException Thrown when the service encounters an error during processing the request.
InvalidIdentityPoolConfigurationException Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.
InvalidParameterException Thrown for missing or bad input parameter(s).
NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also