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 meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

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 BeginDescribeDataset and EndDescribeDataset.

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

Syntax

C#
public abstract Task<DescribeDatasetResponse> DescribeDatasetAsync(
         DescribeDatasetRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CognitoSync.Model.DescribeDatasetRequest

Container for the necessary parameters to execute the DescribeDataset service method.

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