Struct aws_sdk_ec2::client::fluent_builders::DescribeStoreImageTasks

pub struct DescribeStoreImageTasks { /* private fields */ }

Fluent builder constructing a request to DescribeStoreImageTasks.

Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from the last 31 days.

For each AMI task, the response indicates if the task is InProgress, Completed, or Failed. For tasks InProgress, the response shows the estimated progress as a percentage.

Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.

For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.

Implementations

impl DescribeStoreImageTasks

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeStoreImageTasks, AwsResponseRetryClassifier>, SdkError<DescribeStoreImageTasksError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<DescribeStoreImageTasksOutput, SdkError<DescribeStoreImageTasksError>>

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.

pub fn into_paginator(self) -> DescribeStoreImageTasksPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn image_ids(self, input: impl Into<String>) -> Self

Appends an item to ImageIds.

To override the contents of this collection use set_image_ids.

The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.

pub fn set_image_ids(self, input: Option<Vec<String>>) -> Self

The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.

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.

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.

pub fn filters(self, input: Filter) -> Self

Appends an item to Filters.

To override the contents of this collection use set_filters.

The filters.

• task-state - Returns tasks in a certain state (InProgress | Completed | Failed)

• bucket - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.

pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self

The filters.

• task-state - Returns tasks in a certain state (InProgress | Completed | Failed)

• bucket - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.

pub fn next_token(self, input: impl Into<String>) -> Self

The token for the next page of results.

pub fn set_next_token(self, input: Option<String>) -> Self

The token for the next page of results.

pub fn max_results(self, input: i32) -> Self

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200. You cannot specify this parameter and the ImageIDs parameter in the same call.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200. You cannot specify this parameter and the ImageIDs parameter in the same call.

Trait Implementations

impl Clone for DescribeStoreImageTasks

fn clone(&self) -> DescribeStoreImageTasks

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeStoreImageTasks

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.