aws-sdk-bedrockagentcorecontrol 1.58.0

AWS SDK for Amazon Bedrock AgentCore Control
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListDatasetExamples`](crate::operation::list_dataset_examples::builders::ListDatasetExamplesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_dataset_examples::builders::ListDatasetExamplesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`dataset_id(impl Into<String>)`](crate::operation::list_dataset_examples::builders::ListDatasetExamplesFluentBuilder::dataset_id) / [`set_dataset_id(Option<String>)`](crate::operation::list_dataset_examples::builders::ListDatasetExamplesFluentBuilder::set_dataset_id):<br>required: **true**<br><p>The unique identifier of the dataset.</p><br>
    ///   - [`dataset_version(impl Into<String>)`](crate::operation::list_dataset_examples::builders::ListDatasetExamplesFluentBuilder::dataset_version) / [`set_dataset_version(Option<String>)`](crate::operation::list_dataset_examples::builders::ListDatasetExamplesFluentBuilder::set_dataset_version):<br>required: **false**<br>Version to paginate: "DRAFT" or a version number. Defaults to DRAFT if absent. Only used on the first request (when nextToken is absent). For subsequent pages, the version is extracted from the nextToken and this parameter is ignored.<br>
    ///   - [`max_results(i32)`](crate::operation::list_dataset_examples::builders::ListDatasetExamplesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_dataset_examples::builders::ListDatasetExamplesFluentBuilder::set_max_results):<br>required: **false**<br>Maximum number of examples to return per page. Default: 1000. Min: 1, max: 1000. Response size is validated against 5 MB limit after reading. For bulk access to all examples, use the `downloadUrl` field from GetDataset.<br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_dataset_examples::builders::ListDatasetExamplesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_dataset_examples::builders::ListDatasetExamplesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
    /// - On success, responds with [`ListDatasetExamplesOutput`](crate::operation::list_dataset_examples::ListDatasetExamplesOutput) with field(s):
    ///   - [`dataset_arn(String)`](crate::operation::list_dataset_examples::ListDatasetExamplesOutput::dataset_arn): <p>The Amazon Resource Name (ARN) of the dataset.</p>
    ///   - [`dataset_id(String)`](crate::operation::list_dataset_examples::ListDatasetExamplesOutput::dataset_id): <p>The unique identifier of the dataset.</p>
    ///   - [`dataset_version(String)`](crate::operation::list_dataset_examples::ListDatasetExamplesOutput::dataset_version): The version returned.
    ///   - [`examples(Vec::<Document>)`](crate::operation::list_dataset_examples::ListDatasetExamplesOutput::examples): Paginated example content. Each element is a JSON object containing at least an `exampleId` field plus the schema-specific content fields.
    ///   - [`next_token(Option<String>)`](crate::operation::list_dataset_examples::ListDatasetExamplesOutput::next_token): <p>The token for the next page of results, or null if there are no more results.</p>
    /// - On failure, responds with [`SdkError<ListDatasetExamplesError>`](crate::operation::list_dataset_examples::ListDatasetExamplesError)
    pub fn list_dataset_examples(&self) -> crate::operation::list_dataset_examples::builders::ListDatasetExamplesFluentBuilder {
        crate::operation::list_dataset_examples::builders::ListDatasetExamplesFluentBuilder::new(self.handle.clone())
    }
}