Skip to content

describe_dataset async

describe_dataset(
    dataset_arn: ComprehendDatasetArn,
    *,
    config_overrides: Optional[AsyncComprehendClientConfig] = None,
) -> DescribeDatasetResponse

Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

Parameters:

Raises:

Source code in docs_src/capo_comprehend/_services/async_comprehend.py
async def describe_dataset(
    self,
    dataset_arn: "capo_comprehend.types.comprehend_dataset_arn.ComprehendDatasetArn",
    *,
    config_overrides: Optional[AsyncComprehendClientConfig] = None,
) -> "capo_comprehend.types.describe_dataset_response.DescribeDatasetResponse":
    """<p>Returns information about the dataset that you specify. For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html"> Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>

    Args:
        dataset_arn: <p>The ARN of the dataset.</p>

    Raises:
        capo_comprehend.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_comprehend.errors.invalid_request_exception.InvalidRequestException: <p>The request is invalid.</p>
        capo_comprehend.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
        capo_comprehend.errors.too_many_requests_exception.TooManyRequestsException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_comprehend.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

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

        (
            output,
            http_response,
        ) = await capo_comprehend._operations.comprehend_20171127.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_comprehend.types.describe_dataset_request.DescribeDatasetRequest = {
        "dataset_arn": dataset_arn
    }

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