pub struct DescribeInstanceImageMetadataFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to DescribeInstanceImageMetadata
.
Describes the AMI that was used to launch an instance, even if the AMI is deprecated, deregistered, made private (no longer public or shared with your account), or not allowed.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance.
If you specify an instance ID that is not valid, an instance that doesn't exist, or an instance that you do not own, an error (InvalidInstanceID.NotFound
) is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
In the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected Availability Zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs that are in an unaffected Availability Zone, the call works normally.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Implementations§
Source§impl DescribeInstanceImageMetadataFluentBuilder
impl DescribeInstanceImageMetadataFluentBuilder
Sourcepub fn as_input(&self) -> &DescribeInstanceImageMetadataInputBuilder
pub fn as_input(&self) -> &DescribeInstanceImageMetadataInputBuilder
Access the DescribeInstanceImageMetadata as a reference.
Sourcepub async fn send(
self,
) -> Result<DescribeInstanceImageMetadataOutput, SdkError<DescribeInstanceImageMetadataError, HttpResponse>>
pub async fn send( self, ) -> Result<DescribeInstanceImageMetadataOutput, SdkError<DescribeInstanceImageMetadataError, 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<DescribeInstanceImageMetadataOutput, DescribeInstanceImageMetadataError, Self>
pub fn customize( self, ) -> CustomizableOperation<DescribeInstanceImageMetadataOutput, DescribeInstanceImageMetadataError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn into_paginator(self) -> DescribeInstanceImageMetadataPaginator
pub fn into_paginator(self) -> DescribeInstanceImageMetadataPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
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.
-
availability-zone
- The name of the Availability Zone (for example,us-west-2a
) or Local Zone (for example,us-west-2-lax-1b
) of the instance. -
instance-id
- The ID of the instance. -
image-allowed
- A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs. -
instance-state-name
- The state of the instance (pending
|running
|shutting-down
|terminated
|stopping
|stopped
). -
instance-type
- The type of instance (for example,t3.micro
). -
launch-time
- The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,2023-09-29T11:04:43.305Z
. You can use a wildcard (*
), for example,2023-09-29T*
, which matches an entire day. -
owner-alias
- The owner alias (amazon
|aws-marketplace
|aws-backup-vault
). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use theOwner
request parameter instead of this filter. -
owner-id
- The Amazon Web Services account ID of the owner. We recommend that you use theOwner
request parameter instead of this filter. -
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 assigned a tag with a specific key, regardless of the tag value. -
zone-id
- The ID of the Availability Zone (for example,usw2-az2
) or Local Zone (for example,usw2-lax1-az1
) of the instance.
Sourcepub fn set_filters(self, input: Option<Vec<Filter>>) -> Self
pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self
The filters.
-
availability-zone
- The name of the Availability Zone (for example,us-west-2a
) or Local Zone (for example,us-west-2-lax-1b
) of the instance. -
instance-id
- The ID of the instance. -
image-allowed
- A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs. -
instance-state-name
- The state of the instance (pending
|running
|shutting-down
|terminated
|stopping
|stopped
). -
instance-type
- The type of instance (for example,t3.micro
). -
launch-time
- The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,2023-09-29T11:04:43.305Z
. You can use a wildcard (*
), for example,2023-09-29T*
, which matches an entire day. -
owner-alias
- The owner alias (amazon
|aws-marketplace
|aws-backup-vault
). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use theOwner
request parameter instead of this filter. -
owner-id
- The Amazon Web Services account ID of the owner. We recommend that you use theOwner
request parameter instead of this filter. -
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 assigned a tag with a specific key, regardless of the tag value. -
zone-id
- The ID of the Availability Zone (for example,usw2-az2
) or Local Zone (for example,usw2-lax1-az1
) of the instance.
Sourcepub fn get_filters(&self) -> &Option<Vec<Filter>>
pub fn get_filters(&self) -> &Option<Vec<Filter>>
The filters.
-
availability-zone
- The name of the Availability Zone (for example,us-west-2a
) or Local Zone (for example,us-west-2-lax-1b
) of the instance. -
instance-id
- The ID of the instance. -
image-allowed
- A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs. -
instance-state-name
- The state of the instance (pending
|running
|shutting-down
|terminated
|stopping
|stopped
). -
instance-type
- The type of instance (for example,t3.micro
). -
launch-time
- The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,2023-09-29T11:04:43.305Z
. You can use a wildcard (*
), for example,2023-09-29T*
, which matches an entire day. -
owner-alias
- The owner alias (amazon
|aws-marketplace
|aws-backup-vault
). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use theOwner
request parameter instead of this filter. -
owner-id
- The Amazon Web Services account ID of the owner. We recommend that you use theOwner
request parameter instead of this filter. -
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 assigned a tag with a specific key, regardless of the tag value. -
zone-id
- The ID of the Availability Zone (for example,usw2-az2
) or Local Zone (for example,usw2-lax1-az1
) of the instance.
Sourcepub fn instance_ids(self, input: impl Into<String>) -> Self
pub fn instance_ids(self, input: impl Into<String>) -> Self
Appends an item to InstanceIds
.
To override the contents of this collection use set_instance_ids
.
The instance IDs.
If you don't specify an instance ID or filters, the output includes information for all instances.
Sourcepub fn set_instance_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_instance_ids(self, input: Option<Vec<String>>) -> Self
The instance IDs.
If you don't specify an instance ID or filters, the output includes information for all instances.
Sourcepub fn get_instance_ids(&self) -> &Option<Vec<String>>
pub fn get_instance_ids(&self) -> &Option<Vec<String>>
The instance IDs.
If you don't specify an instance ID or filters, the output includes information for all instances.
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.
Default: 1000
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.
Default: 1000
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.
Default: 1000
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 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
.
Trait Implementations§
Source§impl Clone for DescribeInstanceImageMetadataFluentBuilder
impl Clone for DescribeInstanceImageMetadataFluentBuilder
Source§fn clone(&self) -> DescribeInstanceImageMetadataFluentBuilder
fn clone(&self) -> DescribeInstanceImageMetadataFluentBuilder
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 DescribeInstanceImageMetadataFluentBuilder
impl !RefUnwindSafe for DescribeInstanceImageMetadataFluentBuilder
impl Send for DescribeInstanceImageMetadataFluentBuilder
impl Sync for DescribeInstanceImageMetadataFluentBuilder
impl Unpin for DescribeInstanceImageMetadataFluentBuilder
impl !UnwindSafe for DescribeInstanceImageMetadataFluentBuilder
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);