create_user_import_job async ¶

async def create_user_import_job(
    self,
    job_name: "capo_cognito_identity_provider.types.user_import_job_name_type.UserImportJobNameType",
    user_pool_id: "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType",
    cloud_watch_logs_role_arn: "capo_cognito_identity_provider.types.arn_type.ArnType",
    *,
    config_overrides: Optional[AsyncCognitoIdentityProviderClientConfig] = None,
    password_hashing_algorithm: Optional[
        "capo_cognito_identity_provider.types.password_hashing_algorithm_type.PasswordHashingAlgorithmType"
    ] = None,
) -> "capo_cognito_identity_provider.types.create_user_import_job_response.CreateUserImportJobResponse":
    """<p>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.</p> <note> <p>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.</p> <p class="title"> <b>Learn more</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a> </p> </li> </ul> </note>

    Args:
        job_name: <p>A friendly name for the user import job.</p>
        user_pool_id: <p>The ID of the user pool that you want to import users into.</p>
        cloud_watch_logs_role_arn: <p>You must specify an IAM role that has permission to log import-job results to Amazon CloudWatch Logs. This parameter is the ARN of that role.</p>
        password_hashing_algorithm: <p>The password hashing algorithm used to generate the hashes in the CSV file for this import job.</p> <p>Valid values: <code>BCRYPT</code> | <code>SCRYPT</code> | <code>ARGON2ID</code> | <code>PBKDF2_SHA256</code> </p>

    Raises:
        capo_cognito_identity_provider.errors.internal_error_exception.InternalErrorException: <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
        capo_cognito_identity_provider.errors.invalid_parameter_exception.InvalidParameterException: <p>This exception is thrown when the Amazon Cognito service encounters an invalid parameter.</p>
        capo_cognito_identity_provider.errors.limit_exceeded_exception.LimitExceededException: <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.</p>
        capo_cognito_identity_provider.errors.not_authorized_exception.NotAuthorizedException: <p>This exception is thrown when a user isn't authorized.</p>
        capo_cognito_identity_provider.errors.operation_not_enabled_exception.OperationNotEnabledException: <p>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.</p>
        capo_cognito_identity_provider.errors.precondition_not_met_exception.PreconditionNotMetException: <p>This exception is thrown when a precondition is not met.</p>
        capo_cognito_identity_provider.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when the Amazon Cognito service can't find the requested resource.</p>
        capo_cognito_identity_provider.errors.too_many_requests_exception.TooManyRequestsException: <p>This exception is thrown when the user has made too many requests for a given operation.</p>
        capo_cognito_identity_provider.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cognito_identity_provider.types.create_user_import_job_request.CreateUserImportJobRequest]",
    ) -> AsyncOperationResponse[
        "capo_cognito_identity_provider.types.create_user_import_job_response.CreateUserImportJobResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.create_user_import_job

        (
            output,
            http_response,
        ) = await capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.create_user_import_job.async_create_user_import_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateUserImportJob")
    )
    input_: capo_cognito_identity_provider.types.create_user_import_job_request.CreateUserImportJobRequest = {
        "job_name": job_name,
        "user_pool_id": user_pool_id,
        "cloud_watch_logs_role_arn": cloud_watch_logs_role_arn,
    }
    if password_hashing_algorithm is not None:
        input_["password_hashing_algorithm"] = password_hashing_algorithm

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output