Skip to content

get_dataset async

get_dataset(
    dataset_id: DatasetId,
    *,
    config_overrides: Optional[AsyncBedrockAgentCoreControlClientConfig] = None,
    dataset_version: Optional[DatasetVersion] = None,
) -> GetDatasetResponse

Retrieves dataset metadata. Use the datasetVersion query parameter to retrieve a specific version's metadata. If absent, defaults to DRAFT. For paginated example content, use ListDatasetExamples.

Parameters:

  • dataset_id (DatasetId) –

    The unique identifier of the dataset to retrieve.

  • dataset_version (Optional[DatasetVersion], default: None ) –

    Version to retrieve: "DRAFT" or a version number. Defaults to DRAFT if absent.

Raises:

Source code in docs_src/capo_bedrock_agentcore_control/_services/async_bedrock_agent_core_control.py
async def get_dataset(
    self,
    dataset_id: "capo_bedrock_agentcore_control.types.dataset_id.DatasetId",
    *,
    config_overrides: Optional[AsyncBedrockAgentCoreControlClientConfig] = None,
    dataset_version: Optional[
        "capo_bedrock_agentcore_control.types.dataset_version.DatasetVersion"
    ] = None,
) -> "capo_bedrock_agentcore_control.types.get_dataset_response.GetDatasetResponse":
    """<p> Retrieves dataset metadata. Use the <code>datasetVersion</code> query parameter to retrieve a specific version's metadata. If absent, defaults to DRAFT. For paginated example content, use <code>ListDatasetExamples</code>. </p>

    Args:
        dataset_id: <p> The unique identifier of the dataset to retrieve. </p>
        dataset_version: <p> Version to retrieve: "DRAFT" or a version number. Defaults to DRAFT if absent. </p>

    Raises:
        capo_bedrock_agentcore_control.errors.access_denied_exception.AccessDeniedException: <p>This exception is thrown when a request is denied per access permissions</p>
        capo_bedrock_agentcore_control.errors.conflict_exception.ConflictException: <p>This exception is thrown when there is a conflict performing an operation</p>
        capo_bedrock_agentcore_control.errors.internal_server_exception.InternalServerException: <p>This exception is thrown if there was an unexpected error during processing of request</p>
        capo_bedrock_agentcore_control.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource referenced by the operation does not exist</p>
        capo_bedrock_agentcore_control.errors.throttling_exception.ThrottlingException: <p>This exception is thrown when the number of requests exceeds the limit</p>
        capo_bedrock_agentcore_control.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_bedrock_agentcore_control.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_bedrock_agentcore_control.types.get_dataset_request.GetDatasetRequest]",
    ) -> AsyncOperationResponse[
        "capo_bedrock_agentcore_control.types.get_dataset_response.GetDatasetResponse"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.get_dataset

        (
            output,
            http_response,
        ) = await capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.get_dataset.async_get_dataset(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_bedrock_agentcore_control.types.get_dataset_response.GetDatasetResponse",
    ) -> dict[str, Any]:
        import capo_bedrock_agentcore_control.types.get_dataset_response

        return capo_bedrock_agentcore_control.types.get_dataset_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetDataset", redact_output=_redact_output),
    )
    input_: capo_bedrock_agentcore_control.types.get_dataset_request.GetDatasetRequest = {
        "dataset_id": dataset_id
    }
    if dataset_version is not None:
        input_["dataset_version"] = dataset_version

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