Skip to content

cancel_metadata_transfer_job

cancel_metadata_transfer_job(
    metadata_transfer_job_id: Id,
    *,
    config_overrides: Optional[IoTTwinMakerClientConfig] = None,
) -> CancelMetadataTransferJobResponse

Cancels the metadata transfer job.

Parameters:

  • metadata_transfer_job_id (Id) –

    The metadata transfer job Id.

Raises:

Source code in docs_src/capo_iottwinmaker/_services/io_t_twin_maker.py
def cancel_metadata_transfer_job(
    self,
    metadata_transfer_job_id: "capo_iottwinmaker.types.id.Id",
    *,
    config_overrides: Optional[IoTTwinMakerClientConfig] = None,
) -> "capo_iottwinmaker.types.cancel_metadata_transfer_job_response.CancelMetadataTransferJobResponse":
    """<p>Cancels the metadata transfer job.</p>

    Args:
        metadata_transfer_job_id: <p>The metadata transfer job Id.</p>

    Raises:
        capo_iottwinmaker.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_iottwinmaker.errors.conflict_exception.ConflictException: <p>A conflict occurred.</p>
        capo_iottwinmaker.errors.internal_server_exception.InternalServerException: <p>An unexpected error has occurred.</p>
        capo_iottwinmaker.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource wasn't found.</p>
        capo_iottwinmaker.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iottwinmaker.errors.validation_exception.ValidationException: <p>Failed</p>
        capo_iottwinmaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iottwinmaker.types.cancel_metadata_transfer_job_request.CancelMetadataTransferJobRequest]",
    ) -> OperationResponse[
        "capo_iottwinmaker.types.cancel_metadata_transfer_job_response.CancelMetadataTransferJobResponse"
    ]:
        import capo_iottwinmaker._operations.aws_io_t_twin_maker.cancel_metadata_transfer_job

        output, http_response = (
            capo_iottwinmaker._operations.aws_io_t_twin_maker.cancel_metadata_transfer_job.cancel_metadata_transfer_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelMetadataTransferJob")
    )
    input_: capo_iottwinmaker.types.cancel_metadata_transfer_job_request.CancelMetadataTransferJobRequest = {
        "metadata_transfer_job_id": metadata_transfer_job_id
    }

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