create_dataset_export_job `async` ¶

create_dataset_export_job(
    workspace_name: WorkspaceName,
    destination_s3_uri: S3Uri,
    input: ProcessingInput,
    error_report_location: ExportErrorReportLocation,
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> CreateDatasetExportJobResponse

Starts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3. The operation returns a jobId immediately; poll DescribeDatasetExportJob to track progress and ListDatasetExportJobs to enumerate a workspace's jobs.

Parameters:

workspace_name (WorkspaceName) –

The name of the workspace in which to create the dataset export job.
client_token (Optional[ClientToken], default: None ) –

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The AWS SDKs and CLI populate this automatically.
destination_s3_uri (S3Uri) –

The S3 URI where output clips will be written.
input (ProcessingInput) –

The processing input source.
error_report_location (ExportErrorReportLocation) –

The location where the error report will be written on failure.

Raises:

AccessDeniedException –

Access is denied.
ConflictingOperationException –

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
InternalFailureException –

IoT SiteWise can't process your request right now. Try again later.
InvalidRequestException –

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
ResourceNotFoundException –

The requested resource can't be found.
ThrottlingException –

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iotsitewise/_services/async_io_t_site_wise.py

async def create_dataset_export_job(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    destination_s3_uri: "capo_iotsitewise.types.s3_uri.S3Uri",
    input: "capo_iotsitewise.types.processing_input.ProcessingInput",
    error_report_location: "capo_iotsitewise.types.export_error_report_location.ExportErrorReportLocation",
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    client_token: Optional[
        "capo_iotsitewise.types.client_token.ClientToken"
    ] = None,
) -> "capo_iotsitewise.types.create_dataset_export_job_response.CreateDatasetExportJobResponse":
    """<p>Starts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3. The operation returns a jobId immediately; poll DescribeDatasetExportJob to track progress and ListDatasetExportJobs to enumerate a workspace's jobs.</p>

    Args:
        workspace_name: <p>The name of the workspace in which to create the dataset export job.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The AWS SDKs and CLI populate this automatically.</p>
        destination_s3_uri: <p>The S3 URI where output clips will be written.</p>
        input: <p>The processing input source.</p>
        error_report_location: <p>The location where the error report will be written on failure.</p>

    Raises:
        capo_iotsitewise.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_iotsitewise.errors.conflicting_operation_exception.ConflictingOperationException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotsitewise.types.create_dataset_export_job_request.CreateDatasetExportJobRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotsitewise.types.create_dataset_export_job_response.CreateDatasetExportJobResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.create_dataset_export_job

        (
            output,
            http_response,
        ) = await capo_iotsitewise._operations.aws_io_t_site_wise.create_dataset_export_job.async_create_dataset_export_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateDatasetExportJob")
    )
    input_: capo_iotsitewise.types.create_dataset_export_job_request.CreateDatasetExportJobRequest = {
        "workspace_name": workspace_name,
        "destination_s3_uri": destination_s3_uri,
        "input": input,
        "error_report_location": error_report_location,
    }
    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

create_dataset_export_job async ¶

create_dataset_export_job `async` ¶