aws_sdk_datasync/client/
describe_storage_system_resources.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeStorageSystemResources`](crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`discovery_job_arn(impl Into<String>)`](crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder::discovery_job_arn) / [`set_discovery_job_arn(Option<String>)`](crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder::set_discovery_job_arn):<br>required: **true**<br><p>Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from your on-premises storage system.</p><br>
    ///   - [`resource_type(DiscoveryResourceType)`](crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder::resource_type) / [`set_resource_type(Option<DiscoveryResourceType>)`](crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder::set_resource_type):<br>required: **true**<br><p>Specifies what kind of storage system resources that you want information about.</p><br>
    ///   - [`resource_ids(impl Into<String>)`](crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder::resource_ids) / [`set_resource_ids(Option<Vec::<String>>)`](crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder::set_resource_ids):<br>required: **false**<br><p>Specifies the universally unique identifiers (UUIDs) of the storage system resources that you want information about. You can't use this parameter in combination with the <code>Filter</code> parameter.</p><br>
    ///   - [`filter(DiscoveryResourceFilter, Vec::<String>)`](crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder::filter) / [`set_filter(Option<HashMap::<DiscoveryResourceFilter, Vec::<String>>>)`](crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder::set_filter):<br>required: **false**<br><p>Filters the storage system resources that you want returned. For example, this might be volumes associated with a specific storage virtual machine (SVM).</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder::set_max_results):<br>required: **false**<br><p>Specifies the maximum number of storage system resources that you want to list in a response.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder::set_next_token):<br>required: **false**<br><p>Specifies an opaque string that indicates the position to begin the next list of results in the response.</p><br>
    /// - On success, responds with [`DescribeStorageSystemResourcesOutput`](crate::operation::describe_storage_system_resources::DescribeStorageSystemResourcesOutput) with field(s):
    ///   - [`resource_details(Option<ResourceDetails>)`](crate::operation::describe_storage_system_resources::DescribeStorageSystemResourcesOutput::resource_details): <p>The information collected about your storage system's resources. A response can also include Amazon Web Services storage service recommendations.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-findings.html">storage resource information</a> collected by and <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">recommendations</a> provided by DataSync Discovery.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_storage_system_resources::DescribeStorageSystemResourcesOutput::next_token): <p>The opaque string that indicates the position to begin the next list of results in the response.</p>
    /// - On failure, responds with [`SdkError<DescribeStorageSystemResourcesError>`](crate::operation::describe_storage_system_resources::DescribeStorageSystemResourcesError)
    pub fn describe_storage_system_resources(
        &self,
    ) -> crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder {
        crate::operation::describe_storage_system_resources::builders::DescribeStorageSystemResourcesFluentBuilder::new(self.handle.clone())
    }
}