Skip to content

create_export_job 

create_export_job(
    application_id: __string,
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    export_job_request: Optional[ExportJobRequest] = None,
) -> CreateExportJobResponse

Creates an export job for an application.

Parameters:

  • application_id (__string) –

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Raises:

Source code in docs_src/capo_pinpoint/_services/pinpoint.py 
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
def create_export_job(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    export_job_request: Optional[
        "capo_pinpoint.types.export_job_request.ExportJobRequest"
    ] = None,
) -> "capo_pinpoint.types.create_export_job_response.CreateExportJobResponse":
    """<p>Creates an export job for an application.</p>

    Args:
        application_id: <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>

    Raises:
        capo_pinpoint.errors.bad_request_exception.BadRequestException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.forbidden_exception.ForbiddenException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.internal_server_error_exception.InternalServerErrorException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.method_not_allowed_exception.MethodNotAllowedException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.not_found_exception.NotFoundException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.payload_too_large_exception.PayloadTooLargeException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.too_many_requests_exception.TooManyRequestsException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint.types.create_export_job_request.CreateExportJobRequest]",
    ) -> OperationResponse[
        "capo_pinpoint.types.create_export_job_response.CreateExportJobResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.create_export_job

        output, http_response = (
            capo_pinpoint._operations.pinpoint.create_export_job.create_export_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateExportJob")
    )
    input_: capo_pinpoint.types.create_export_job_request.CreateExportJobRequest = {
        "application_id": application_id
    }
    if export_job_request is not None:
        input_["export_job_request"] = export_job_request

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