start_user_import_job ¶

start_user_import_job(
    user_pool_id: UserPoolIdType,
    job_id: UserImportJobIdType,
    *,
    config_overrides: Optional[CognitoIdentityProviderClientConfig] = None,
) -> StartUserImportJobResponse

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.

Parameters:

user_pool_id (UserPoolIdType) –

The ID of the user pool that you want to start importing users into.
job_id (UserImportJobIdType) –

The ID of a user import job that you previously created.

Raises:

InternalErrorException –

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

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

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

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.
PreconditionNotMetException –

This exception is thrown when a precondition is not met.
ResourceNotFoundException –

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

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

The service returned an error code this client does not model.

Source code in docs_src/capo_cognito_identity_provider/_services/cognito_identity_provider.py

def start_user_import_job(
    self,
    user_pool_id: "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType",
    job_id: "capo_cognito_identity_provider.types.user_import_job_id_type.UserImportJobIdType",
    *,
    config_overrides: Optional[CognitoIdentityProviderClientConfig] = None,
) -> "capo_cognito_identity_provider.types.start_user_import_job_response.StartUserImportJobResponse":
    """<p>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 <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html">Importing users from a CSV file</a>.</p>

    Args:
        user_pool_id: <p>The ID of the user pool that you want to start importing users into.</p>
        job_id: <p>The ID of a user import job that you previously created.</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.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.
    """

    def _handler(
        req: "OperationRequest[capo_cognito_identity_provider.types.start_user_import_job_request.StartUserImportJobRequest]",
    ) -> OperationResponse[
        "capo_cognito_identity_provider.types.start_user_import_job_response.StartUserImportJobResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.start_user_import_job

        output, http_response = (
            capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.start_user_import_job.start_user_import_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartUserImportJob")
    )
    input_: capo_cognito_identity_provider.types.start_user_import_job_request.StartUserImportJobRequest = {
        "user_pool_id": user_pool_id,
        "job_id": job_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output