Skip to content

create_address_list_import_job async

create_address_list_import_job(
    address_list_id: AddressListId,
    name: JobName,
    import_data_format: ImportDataFormat,
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
    client_token: Optional[IdempotencyToken] = None,
) -> CreateAddressListImportJobResponse

Creates an import job for an address list.

Parameters:

  • client_token (Optional[IdempotencyToken], default: None ) –

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

  • address_list_id (AddressListId) –

    The unique identifier of the address list for importing addresses to.

  • name (JobName) –

    A user-friendly name for the import job.

  • import_data_format (ImportDataFormat) –

    The format of the input for an import job.

Raises:

Source code in docs_src/capo_mailmanager/_services/async_mail_manager.py
async def create_address_list_import_job(
    self,
    address_list_id: "capo_mailmanager.types.address_list_id.AddressListId",
    name: "capo_mailmanager.types.job_name.JobName",
    import_data_format: "capo_mailmanager.types.import_data_format.ImportDataFormat",
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
    client_token: Optional[
        "capo_mailmanager.types.idempotency_token.IdempotencyToken"
    ] = None,
) -> "capo_mailmanager.types.create_address_list_import_job_response.CreateAddressListImportJobResponse":
    """<p>Creates an import job for an address list.</p>

    Args:
        client_token: <p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>
        address_list_id: <p>The unique identifier of the address list for importing addresses to.</p>
        name: <p>A user-friendly name for the import job.</p>
        import_data_format: <p>The format of the input for an import job.</p>

    Raises:
        capo_mailmanager.errors.access_denied_exception.AccessDeniedException: <p>Occurs when a user is denied access to a specific resource or action.</p>
        capo_mailmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p>Occurs when a requested resource is not found.</p>
        capo_mailmanager.errors.throttling_exception.ThrottlingException: <p>Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.</p>
        capo_mailmanager.errors.validation_exception.ValidationException: <p>The request validation has failed. For details, see the accompanying error message.</p>
        capo_mailmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_mailmanager.types.create_address_list_import_job_request.CreateAddressListImportJobRequest]",
    ) -> AsyncOperationResponse[
        "capo_mailmanager.types.create_address_list_import_job_response.CreateAddressListImportJobResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.create_address_list_import_job

        (
            output,
            http_response,
        ) = await capo_mailmanager._operations.mail_manager_svc.create_address_list_import_job.async_create_address_list_import_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_mailmanager.types.create_address_list_import_job_response.CreateAddressListImportJobResponse",
    ) -> dict[str, Any]:
        import capo_mailmanager.types.create_address_list_import_job_response

        return capo_mailmanager.types.create_address_list_import_job_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreateAddressListImportJob", redact_output=_redact_output
        ),
    )
    input_: capo_mailmanager.types.create_address_list_import_job_request.CreateAddressListImportJobRequest = {
        "address_list_id": address_list_id,
        "name": name,
        "import_data_format": import_data_format,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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