aws_sdk_wellarchitected/client/
list_workload_shares.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 [`ListWorkloadShares`](crate::operation::list_workload_shares::builders::ListWorkloadSharesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_workload_shares::builders::ListWorkloadSharesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`workload_id(impl Into<String>)`](crate::operation::list_workload_shares::builders::ListWorkloadSharesFluentBuilder::workload_id) / [`set_workload_id(Option<String>)`](crate::operation::list_workload_shares::builders::ListWorkloadSharesFluentBuilder::set_workload_id):<br>required: **true**<br><p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p><br>
8    ///   - [`shared_with_prefix(impl Into<String>)`](crate::operation::list_workload_shares::builders::ListWorkloadSharesFluentBuilder::shared_with_prefix) / [`set_shared_with_prefix(Option<String>)`](crate::operation::list_workload_shares::builders::ListWorkloadSharesFluentBuilder::set_shared_with_prefix):<br>required: **false**<br><p>The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload is shared.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_workload_shares::builders::ListWorkloadSharesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_workload_shares::builders::ListWorkloadSharesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to retrieve the next set of results.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_workload_shares::builders::ListWorkloadSharesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_workload_shares::builders::ListWorkloadSharesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return for this request.</p><br>
11    ///   - [`status(ShareStatus)`](crate::operation::list_workload_shares::builders::ListWorkloadSharesFluentBuilder::status) / [`set_status(Option<ShareStatus>)`](crate::operation::list_workload_shares::builders::ListWorkloadSharesFluentBuilder::set_status):<br>required: **false**<br><p>The status of the share request.</p><br>
12    /// - On success, responds with [`ListWorkloadSharesOutput`](crate::operation::list_workload_shares::ListWorkloadSharesOutput) with field(s):
13    ///   - [`workload_id(Option<String>)`](crate::operation::list_workload_shares::ListWorkloadSharesOutput::workload_id): <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
14    ///   - [`workload_share_summaries(Option<Vec::<WorkloadShareSummary>>)`](crate::operation::list_workload_shares::ListWorkloadSharesOutput::workload_share_summaries): <p>A list of workload share summaries.</p>
15    ///   - [`next_token(Option<String>)`](crate::operation::list_workload_shares::ListWorkloadSharesOutput::next_token): <p>The token to use to retrieve the next set of results.</p>
16    /// - On failure, responds with [`SdkError<ListWorkloadSharesError>`](crate::operation::list_workload_shares::ListWorkloadSharesError)
17    pub fn list_workload_shares(&self) -> crate::operation::list_workload_shares::builders::ListWorkloadSharesFluentBuilder {
18        crate::operation::list_workload_shares::builders::ListWorkloadSharesFluentBuilder::new(self.handle.clone())
19    }
20}