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.
Given a user pool ID, generates a comma-separated value (CSV) list populated with
available user attributes in the user pool. This list is the header for the CSV file
that determines the users in a user import job. Save the content of
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests
for this API operation. For this operation, you must use IAM credentials to authorize
requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn moreCSVHeader
in the response as a .csv file and populate it with the usernames and attributes
of users that you want to import. For more information about CSV user import, see
Importing
users from a CSV file.
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 BeginGetCSVHeader and EndGetCSVHeader.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public virtual Task<GetCSVHeaderResponse> GetCSVHeaderAsync( GetCSVHeaderRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the GetCSVHeader service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| InternalErrorException | This exception is thrown when Amazon Cognito encounters an internal error. |
| InvalidParameterException | This exception is thrown when the Amazon Cognito service encounters an invalid parameter. |
| NotAuthorizedException | This exception is thrown when a user isn't authorized. |
| ResourceNotFoundException | This exception is thrown when the Amazon Cognito service can't find the requested resource. |
| TooManyRequestsException | This exception is thrown when the user has made too many requests for a given operation. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer