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.

Gets usage details (for example, data storage) about a particular 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.

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 BeginDescribeIdentityPoolUsage and EndDescribeIdentityPoolUsage.

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

Syntax

C#
public abstract Task<DescribeIdentityPoolUsageResponse> DescribeIdentityPoolUsageAsync(
         String identityPoolId,
         CancellationToken cancellationToken
)

Parameters

identityPoolId
Type: System.String

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

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 DescribeIdentityPoolUsage service method, as returned by CognitoSync.

Exceptions

ExceptionCondition
InternalErrorException Indicates an internal service error.
InvalidParameterException Thrown when a request parameter does not comply with the associated constraints.
NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
ResourceNotFoundException Thrown if the resource doesn't exist.
TooManyRequestsException Thrown if the 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