import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient"; import type { GetCSVHeaderRequest, GetCSVHeaderResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetCSVHeaderCommand}. */ export interface GetCSVHeaderCommandInput extends GetCSVHeaderRequest { } /** * @public * * The output of {@link GetCSVHeaderCommand}. */ export interface GetCSVHeaderCommandOutput extends GetCSVHeaderResponse, __MetadataBearer { } declare const GetCSVHeaderCommand_base: { new (input: GetCSVHeaderCommandInput): import("@smithy/core/client").CommandImpl; new (input: GetCSVHeaderCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

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

* *

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 more *

* *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CognitoIdentityProviderClient, GetCSVHeaderCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import * // const { CognitoIdentityProviderClient, GetCSVHeaderCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import * // import type { CognitoIdentityProviderClientConfig } from "@aws-sdk/client-cognito-identity-provider"; * const config = {}; // type is CognitoIdentityProviderClientConfig * const client = new CognitoIdentityProviderClient(config); * const input = { // GetCSVHeaderRequest * UserPoolId: "STRING_VALUE", // required * }; * const command = new GetCSVHeaderCommand(input); * const response = await client.send(command); * // { // GetCSVHeaderResponse * // UserPoolId: "STRING_VALUE", * // CSVHeader: [ // ListOfStringTypes * // "STRING_VALUE", * // ], * // }; * * ``` * * @param GetCSVHeaderCommandInput - {@link GetCSVHeaderCommandInput} * @returns {@link GetCSVHeaderCommandOutput} * @see {@link GetCSVHeaderCommandInput} for command's `input` shape. * @see {@link GetCSVHeaderCommandOutput} for command's `response` shape. * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape. * * @throws {@link InternalErrorException} (server fault) *

This exception is thrown when Amazon Cognito encounters an internal error.

* * @throws {@link InvalidParameterException} (client fault) *

This exception is thrown when the Amazon Cognito service encounters an invalid * parameter.

* * @throws {@link NotAuthorizedException} (client fault) *

This exception is thrown when a user isn't authorized.

* * @throws {@link OperationNotEnabledException} (client fault) *

This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.

* * @throws {@link ResourceNotFoundException} (client fault) *

This exception is thrown when the Amazon Cognito service can't find the requested * resource.

* * @throws {@link TooManyRequestsException} (client fault) *

This exception is thrown when the user has made too many requests for a given * operation.

* * @throws {@link CognitoIdentityProviderServiceException} *

Base exception class for all service exceptions from CognitoIdentityProvider service.

* * * @public */ export declare class GetCSVHeaderCommand extends GetCSVHeaderCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetCSVHeaderRequest; output: GetCSVHeaderResponse; }; sdk: { input: GetCSVHeaderCommandInput; output: GetCSVHeaderCommandOutput; }; }; }