get_csv_header

get_csv_header(**kwargs)

Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.

See also: AWS API Documentation

Request Syntax

response = client.get_csv_header(
    UserPoolId='string'
)

Parameters

UserPoolId (string) --

[REQUIRED]

The user pool ID for the user pool that the users are to be imported into.

Return type

dict

Returns

Response Syntax

{
    'UserPoolId': 'string',
    'CSVHeader': [
        'string',
    ]
}

Response Structure

• (dict) --

  Represents the response from the server to the request to get the header information of the CSV file for the user import job.

  • UserPoolId (string) --

    The user pool ID for the user pool that the users are to be imported into.

  • CSVHeader (list) --

    The header information of the CSV file for the user import job.

    • (string) --

Exceptions

• CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
• CognitoIdentityProvider.Client.exceptions.InvalidParameterException
• CognitoIdentityProvider.Client.exceptions.TooManyRequestsException
• CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
• CognitoIdentityProvider.Client.exceptions.InternalErrorException