describe_dataset `async` ¶

describe_dataset(
    dataset_name: DatasetIdentifier,
    *,
    config_overrides: Optional[AsyncLookoutEquipmentClientConfig] = None,
) -> DescribeDatasetResponse

Provides a JSON description of the data in each time series dataset, including names, column names, and data types.

Parameters:

dataset_name (DatasetIdentifier) –

The name of the dataset to be described.

Raises:

AccessDeniedException –

The request could not be completed because you do not have access to the resource.
InternalServerException –

Processing of the request has failed because of an unknown error, exception or failure.
ResourceNotFoundException –

The resource requested could not be found. Verify the resource ID and retry your request.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.
UnknownServiceError –

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

Source code in docs_src/capo_lookoutequipment/_services/async_lookout_equipment.py

async def describe_dataset(
    self,
    dataset_name: "capo_lookoutequipment.types.dataset_identifier.DatasetIdentifier",
    *,
    config_overrides: Optional[AsyncLookoutEquipmentClientConfig] = None,
) -> (
    "capo_lookoutequipment.types.describe_dataset_response.DescribeDatasetResponse"
):
    """<p>Provides a JSON description of the data in each time series dataset, including names, column names, and data types.</p>

    Args:
        dataset_name: <p>The name of the dataset to be described. </p>

    Raises:
        capo_lookoutequipment.errors.access_denied_exception.AccessDeniedException: <p>The request could not be completed because you do not have access to the resource. </p>
        capo_lookoutequipment.errors.internal_server_exception.InternalServerException: <p> Processing of the request has failed because of an unknown error, exception or failure. </p>
        capo_lookoutequipment.errors.resource_not_found_exception.ResourceNotFoundException: <p> The resource requested could not be found. Verify the resource ID and retry your request. </p>
        capo_lookoutequipment.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_lookoutequipment.errors.validation_exception.ValidationException: <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized. </p>
        capo_lookoutequipment.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lookoutequipment.types.describe_dataset_request.DescribeDatasetRequest]",
    ) -> AsyncOperationResponse[
        "capo_lookoutequipment.types.describe_dataset_response.DescribeDatasetResponse"
    ]:
        import capo_lookoutequipment._operations.aws_lookout_equipment_frontend_service.describe_dataset

        (
            output,
            http_response,
        ) = await capo_lookoutequipment._operations.aws_lookout_equipment_frontend_service.describe_dataset.async_describe_dataset(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDataset")
    )
    input_: capo_lookoutequipment.types.describe_dataset_request.DescribeDatasetRequest = {
        "dataset_name": dataset_name
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_dataset async ¶

describe_dataset `async` ¶