aws_sdk_medicalimaging/client/
update_image_set_metadata.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 [`UpdateImageSetMetadata`](crate::operation::update_image_set_metadata::builders::UpdateImageSetMetadataFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`datastore_id(impl Into<String>)`](crate::operation::update_image_set_metadata::builders::UpdateImageSetMetadataFluentBuilder::datastore_id) / [`set_datastore_id(Option<String>)`](crate::operation::update_image_set_metadata::builders::UpdateImageSetMetadataFluentBuilder::set_datastore_id):<br>required: **true**<br><p>The data store identifier.</p><br>
7    ///   - [`image_set_id(impl Into<String>)`](crate::operation::update_image_set_metadata::builders::UpdateImageSetMetadataFluentBuilder::image_set_id) / [`set_image_set_id(Option<String>)`](crate::operation::update_image_set_metadata::builders::UpdateImageSetMetadataFluentBuilder::set_image_set_id):<br>required: **true**<br><p>The image set identifier.</p><br>
8    ///   - [`latest_version_id(impl Into<String>)`](crate::operation::update_image_set_metadata::builders::UpdateImageSetMetadataFluentBuilder::latest_version_id) / [`set_latest_version_id(Option<String>)`](crate::operation::update_image_set_metadata::builders::UpdateImageSetMetadataFluentBuilder::set_latest_version_id):<br>required: **true**<br><p>The latest image set version identifier.</p><br>
9    ///   - [`force(bool)`](crate::operation::update_image_set_metadata::builders::UpdateImageSetMetadataFluentBuilder::force) / [`set_force(Option<bool>)`](crate::operation::update_image_set_metadata::builders::UpdateImageSetMetadataFluentBuilder::set_force):<br>required: **false**<br><p>Setting this flag will force the <code>UpdateImageSetMetadata</code> operation for the following attributes:</p> <ul>  <li>   <p><code>Tag.StudyInstanceUID</code>, <code>Tag.SeriesInstanceUID</code>, <code>Tag.SOPInstanceUID</code>, and <code>Tag.StudyID</code></p></li>  <li>   <p>Adding, removing, or updating private tags for an individual SOP Instance</p></li> </ul><br>
10    ///   - [`update_image_set_metadata_updates(MetadataUpdates)`](crate::operation::update_image_set_metadata::builders::UpdateImageSetMetadataFluentBuilder::update_image_set_metadata_updates) / [`set_update_image_set_metadata_updates(Option<MetadataUpdates>)`](crate::operation::update_image_set_metadata::builders::UpdateImageSetMetadataFluentBuilder::set_update_image_set_metadata_updates):<br>required: **true**<br><p>Update image set metadata updates.</p><br>
11    /// - On success, responds with [`UpdateImageSetMetadataOutput`](crate::operation::update_image_set_metadata::UpdateImageSetMetadataOutput) with field(s):
12    ///   - [`datastore_id(String)`](crate::operation::update_image_set_metadata::UpdateImageSetMetadataOutput::datastore_id): <p>The data store identifier.</p>
13    ///   - [`image_set_id(String)`](crate::operation::update_image_set_metadata::UpdateImageSetMetadataOutput::image_set_id): <p>The image set identifier.</p>
14    ///   - [`latest_version_id(String)`](crate::operation::update_image_set_metadata::UpdateImageSetMetadataOutput::latest_version_id): <p>The latest image set version identifier.</p>
15    ///   - [`image_set_state(ImageSetState)`](crate::operation::update_image_set_metadata::UpdateImageSetMetadataOutput::image_set_state): <p>The image set state.</p>
16    ///   - [`image_set_workflow_status(Option<ImageSetWorkflowStatus>)`](crate::operation::update_image_set_metadata::UpdateImageSetMetadataOutput::image_set_workflow_status): <p>The image set workflow status.</p>
17    ///   - [`created_at(Option<DateTime>)`](crate::operation::update_image_set_metadata::UpdateImageSetMetadataOutput::created_at): <p>The timestamp when image set metadata was created.</p>
18    ///   - [`updated_at(Option<DateTime>)`](crate::operation::update_image_set_metadata::UpdateImageSetMetadataOutput::updated_at): <p>The timestamp when image set metadata was updated.</p>
19    ///   - [`message(Option<String>)`](crate::operation::update_image_set_metadata::UpdateImageSetMetadataOutput::message): <p>The error message thrown if an update image set metadata action fails.</p>
20    /// - On failure, responds with [`SdkError<UpdateImageSetMetadataError>`](crate::operation::update_image_set_metadata::UpdateImageSetMetadataError)
21    pub fn update_image_set_metadata(&self) -> crate::operation::update_image_set_metadata::builders::UpdateImageSetMetadataFluentBuilder {
22        crate::operation::update_image_set_metadata::builders::UpdateImageSetMetadataFluentBuilder::new(self.handle.clone())
23    }
24}