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 { StartUserImportJobRequest, StartUserImportJobResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link StartUserImportJobCommand}. */ export interface StartUserImportJobCommandInput extends StartUserImportJobRequest { } /** * @public * * The output of {@link StartUserImportJobCommand}. */ export interface StartUserImportJobCommandOutput extends StartUserImportJobResponse, __MetadataBearer { } declare const StartUserImportJobCommand_base: { new (input: StartUserImportJobCommandInput): import("@smithy/core/client").CommandImpl; new (input: StartUserImportJobCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Instructs your user pool to start importing users from a CSV file that contains their * usernames and attributes. For more information about importing users from a CSV file, * see Importing users from a CSV file.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CognitoIdentityProviderClient, StartUserImportJobCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import * // const { CognitoIdentityProviderClient, StartUserImportJobCommand } = 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 = { // StartUserImportJobRequest * UserPoolId: "STRING_VALUE", // required * JobId: "STRING_VALUE", // required * }; * const command = new StartUserImportJobCommand(input); * const response = await client.send(command); * // { // StartUserImportJobResponse * // UserImportJob: { // UserImportJobType * // JobName: "STRING_VALUE", * // JobId: "STRING_VALUE", * // UserPoolId: "STRING_VALUE", * // PreSignedUrl: "STRING_VALUE", * // CreationDate: new Date("TIMESTAMP"), * // StartDate: new Date("TIMESTAMP"), * // CompletionDate: new Date("TIMESTAMP"), * // Status: "Created" || "Pending" || "InProgress" || "Stopping" || "Expired" || "Stopped" || "Failed" || "Succeeded", * // CloudWatchLogsRoleArn: "STRING_VALUE", * // ImportedUsers: Number("long"), * // SkippedUsers: Number("long"), * // FailedUsers: Number("long"), * // CompletionMessage: "STRING_VALUE", * // }, * // }; * * ``` * * @param StartUserImportJobCommandInput - {@link StartUserImportJobCommandInput} * @returns {@link StartUserImportJobCommandOutput} * @see {@link StartUserImportJobCommandInput} for command's `input` shape. * @see {@link StartUserImportJobCommandOutput} 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 PreconditionNotMetException} (client fault) *

This exception is thrown when a precondition is not met.

* * @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 StartUserImportJobCommand extends StartUserImportJobCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartUserImportJobRequest; output: StartUserImportJobResponse; }; sdk: { input: StartUserImportJobCommandInput; output: StartUserImportJobCommandOutput; }; }; }