pub struct DescribeSnapshotsFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to DescribeSnapshots.
Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
-
public: The owner of the snapshot granted create volume permissions for the snapshot to the
allgroup. All Amazon Web Services accounts have create volume permissions for these snapshots. -
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
-
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
Implementations§
Source§impl DescribeSnapshotsFluentBuilder
impl DescribeSnapshotsFluentBuilder
Sourcepub fn as_input(&self) -> &DescribeSnapshotsInputBuilder
pub fn as_input(&self) -> &DescribeSnapshotsInputBuilder
Access the DescribeSnapshots as a reference.
Sourcepub async fn send(
self,
) -> Result<DescribeSnapshotsOutput, SdkError<DescribeSnapshotsError, HttpResponse>>
pub async fn send( self, ) -> Result<DescribeSnapshotsOutput, SdkError<DescribeSnapshotsError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<DescribeSnapshotsOutput, DescribeSnapshotsError, Self>
pub fn customize( self, ) -> CustomizableOperation<DescribeSnapshotsOutput, DescribeSnapshotsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn into_paginator(self) -> DescribeSnapshotsPaginator
pub fn into_paginator(self) -> DescribeSnapshotsPaginator
Create a paginator for this request
Paginators are used by calling send().await which returns a PaginationStream.
Sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
Sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
Sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
Sourcepub fn owner_ids(self, input: impl Into<String>) -> Self
pub fn owner_ids(self, input: impl Into<String>) -> Self
Appends an item to OwnerIds.
To override the contents of this collection use set_owner_ids.
Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.
Sourcepub fn set_owner_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_owner_ids(self, input: Option<Vec<String>>) -> Self
Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.
Sourcepub fn get_owner_ids(&self) -> &Option<Vec<String>>
pub fn get_owner_ids(&self) -> &Option<Vec<String>>
Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.
Sourcepub fn restorable_by_user_ids(self, input: impl Into<String>) -> Self
pub fn restorable_by_user_ids(self, input: impl Into<String>) -> Self
Appends an item to RestorableByUserIds.
To override the contents of this collection use set_restorable_by_user_ids.
The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
Sourcepub fn set_restorable_by_user_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_restorable_by_user_ids(self, input: Option<Vec<String>>) -> Self
The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
Sourcepub fn get_restorable_by_user_ids(&self) -> &Option<Vec<String>>
pub fn get_restorable_by_user_ids(&self) -> &Option<Vec<String>>
The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
Sourcepub fn snapshot_ids(self, input: impl Into<String>) -> Self
pub fn snapshot_ids(self, input: impl Into<String>) -> Self
Appends an item to SnapshotIds.
To override the contents of this collection use set_snapshot_ids.
The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
Sourcepub fn set_snapshot_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_snapshot_ids(self, input: Option<Vec<String>>) -> Self
The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
Sourcepub fn get_snapshot_ids(&self) -> &Option<Vec<String>>
pub fn get_snapshot_ids(&self) -> &Option<Vec<String>>
The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
Sourcepub fn dry_run(self, input: bool) -> Self
pub fn dry_run(self, input: bool) -> Self
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Sourcepub fn set_dry_run(self, input: Option<bool>) -> Self
pub fn set_dry_run(self, input: Option<bool>) -> Self
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Sourcepub fn get_dry_run(&self) -> &Option<bool>
pub fn get_dry_run(&self) -> &Option<bool>
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Sourcepub fn filters(self, input: Filter) -> Self
pub fn filters(self, input: Filter) -> Self
Appends an item to Filters.
To override the contents of this collection use set_filters.
The filters.
-
description- A description of the snapshot. -
encrypted- Indicates whether the snapshot is encrypted (true|false) -
owner-alias- The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. -
owner-id- The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter. -
progress- The progress of the snapshot, as a percentage (for example, 80%). -
snapshot-id- The snapshot ID. -
start-time- The time stamp when the snapshot was initiated. -
status- The status of the snapshot (pending|completed|error). -
storage-tier- The storage tier of the snapshot (archive|standard). -
transfer-type- The type of operation used to create the snapshot (time-based|standard). -
tag:- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Ownerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value. -
tag-key- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
volume-id- The ID of the volume the snapshot is for. -
volume-size- The size of the volume, in GiB.
Sourcepub fn set_filters(self, input: Option<Vec<Filter>>) -> Self
pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self
The filters.
-
description- A description of the snapshot. -
encrypted- Indicates whether the snapshot is encrypted (true|false) -
owner-alias- The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. -
owner-id- The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter. -
progress- The progress of the snapshot, as a percentage (for example, 80%). -
snapshot-id- The snapshot ID. -
start-time- The time stamp when the snapshot was initiated. -
status- The status of the snapshot (pending|completed|error). -
storage-tier- The storage tier of the snapshot (archive|standard). -
transfer-type- The type of operation used to create the snapshot (time-based|standard). -
tag:- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Ownerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value. -
tag-key- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
volume-id- The ID of the volume the snapshot is for. -
volume-size- The size of the volume, in GiB.
Sourcepub fn get_filters(&self) -> &Option<Vec<Filter>>
pub fn get_filters(&self) -> &Option<Vec<Filter>>
The filters.
-
description- A description of the snapshot. -
encrypted- Indicates whether the snapshot is encrypted (true|false) -
owner-alias- The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. -
owner-id- The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter. -
progress- The progress of the snapshot, as a percentage (for example, 80%). -
snapshot-id- The snapshot ID. -
start-time- The time stamp when the snapshot was initiated. -
status- The status of the snapshot (pending|completed|error). -
storage-tier- The storage tier of the snapshot (archive|standard). -
transfer-type- The type of operation used to create the snapshot (time-based|standard). -
tag:- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Ownerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value. -
tag-key- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
volume-id- The ID of the volume the snapshot is for. -
volume-size- The size of the volume, in GiB.
Trait Implementations§
Source§impl Clone for DescribeSnapshotsFluentBuilder
impl Clone for DescribeSnapshotsFluentBuilder
Source§fn clone(&self) -> DescribeSnapshotsFluentBuilder
fn clone(&self) -> DescribeSnapshotsFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for DescribeSnapshotsFluentBuilder
impl !RefUnwindSafe for DescribeSnapshotsFluentBuilder
impl Send for DescribeSnapshotsFluentBuilder
impl Sync for DescribeSnapshotsFluentBuilder
impl Unpin for DescribeSnapshotsFluentBuilder
impl !UnwindSafe for DescribeSnapshotsFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);