#[non_exhaustive]pub struct DescribePlacementGroupsInput {
pub group_ids: Option<Vec<String>>,
pub dry_run: Option<bool>,
pub group_names: Option<Vec<String>>,
pub filters: Option<Vec<Filter>>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.group_ids: Option<Vec<String>>
The IDs of the placement groups.
dry_run: Option<bool>
Checks whether you have the required permissions for the operation, 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
.
group_names: Option<Vec<String>>
The names of the placement groups.
Constraints:
-
You can specify a name only if the placement group is owned by your account.
-
If a placement group is shared with your account, specifying the name results in an error. You must use the
GroupId
parameter instead.
filters: Option<Vec<Filter>>
The filters.
-
group-name
- The name of the placement group. -
group-arn
- The Amazon Resource Name (ARN) of the placement group. -
spread-level
- The spread level for the placement group (host
|rack
). -
state
- The state of the placement group (pending
|available
|deleting
|deleted
). -
strategy
- The strategy of the placement group (cluster
|spread
|partition
). -
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
Implementations§
Source§impl DescribePlacementGroupsInput
impl DescribePlacementGroupsInput
Sourcepub fn group_ids(&self) -> &[String]
pub fn group_ids(&self) -> &[String]
The IDs of the placement groups.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .group_ids.is_none()
.
Sourcepub fn dry_run(&self) -> Option<bool>
pub fn dry_run(&self) -> Option<bool>
Checks whether you have the required permissions for the operation, 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 group_names(&self) -> &[String]
pub fn group_names(&self) -> &[String]
The names of the placement groups.
Constraints:
-
You can specify a name only if the placement group is owned by your account.
-
If a placement group is shared with your account, specifying the name results in an error. You must use the
GroupId
parameter instead.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .group_names.is_none()
.
Sourcepub fn filters(&self) -> &[Filter]
pub fn filters(&self) -> &[Filter]
The filters.
-
group-name
- The name of the placement group. -
group-arn
- The Amazon Resource Name (ARN) of the placement group. -
spread-level
- The spread level for the placement group (host
|rack
). -
state
- The state of the placement group (pending
|available
|deleting
|deleted
). -
strategy
- The strategy of the placement group (cluster
|spread
|partition
). -
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .filters.is_none()
.
Source§impl DescribePlacementGroupsInput
impl DescribePlacementGroupsInput
Sourcepub fn builder() -> DescribePlacementGroupsInputBuilder
pub fn builder() -> DescribePlacementGroupsInputBuilder
Creates a new builder-style object to manufacture DescribePlacementGroupsInput
.
Trait Implementations§
Source§impl Clone for DescribePlacementGroupsInput
impl Clone for DescribePlacementGroupsInput
Source§fn clone(&self) -> DescribePlacementGroupsInput
fn clone(&self) -> DescribePlacementGroupsInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DescribePlacementGroupsInput
impl Debug for DescribePlacementGroupsInput
Source§impl PartialEq for DescribePlacementGroupsInput
impl PartialEq for DescribePlacementGroupsInput
Source§fn eq(&self, other: &DescribePlacementGroupsInput) -> bool
fn eq(&self, other: &DescribePlacementGroupsInput) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for DescribePlacementGroupsInput
Auto Trait Implementations§
impl Freeze for DescribePlacementGroupsInput
impl RefUnwindSafe for DescribePlacementGroupsInput
impl Send for DescribePlacementGroupsInput
impl Sync for DescribePlacementGroupsInput
impl Unpin for DescribePlacementGroupsInput
impl UnwindSafe for DescribePlacementGroupsInput
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);