aws_sdk_directory/client/
describe_snapshots.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 [`DescribeSnapshots`](crate::operation::describe_snapshots::builders::DescribeSnapshotsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_snapshots::builders::DescribeSnapshotsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`directory_id(impl Into<String>)`](crate::operation::describe_snapshots::builders::DescribeSnapshotsFluentBuilder::directory_id) / [`set_directory_id(Option<String>)`](crate::operation::describe_snapshots::builders::DescribeSnapshotsFluentBuilder::set_directory_id):<br>required: **false**<br><p>The identifier of the directory for which to retrieve snapshot information.</p><br>
8    ///   - [`snapshot_ids(impl Into<String>)`](crate::operation::describe_snapshots::builders::DescribeSnapshotsFluentBuilder::snapshot_ids) / [`set_snapshot_ids(Option<Vec::<String>>)`](crate::operation::describe_snapshots::builders::DescribeSnapshotsFluentBuilder::set_snapshot_ids):<br>required: **false**<br><p>A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the <i>Limit</i> and <i>NextToken</i> members.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_snapshots::builders::DescribeSnapshotsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_snapshots::builders::DescribeSnapshotsFluentBuilder::set_next_token):<br>required: **false**<br><p>The <i>DescribeSnapshotsResult.NextToken</i> value from a previous call to <code>DescribeSnapshots</code>. Pass null if this is the first call.</p><br>
10    ///   - [`limit(i32)`](crate::operation::describe_snapshots::builders::DescribeSnapshotsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::describe_snapshots::builders::DescribeSnapshotsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of objects to return.</p><br>
11    /// - On success, responds with [`DescribeSnapshotsOutput`](crate::operation::describe_snapshots::DescribeSnapshotsOutput) with field(s):
12    ///   - [`snapshots(Option<Vec::<Snapshot>>)`](crate::operation::describe_snapshots::DescribeSnapshotsOutput::snapshots): <p>The list of <code>Snapshot</code> objects that were retrieved.</p> <p>It is possible that this list contains less than the number of items specified in the <i>Limit</i> member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::describe_snapshots::DescribeSnapshotsOutput::next_token): <p>If not null, more results are available. Pass this value in the <i>NextToken</i> member of a subsequent call to <code>DescribeSnapshots</code>.</p>
14    /// - On failure, responds with [`SdkError<DescribeSnapshotsError>`](crate::operation::describe_snapshots::DescribeSnapshotsError)
15    pub fn describe_snapshots(&self) -> crate::operation::describe_snapshots::builders::DescribeSnapshotsFluentBuilder {
16        crate::operation::describe_snapshots::builders::DescribeSnapshotsFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_directory/client/describe_snapshots.rs

aws_sdk_directory/client/
describe_snapshots.rs
