aws_sdk_ec2/client/

describe_store_image_tasks.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeStoreImageTasks`](crate::operation::describe_store_image_tasks::builders::DescribeStoreImageTasksFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_store_image_tasks::builders::DescribeStoreImageTasksFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`image_ids(impl Into<String>)`](crate::operation::describe_store_image_tasks::builders::DescribeStoreImageTasksFluentBuilder::image_ids) / [`set_image_ids(Option<Vec::<String>>)`](crate::operation::describe_store_image_tasks::builders::DescribeStoreImageTasksFluentBuilder::set_image_ids):<br>required: **false**<br><p>The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.</p><br>
    ///   - [`dry_run(bool)`](crate::operation::describe_store_image_tasks::builders::DescribeStoreImageTasksFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_store_image_tasks::builders::DescribeStoreImageTasksFluentBuilder::set_dry_run):<br>required: **false**<br><p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p><br>
    ///   - [`filters(Filter)`](crate::operation::describe_store_image_tasks::builders::DescribeStoreImageTasksFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_store_image_tasks::builders::DescribeStoreImageTasksFluentBuilder::set_filters):<br>required: **false**<br><p>The filters.</p> <ul>  <li>   <p><code>task-state</code> - Returns tasks in a certain state (<code>InProgress</code> | <code>Completed</code> | <code>Failed</code>)</p></li>  <li>   <p><code>bucket</code> - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.</p></li> </ul><note>  <p>When you specify the <code>ImageIds</code> parameter, any filters that you specify are ignored. To use the filters, you must remove the <code>ImageIds</code> parameter.</p> </note><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_store_image_tasks::builders::DescribeStoreImageTasksFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_store_image_tasks::builders::DescribeStoreImageTasksFluentBuilder::set_next_token):<br>required: **false**<br><p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_store_image_tasks::builders::DescribeStoreImageTasksFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_store_image_tasks::builders::DescribeStoreImageTasksFluentBuilder::set_max_results):<br>required: **false**<br><p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p> <p>You cannot specify this parameter and the <code>ImageIds</code> parameter in the same call.</p><br>
    /// - On success, responds with [`DescribeStoreImageTasksOutput`](crate::operation::describe_store_image_tasks::DescribeStoreImageTasksOutput) with field(s):
    ///   - [`store_image_task_results(Option<Vec::<StoreImageTaskResult>>)`](crate::operation::describe_store_image_tasks::DescribeStoreImageTasksOutput::store_image_task_results): <p>The information about the AMI store tasks.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_store_image_tasks::DescribeStoreImageTasksOutput::next_token): <p>The token to include in another request to get the next page of items. This value is <code>null</code> when there are no more items to return.</p>
    /// - On failure, responds with [`SdkError<DescribeStoreImageTasksError>`](crate::operation::describe_store_image_tasks::DescribeStoreImageTasksError)
    pub fn describe_store_image_tasks(&self) -> crate::operation::describe_store_image_tasks::builders::DescribeStoreImageTasksFluentBuilder {
        crate::operation::describe_store_image_tasks::builders::DescribeStoreImageTasksFluentBuilder::new(self.handle.clone())
    }
}