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

Creates a user import job. You can import users into user pools from a comma-separated * values (CSV) file without adding Amazon Cognito MAU costs to your Amazon Web Services bill.

* *

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, CreateUserImportJobCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import * // const { CognitoIdentityProviderClient, CreateUserImportJobCommand } = 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 = { // CreateUserImportJobRequest * JobName: "STRING_VALUE", // required * UserPoolId: "STRING_VALUE", // required * CloudWatchLogsRoleArn: "STRING_VALUE", // required * }; * const command = new CreateUserImportJobCommand(input); * const response = await client.send(command); * // { // CreateUserImportJobResponse * // 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 CreateUserImportJobCommandInput - {@link CreateUserImportJobCommandInput} * @returns {@link CreateUserImportJobCommandOutput} * @see {@link CreateUserImportJobCommandInput} for command's `input` shape. * @see {@link CreateUserImportJobCommandOutput} 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 LimitExceededException} (client fault) *

This exception is thrown when a user exceeds the limit for a requested Amazon Web Services * resource.

* * @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 CreateUserImportJobCommand extends CreateUserImportJobCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateUserImportJobRequest; output: CreateUserImportJobResponse; }; sdk: { input: CreateUserImportJobCommandInput; output: CreateUserImportJobCommandOutput; }; }; }