aws_sdk_migrationhub/client/put_resource_attributes.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 [`PutResourceAttributes`](crate::operation::put_resource_attributes::builders::PutResourceAttributesFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`progress_update_stream(impl Into<String>)`](crate::operation::put_resource_attributes::builders::PutResourceAttributesFluentBuilder::progress_update_stream) / [`set_progress_update_stream(Option<String>)`](crate::operation::put_resource_attributes::builders::PutResourceAttributesFluentBuilder::set_progress_update_stream):<br>required: **true**<br><p>The name of the ProgressUpdateStream.</p><br>
7 /// - [`migration_task_name(impl Into<String>)`](crate::operation::put_resource_attributes::builders::PutResourceAttributesFluentBuilder::migration_task_name) / [`set_migration_task_name(Option<String>)`](crate::operation::put_resource_attributes::builders::PutResourceAttributesFluentBuilder::set_migration_task_name):<br>required: **true**<br><p>Unique identifier that references the migration task. <i>Do not store personal data in this field.</i></p><br>
8 /// - [`resource_attribute_list(ResourceAttribute)`](crate::operation::put_resource_attributes::builders::PutResourceAttributesFluentBuilder::resource_attribute_list) / [`set_resource_attribute_list(Option<Vec::<ResourceAttribute>>)`](crate::operation::put_resource_attributes::builders::PutResourceAttributesFluentBuilder::set_resource_attribute_list):<br>required: **true**<br><p>Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service repository.</p><note> <p>Takes the object array of <code>ResourceAttribute</code> where the <code>Type</code> field is reserved for the following values: <code>IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER</code> where the identifying value can be a string up to 256 characters.</p> </note> <important> <ul> <li> <p>If any "VM" related value is set for a <code>ResourceAttribute</code> object, it is required that <code>VM_MANAGER_ID</code>, as a minimum, is always set. If <code>VM_MANAGER_ID</code> is not set, then all "VM" fields will be discarded and "VM" fields will not be used for matching the migration task to a server in Application Discovery Service repository. See the <a href="https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#API_PutResourceAttributes_Examples">Example</a> section below for a use case of specifying "VM" related values.</p></li> <li> <p>If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the <code>ResourceAttributeList</code> parameter to maximize the chances of matching.</p></li> </ul> </important><br>
9 /// - [`dry_run(bool)`](crate::operation::put_resource_attributes::builders::PutResourceAttributesFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::put_resource_attributes::builders::PutResourceAttributesFluentBuilder::set_dry_run):<br>required: **false**<br><p>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.</p><br>
10 /// - On success, responds with [`PutResourceAttributesOutput`](crate::operation::put_resource_attributes::PutResourceAttributesOutput)
11 /// - On failure, responds with [`SdkError<PutResourceAttributesError>`](crate::operation::put_resource_attributes::PutResourceAttributesError)
12 pub fn put_resource_attributes(&self) -> crate::operation::put_resource_attributes::builders::PutResourceAttributesFluentBuilder {
13 crate::operation::put_resource_attributes::builders::PutResourceAttributesFluentBuilder::new(self.handle.clone())
14 }
15}