Skip to content

list_upload_jobs

list_upload_jobs(
    domain_name: name,
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
    max_results: Optional[MaxSize500] = None,
    next_token: Optional[token] = None,
) -> ListUploadJobsResponse

This API retrieves a list of upload jobs for the specified domain.

Parameters:

  • domain_name (name) –

    The unique name of the domain to list upload jobs for.

  • max_results (Optional[MaxSize500], default: None ) –

    The maximum number of upload jobs to return per page.

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

    The pagination token from the previous call to retrieve the next page of results.

Raises:

Source code in docs_src/capo_customer_profiles/_services/customer_profiles.py
def list_upload_jobs(
    self,
    domain_name: "capo_customer_profiles.types.name.name",
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
    max_results: Optional[
        "capo_customer_profiles.types.max_size500.MaxSize500"
    ] = None,
    next_token: Optional["capo_customer_profiles.types.token.token"] = None,
) -> (
    "capo_customer_profiles.types.list_upload_jobs_response.ListUploadJobsResponse"
):
    """<p>This API retrieves a list of upload jobs for the specified domain. </p>

    Args:
        domain_name: <p>The unique name of the domain to list upload jobs for. </p>
        max_results: <p>The maximum number of upload jobs to return per page. </p>
        next_token: <p>The pagination token from the previous call to retrieve the next page of results. </p>

    Raises:
        capo_customer_profiles.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_customer_profiles.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_customer_profiles.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred.</p>
        capo_customer_profiles.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource does not exist, or access was denied.</p>
        capo_customer_profiles.errors.throttling_exception.ThrottlingException: <p>You exceeded the maximum number of requests.</p>
        capo_customer_profiles.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_customer_profiles.types.list_upload_jobs_request.ListUploadJobsRequest]",
    ) -> OperationResponse[
        "capo_customer_profiles.types.list_upload_jobs_response.ListUploadJobsResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.list_upload_jobs

        output, http_response = (
            capo_customer_profiles._operations.customer_profiles_20200815.list_upload_jobs.list_upload_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListUploadJobs")
    )
    input_: capo_customer_profiles.types.list_upload_jobs_request.ListUploadJobsRequest = {
        "domain_name": domain_name
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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