Skip to content

list_address_list_import_jobs

list_address_list_import_jobs(
    address_list_id: AddressListId,
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    page_size: Optional[PageSize] = None,
) -> ListAddressListImportJobsResponse

Lists jobs for an address list.

Parameters:

  • address_list_id (AddressListId) –

    The unique identifier of the address list for listing import jobs.

  • next_token (Optional[PaginationToken], default: None ) –

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • page_size (Optional[PageSize], default: None ) –

    The maximum number of import jobs that are returned per call. You can use NextToken to retrieve the next page of jobs.

Raises:

Source code in docs_src/capo_mailmanager/_services/mail_manager.py
def list_address_list_import_jobs(
    self,
    address_list_id: "capo_mailmanager.types.address_list_id.AddressListId",
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
    next_token: Optional[
        "capo_mailmanager.types.pagination_token.PaginationToken"
    ] = None,
    page_size: Optional["capo_mailmanager.types.page_size.PageSize"] = None,
) -> "capo_mailmanager.types.list_address_list_import_jobs_response.ListAddressListImportJobsResponse":
    """<p>Lists jobs for an address list.</p>

    Args:
        address_list_id: <p>The unique identifier of the address list for listing import jobs.</p>
        next_token: <p>If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.</p>
        page_size: <p>The maximum number of import jobs that are returned per call. You can use NextToken to retrieve the next page of jobs.</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.
    """

    def _handler(
        req: "OperationRequest[capo_mailmanager.types.list_address_list_import_jobs_request.ListAddressListImportJobsRequest]",
    ) -> OperationResponse[
        "capo_mailmanager.types.list_address_list_import_jobs_response.ListAddressListImportJobsResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.list_address_list_import_jobs

        output, http_response = (
            capo_mailmanager._operations.mail_manager_svc.list_address_list_import_jobs.list_address_list_import_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

        return capo_mailmanager.types.list_address_list_import_jobs_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListAddressListImportJobs", redact_output=_redact_output),
    )
    input_: capo_mailmanager.types.list_address_list_import_jobs_request.ListAddressListImportJobsRequest = {
        "address_list_id": address_list_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if page_size is not None:
        input_["page_size"] = page_size

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