aws_sdk_wellarchitected/client/
create_workload.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateWorkload`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`workload_name(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::workload_name) / [`set_workload_name(Option<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_workload_name):<br>required: **true**<br><p>The name of the workload.</p> <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_description):<br>required: **true**<br><p>The description for the workload.</p><br>
    ///   - [`environment(WorkloadEnvironment)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::environment) / [`set_environment(Option<WorkloadEnvironment>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_environment):<br>required: **true**<br><p>The environment for the workload.</p><br>
    ///   - [`account_ids(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::account_ids) / [`set_account_ids(Option<Vec::<String>>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_account_ids):<br>required: **false**<br><p>The list of Amazon Web Services account IDs associated with the workload.</p><br>
    ///   - [`aws_regions(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::aws_regions) / [`set_aws_regions(Option<Vec::<String>>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_aws_regions):<br>required: **false**<br><p>The list of Amazon Web Services Regions associated with the workload, for example, <code>us-east-2</code>, or <code>ca-central-1</code>.</p><br>
    ///   - [`non_aws_regions(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::non_aws_regions) / [`set_non_aws_regions(Option<Vec::<String>>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_non_aws_regions):<br>required: **false**<br><p>The list of non-Amazon Web Services Regions associated with the workload.</p><br>
    ///   - [`pillar_priorities(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::pillar_priorities) / [`set_pillar_priorities(Option<Vec::<String>>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_pillar_priorities):<br>required: **false**<br><p>The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its <code>PillarReviewSummary$PillarId</code>.</p><br>
    ///   - [`architectural_design(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::architectural_design) / [`set_architectural_design(Option<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_architectural_design):<br>required: **false**<br><p>The URL of the architectural design for the workload.</p><br>
    ///   - [`review_owner(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::review_owner) / [`set_review_owner(Option<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_review_owner):<br>required: **false**<br><p>The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.</p><br>
    ///   - [`industry_type(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::industry_type) / [`set_industry_type(Option<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_industry_type):<br>required: **false**<br><p>The industry type for the workload.</p> <p>If specified, must be one of the following:</p> <ul>  <li>   <p><code>Agriculture</code></p></li>  <li>   <p><code>Automobile</code></p></li>  <li>   <p><code>Defense</code></p></li>  <li>   <p><code>Design and Engineering</code></p></li>  <li>   <p><code>Digital Advertising</code></p></li>  <li>   <p><code>Education</code></p></li>  <li>   <p><code>Environmental Protection</code></p></li>  <li>   <p><code>Financial Services</code></p></li>  <li>   <p><code>Gaming</code></p></li>  <li>   <p><code>General Public Services</code></p></li>  <li>   <p><code>Healthcare</code></p></li>  <li>   <p><code>Hospitality</code></p></li>  <li>   <p><code>InfoTech</code></p></li>  <li>   <p><code>Justice and Public Safety</code></p></li>  <li>   <p><code>Life Sciences</code></p></li>  <li>   <p><code>Manufacturing</code></p></li>  <li>   <p><code>Media &amp; Entertainment</code></p></li>  <li>   <p><code>Mining &amp; Resources</code></p></li>  <li>   <p><code>Oil &amp; Gas</code></p></li>  <li>   <p><code>Power &amp; Utilities</code></p></li>  <li>   <p><code>Professional Services</code></p></li>  <li>   <p><code>Real Estate &amp; Construction</code></p></li>  <li>   <p><code>Retail &amp; Wholesale</code></p></li>  <li>   <p><code>Social Protection</code></p></li>  <li>   <p><code>Telecommunications</code></p></li>  <li>   <p><code>Travel, Transportation &amp; Logistics</code></p></li>  <li>   <p><code>Other</code></p></li> </ul><br>
    ///   - [`industry(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::industry) / [`set_industry(Option<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_industry):<br>required: **false**<br><p>The industry for the workload.</p><br>
    ///   - [`lenses(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::lenses) / [`set_lenses(Option<Vec::<String>>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_lenses):<br>required: **true**<br><p>The list of lenses associated with the workload. Each lens is identified by its <code>LensSummary$LensAlias</code>.</p> <p>If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.</p><br>
    ///   - [`notes(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::notes) / [`set_notes(Option<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_notes):<br>required: **false**<br><p>The notes associated with the workload.</p> <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p><br>
    ///   - [`client_request_token(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_client_request_token):<br>required: **true**<br><p>A unique case-sensitive string used to ensure that this request is idempotent (executes only once).</p> <p>You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.</p><important>  <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.</p> </important><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_tags):<br>required: **false**<br><p>The tags to be associated with the workload.</p><br>
    ///   - [`discovery_config(WorkloadDiscoveryConfig)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::discovery_config) / [`set_discovery_config(Option<WorkloadDiscoveryConfig>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_discovery_config):<br>required: **false**<br><p>Well-Architected discovery configuration settings associated to the workload.</p><br>
    ///   - [`applications(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::applications) / [`set_applications(Option<Vec::<String>>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_applications):<br>required: **false**<br><p>List of AppRegistry application ARNs associated to the workload.</p><br>
    ///   - [`profile_arns(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::profile_arns) / [`set_profile_arns(Option<Vec::<String>>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_profile_arns):<br>required: **false**<br><p>The list of profile ARNs associated with the workload.</p><br>
    ///   - [`review_template_arns(impl Into<String>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::review_template_arns) / [`set_review_template_arns(Option<Vec::<String>>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_review_template_arns):<br>required: **false**<br><p>The list of review template ARNs to associate with the workload.</p><br>
    ///   - [`jira_configuration(WorkloadJiraConfigurationInput)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::jira_configuration) / [`set_jira_configuration(Option<WorkloadJiraConfigurationInput>)`](crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::set_jira_configuration):<br>required: **false**<br><p>Jira configuration settings when creating a workload.</p><br>
    /// - On success, responds with [`CreateWorkloadOutput`](crate::operation::create_workload::CreateWorkloadOutput) with field(s):
    ///   - [`workload_id(Option<String>)`](crate::operation::create_workload::CreateWorkloadOutput::workload_id): <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
    ///   - [`workload_arn(Option<String>)`](crate::operation::create_workload::CreateWorkloadOutput::workload_arn): <p>The ARN for the workload.</p>
    /// - On failure, responds with [`SdkError<CreateWorkloadError>`](crate::operation::create_workload::CreateWorkloadError)
    pub fn create_workload(&self) -> crate::operation::create_workload::builders::CreateWorkloadFluentBuilder {
        crate::operation::create_workload::builders::CreateWorkloadFluentBuilder::new(self.handle.clone())
    }
}