Skip to content

start_upload_job

start_upload_job(
    domain_name: name,
    job_id: name,
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
) -> StartUploadJobResponse

This API starts the processing of an upload job to ingest profile data.

Parameters:

  • domain_name (name) –

    The unique name of the domain containing the upload job to start.

  • job_id (name) –

    The unique identifier of the upload job to start.

Raises:

Source code in docs_src/capo_customer_profiles/_services/customer_profiles.py
def start_upload_job(
    self,
    domain_name: "capo_customer_profiles.types.name.name",
    job_id: "capo_customer_profiles.types.name.name",
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
) -> (
    "capo_customer_profiles.types.start_upload_job_response.StartUploadJobResponse"
):
    """<p>This API starts the processing of an upload job to ingest profile data. </p>

    Args:
        domain_name: <p>The unique name of the domain containing the upload job to start. </p>
        job_id: <p>The unique identifier of the upload job to start. </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.start_upload_job_request.StartUploadJobRequest]",
    ) -> OperationResponse[
        "capo_customer_profiles.types.start_upload_job_response.StartUploadJobResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.start_upload_job

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartUploadJob")
    )
    input_: capo_customer_profiles.types.start_upload_job_request.StartUploadJobRequest = {
        "domain_name": domain_name,
        "job_id": job_id,
    }

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