aws_sdk_bedrockagentcorecontrol/client/
get_dataset.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetDataset`](crate::operation::get_dataset::builders::GetDatasetFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`dataset_id(impl Into<String>)`](crate::operation::get_dataset::builders::GetDatasetFluentBuilder::dataset_id) / [`set_dataset_id(Option<String>)`](crate::operation::get_dataset::builders::GetDatasetFluentBuilder::set_dataset_id):<br>required: **true**<br><p>The unique identifier of the dataset to retrieve.</p><br>
7    ///   - [`dataset_version(impl Into<String>)`](crate::operation::get_dataset::builders::GetDatasetFluentBuilder::dataset_version) / [`set_dataset_version(Option<String>)`](crate::operation::get_dataset::builders::GetDatasetFluentBuilder::set_dataset_version):<br>required: **false**<br><p>Version to retrieve: "DRAFT" or a version number. Defaults to DRAFT if absent.</p><br>
8    /// - On success, responds with [`GetDatasetOutput`](crate::operation::get_dataset::GetDatasetOutput) with field(s):
9    ///   - [`dataset_arn(String)`](crate::operation::get_dataset::GetDatasetOutput::dataset_arn): <p>The Amazon Resource Name (ARN) of the dataset.</p>
10    ///   - [`dataset_id(String)`](crate::operation::get_dataset::GetDatasetOutput::dataset_id): <p>The unique identifier of the dataset.</p>
11    ///   - [`dataset_version(String)`](crate::operation::get_dataset::GetDatasetOutput::dataset_version): <p>The resolved version: "DRAFT" (default) or the requested version number.</p>
12    ///   - [`dataset_name(String)`](crate::operation::get_dataset::GetDatasetOutput::dataset_name): <p>The name of the dataset.</p>
13    ///   - [`description(Option<String>)`](crate::operation::get_dataset::GetDatasetOutput::description): <p>The description of the dataset.</p>
14    ///   - [`status(DatasetStatus)`](crate::operation::get_dataset::GetDatasetOutput::status): <p>The current status of the dataset.</p>
15    ///   - [`draft_status(Option<DraftStatus>)`](crate::operation::get_dataset::GetDatasetOutput::draft_status): <p>Publish synchronization state. Only authoritative when status is ACTIVE. MODIFIED indicates DRAFT has unpublished changes. UNMODIFIED indicates DRAFT matches the latest published version.</p>
16    ///   - [`failure_reason(Option<String>)`](crate::operation::get_dataset::GetDatasetOutput::failure_reason): <p>Populated when status is CREATE_FAILED, UPDATE_FAILED, or DELETE_FAILED. Describes the reason for the failure.</p>
17    ///   - [`schema_type(DatasetSchemaType)`](crate::operation::get_dataset::GetDatasetOutput::schema_type): <p>The schema type declared at create time. Immutable after creation.</p>
18    ///   - [`kms_key_arn(Option<String>)`](crate::operation::get_dataset::GetDatasetOutput::kms_key_arn): <p>KMS key ARN used for server-side encryption on service Amazon S3 writes, if configured.</p>
19    ///   - [`example_count(i64)`](crate::operation::get_dataset::GetDatasetOutput::example_count): <p>The number of examples in the DRAFT.</p>
20    ///   - [`download_url(Option<String>)`](crate::operation::get_dataset::GetDatasetOutput::download_url): <p>Presigned Amazon S3 URL to download the consolidated dataset file for the resolved version. Expires after 5 minutes. Omitted if the file does not yet exist.</p>
21    ///   - [`download_url_expires_at(Option<DateTime>)`](crate::operation::get_dataset::GetDatasetOutput::download_url_expires_at): <p>Expiry timestamp for the download URL.</p>
22    ///   - [`created_at(DateTime)`](crate::operation::get_dataset::GetDatasetOutput::created_at): <p>The timestamp when the dataset was created.</p>
23    ///   - [`updated_at(DateTime)`](crate::operation::get_dataset::GetDatasetOutput::updated_at): <p>The timestamp when the dataset was last updated.</p>
24    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_dataset::GetDatasetOutput::tags): <p>The tags associated with the dataset.</p>
25    /// - On failure, responds with [`SdkError<GetDatasetError>`](crate::operation::get_dataset::GetDatasetError)
26    pub fn get_dataset(&self) -> crate::operation::get_dataset::builders::GetDatasetFluentBuilder {
27        crate::operation::get_dataset::builders::GetDatasetFluentBuilder::new(self.handle.clone())
28    }
29}
aws_sdk_bedrockagentcorecontrol/client/get_dataset.rs

aws_sdk_bedrockagentcorecontrol/client/
get_dataset.rs
