Skip to content

get_dataset

get_dataset(
    dataset_id: StringValueLength1to255,
    *,
    config_overrides: Optional[finspacedataClientConfig] = None,
) -> GetDatasetResponse

Returns information about a Dataset.

Parameters:

Raises:

Source code in docs_src/capo_finspace_data/_services/finspacedata.py
def get_dataset(
    self,
    dataset_id: "capo_finspace_data.types.string_value_length1to255.StringValueLength1to255",
    *,
    config_overrides: Optional[finspacedataClientConfig] = None,
) -> "capo_finspace_data.types.get_dataset_response.GetDatasetResponse":
    """<p>Returns information about a Dataset.</p>

    Args:
        dataset_id: <p>The unique identifier for a Dataset.</p>

    Raises:
        capo_finspace_data.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace_data.errors.conflict_exception.ConflictException: <p>The request conflicts with an existing resource.</p>
        capo_finspace_data.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace_data.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_finspace_data.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace_data.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace_data.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_finspace_data.types.get_dataset_request.GetDatasetRequest]",
    ) -> OperationResponse[
        "capo_finspace_data.types.get_dataset_response.GetDatasetResponse"
    ]:
        import capo_finspace_data._operations.aws_habanero_public_api.get_dataset

        output, http_response = (
            capo_finspace_data._operations.aws_habanero_public_api.get_dataset.get_dataset(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDataset")
    )
    input_: capo_finspace_data.types.get_dataset_request.GetDatasetRequest = {
        "dataset_id": dataset_id
    }

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