[smithy-rs] add: orchestrator design doc (#2543)

This document is intended to capture the philosophy and ideas
underpinning the current state of the orchestrator and should grow
alongside the orchestrator.

Abhinav requested something like this and I think it'll be helpful for
future people.

----

_By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice._

---------

Co-authored-by: John DiSanti <jdisanti@amazon.com>

Author: 2 people

sdk/backup/src/client.rs

@@ -1,15 +1,18 @@
 // Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
-impl super::Client  {
+impl super::Client {
     /// Constructs a fluent builder for the [`CancelLegalHold`](crate::operation::cancel_legal_hold::builders::CancelLegalHoldFluentBuilder) operation.
-                            ///
-                            /// - The fluent builder is configurable:
+    ///
+    /// - The fluent builder is configurable:
     ///   - [`legal_hold_id(impl Into<String>)`](crate::operation::cancel_legal_hold::builders::CancelLegalHoldFluentBuilder::legal_hold_id) / [`set_legal_hold_id(Option<String>)`](crate::operation::cancel_legal_hold::builders::CancelLegalHoldFluentBuilder::set_legal_hold_id): <p>Legal hold ID required to remove the specified legal hold on a recovery point.</p>
     ///   - [`cancel_description(impl Into<String>)`](crate::operation::cancel_legal_hold::builders::CancelLegalHoldFluentBuilder::cancel_description) / [`set_cancel_description(Option<String>)`](crate::operation::cancel_legal_hold::builders::CancelLegalHoldFluentBuilder::set_cancel_description): <p>String describing the reason for removing the legal hold.</p>
     ///   - [`retain_record_in_days(i64)`](crate::operation::cancel_legal_hold::builders::CancelLegalHoldFluentBuilder::retain_record_in_days) / [`set_retain_record_in_days(Option<i64>)`](crate::operation::cancel_legal_hold::builders::CancelLegalHoldFluentBuilder::set_retain_record_in_days): <p>The integer amount in days specifying amount of days after this API operation to remove legal hold.</p>
-                            /// - On success, responds with [`CancelLegalHoldOutput`](crate::operation::cancel_legal_hold::CancelLegalHoldOutput)
-                            /// - On failure, responds with [`SdkError<CancelLegalHoldError>`](crate::operation::cancel_legal_hold::CancelLegalHoldError)
-    pub fn cancel_legal_hold(&self) -> crate::operation::cancel_legal_hold::builders::CancelLegalHoldFluentBuilder {
-                                crate::operation::cancel_legal_hold::builders::CancelLegalHoldFluentBuilder::new(self.handle.clone())
-                            }
+    /// - On success, responds with [`CancelLegalHoldOutput`](crate::operation::cancel_legal_hold::CancelLegalHoldOutput)
+    /// - On failure, responds with [`SdkError<CancelLegalHoldError>`](crate::operation::cancel_legal_hold::CancelLegalHoldError)
+    pub fn cancel_legal_hold(
+        &self,
+    ) -> crate::operation::cancel_legal_hold::builders::CancelLegalHoldFluentBuilder {
+        crate::operation::cancel_legal_hold::builders::CancelLegalHoldFluentBuilder::new(
+            self.handle.clone(),
+        )
+    }
 }
-

sdk/backup/src/client/cancel_legal_hold.rs

@@ -1,20 +1,23 @@
 // Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
-impl super::Client  {
+impl super::Client {
     /// Constructs a fluent builder for the [`CreateBackupPlan`](crate::operation::create_backup_plan::builders::CreateBackupPlanFluentBuilder) operation.
-                            ///
-                            /// - The fluent builder is configurable:
+    ///
+    /// - The fluent builder is configurable:
     ///   - [`backup_plan(BackupPlanInput)`](crate::operation::create_backup_plan::builders::CreateBackupPlanFluentBuilder::backup_plan) / [`set_backup_plan(Option<BackupPlanInput>)`](crate::operation::create_backup_plan::builders::CreateBackupPlanFluentBuilder::set_backup_plan): <p>Specifies the body of a backup plan. Includes a <code>BackupPlanName</code> and one or more sets of <code>Rules</code>.</p>
     ///   - [`backup_plan_tags(HashMap<String, String>)`](crate::operation::create_backup_plan::builders::CreateBackupPlanFluentBuilder::backup_plan_tags) / [`set_backup_plan_tags(Option<HashMap<String, String>>)`](crate::operation::create_backup_plan::builders::CreateBackupPlanFluentBuilder::set_backup_plan_tags): <p>To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.</p>
     ///   - [`creator_request_id(impl Into<String>)`](crate::operation::create_backup_plan::builders::CreateBackupPlanFluentBuilder::creator_request_id) / [`set_creator_request_id(Option<String>)`](crate::operation::create_backup_plan::builders::CreateBackupPlanFluentBuilder::set_creator_request_id): <p>Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a <code>CreatorRequestId</code> that matches an existing backup plan, that plan is returned. This parameter is optional.</p>  <p>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</p>
-                            /// - On success, responds with [`CreateBackupPlanOutput`](crate::operation::create_backup_plan::CreateBackupPlanOutput) with field(s):
+    /// - On success, responds with [`CreateBackupPlanOutput`](crate::operation::create_backup_plan::CreateBackupPlanOutput) with field(s):
     ///   - [`backup_plan_id(Option<String>)`](crate::operation::create_backup_plan::CreateBackupPlanOutput::backup_plan_id): <p>Uniquely identifies a backup plan.</p>
     ///   - [`backup_plan_arn(Option<String>)`](crate::operation::create_backup_plan::CreateBackupPlanOutput::backup_plan_arn): <p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>
     ///   - [`creation_date(Option<DateTime>)`](crate::operation::create_backup_plan::CreateBackupPlanOutput::creation_date): <p>The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
     ///   - [`version_id(Option<String>)`](crate::operation::create_backup_plan::CreateBackupPlanOutput::version_id): <p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.</p>
     ///   - [`advanced_backup_settings(Option<Vec<AdvancedBackupSetting>>)`](crate::operation::create_backup_plan::CreateBackupPlanOutput::advanced_backup_settings): <p>A list of <code>BackupOptions</code> settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.</p>
-                            /// - On failure, responds with [`SdkError<CreateBackupPlanError>`](crate::operation::create_backup_plan::CreateBackupPlanError)
-    pub fn create_backup_plan(&self) -> crate::operation::create_backup_plan::builders::CreateBackupPlanFluentBuilder {
-                                crate::operation::create_backup_plan::builders::CreateBackupPlanFluentBuilder::new(self.handle.clone())
-                            }
+    /// - On failure, responds with [`SdkError<CreateBackupPlanError>`](crate::operation::create_backup_plan::CreateBackupPlanError)
+    pub fn create_backup_plan(
+        &self,
+    ) -> crate::operation::create_backup_plan::builders::CreateBackupPlanFluentBuilder {
+        crate::operation::create_backup_plan::builders::CreateBackupPlanFluentBuilder::new(
+            self.handle.clone(),
+        )
+    }
 }
-

sdk/backup/src/client/create_backup_plan.rs

@@ -1,18 +1,22 @@
 // Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
-impl super::Client  {
+impl super::Client {
     /// Constructs a fluent builder for the [`CreateBackupSelection`](crate::operation::create_backup_selection::builders::CreateBackupSelectionFluentBuilder) operation.
-                            ///
-                            /// - The fluent builder is configurable:
+    ///
+    /// - The fluent builder is configurable:
     ///   - [`backup_plan_id(impl Into<String>)`](crate::operation::create_backup_selection::builders::CreateBackupSelectionFluentBuilder::backup_plan_id) / [`set_backup_plan_id(Option<String>)`](crate::operation::create_backup_selection::builders::CreateBackupSelectionFluentBuilder::set_backup_plan_id): <p>Uniquely identifies the backup plan to be associated with the selection of resources.</p>
     ///   - [`backup_selection(BackupSelection)`](crate::operation::create_backup_selection::builders::CreateBackupSelectionFluentBuilder::backup_selection) / [`set_backup_selection(Option<BackupSelection>)`](crate::operation::create_backup_selection::builders::CreateBackupSelectionFluentBuilder::set_backup_selection): <p>Specifies the body of a request to assign a set of resources to a backup plan.</p>
     ///   - [`creator_request_id(impl Into<String>)`](crate::operation::create_backup_selection::builders::CreateBackupSelectionFluentBuilder::creator_request_id) / [`set_creator_request_id(Option<String>)`](crate::operation::create_backup_selection::builders::CreateBackupSelectionFluentBuilder::set_creator_request_id): <p>A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.</p>  <p>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</p>
-                            /// - On success, responds with [`CreateBackupSelectionOutput`](crate::operation::create_backup_selection::CreateBackupSelectionOutput) with field(s):
+    /// - On success, responds with [`CreateBackupSelectionOutput`](crate::operation::create_backup_selection::CreateBackupSelectionOutput) with field(s):
     ///   - [`selection_id(Option<String>)`](crate::operation::create_backup_selection::CreateBackupSelectionOutput::selection_id): <p>Uniquely identifies the body of a request to assign a set of resources to a backup plan.</p>
     ///   - [`backup_plan_id(Option<String>)`](crate::operation::create_backup_selection::CreateBackupSelectionOutput::backup_plan_id): <p>Uniquely identifies a backup plan.</p>
     ///   - [`creation_date(Option<DateTime>)`](crate::operation::create_backup_selection::CreateBackupSelectionOutput::creation_date): <p>The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
-                            /// - On failure, responds with [`SdkError<CreateBackupSelectionError>`](crate::operation::create_backup_selection::CreateBackupSelectionError)
-    pub fn create_backup_selection(&self) -> crate::operation::create_backup_selection::builders::CreateBackupSelectionFluentBuilder {
-                                crate::operation::create_backup_selection::builders::CreateBackupSelectionFluentBuilder::new(self.handle.clone())
-                            }
+    /// - On failure, responds with [`SdkError<CreateBackupSelectionError>`](crate::operation::create_backup_selection::CreateBackupSelectionError)
+    pub fn create_backup_selection(
+        &self,
+    ) -> crate::operation::create_backup_selection::builders::CreateBackupSelectionFluentBuilder
+    {
+        crate::operation::create_backup_selection::builders::CreateBackupSelectionFluentBuilder::new(
+            self.handle.clone(),
+        )
+    }
 }
-

sdk/backup/src/client/create_backup_selection.rs

@@ -1,19 +1,22 @@
 // Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
-impl super::Client  {
+impl super::Client {
     /// Constructs a fluent builder for the [`CreateBackupVault`](crate::operation::create_backup_vault::builders::CreateBackupVaultFluentBuilder) operation.
-                            ///
-                            /// - The fluent builder is configurable:
+    ///
+    /// - The fluent builder is configurable:
     ///   - [`backup_vault_name(impl Into<String>)`](crate::operation::create_backup_vault::builders::CreateBackupVaultFluentBuilder::backup_vault_name) / [`set_backup_vault_name(Option<String>)`](crate::operation::create_backup_vault::builders::CreateBackupVaultFluentBuilder::set_backup_vault_name): <p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.</p>
     ///   - [`backup_vault_tags(HashMap<String, String>)`](crate::operation::create_backup_vault::builders::CreateBackupVaultFluentBuilder::backup_vault_tags) / [`set_backup_vault_tags(Option<HashMap<String, String>>)`](crate::operation::create_backup_vault::builders::CreateBackupVaultFluentBuilder::set_backup_vault_tags): <p>Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.</p>
     ///   - [`encryption_key_arn(impl Into<String>)`](crate::operation::create_backup_vault::builders::CreateBackupVaultFluentBuilder::encryption_key_arn) / [`set_encryption_key_arn(Option<String>)`](crate::operation::create_backup_vault::builders::CreateBackupVaultFluentBuilder::set_encryption_key_arn): <p>The server-side encryption key that is used to protect your backups; for example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
     ///   - [`creator_request_id(impl Into<String>)`](crate::operation::create_backup_vault::builders::CreateBackupVaultFluentBuilder::creator_request_id) / [`set_creator_request_id(Option<String>)`](crate::operation::create_backup_vault::builders::CreateBackupVaultFluentBuilder::set_creator_request_id): <p>A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.</p>  <p>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</p>
-                            /// - On success, responds with [`CreateBackupVaultOutput`](crate::operation::create_backup_vault::CreateBackupVaultOutput) with field(s):
+    /// - On success, responds with [`CreateBackupVaultOutput`](crate::operation::create_backup_vault::CreateBackupVaultOutput) with field(s):
     ///   - [`backup_vault_name(Option<String>)`](crate::operation::create_backup_vault::CreateBackupVaultOutput::backup_vault_name): <p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>
     ///   - [`backup_vault_arn(Option<String>)`](crate::operation::create_backup_vault::CreateBackupVaultOutput::backup_vault_arn): <p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>
     ///   - [`creation_date(Option<DateTime>)`](crate::operation::create_backup_vault::CreateBackupVaultOutput::creation_date): <p>The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
-                            /// - On failure, responds with [`SdkError<CreateBackupVaultError>`](crate::operation::create_backup_vault::CreateBackupVaultError)
-    pub fn create_backup_vault(&self) -> crate::operation::create_backup_vault::builders::CreateBackupVaultFluentBuilder {
-                                crate::operation::create_backup_vault::builders::CreateBackupVaultFluentBuilder::new(self.handle.clone())
-                            }
+    /// - On failure, responds with [`SdkError<CreateBackupVaultError>`](crate::operation::create_backup_vault::CreateBackupVaultError)
+    pub fn create_backup_vault(
+        &self,
+    ) -> crate::operation::create_backup_vault::builders::CreateBackupVaultFluentBuilder {
+        crate::operation::create_backup_vault::builders::CreateBackupVaultFluentBuilder::new(
+            self.handle.clone(),
+        )
+    }
 }
-