aws_sdk_ec2/client/

describe_image_references.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeImageReferences`](crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`image_ids(impl Into<String>)`](crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder::image_ids) / [`set_image_ids(Option<Vec::<String>>)`](crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder::set_image_ids):<br>required: **true**<br><p>The IDs of the images to check for resource references.</p><br>
    ///   - [`include_all_resource_types(bool)`](crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder::include_all_resource_types) / [`set_include_all_resource_types(Option<bool>)`](crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder::set_include_all_resource_types):<br>required: **false**<br><p>Specifies whether to check all supported Amazon Web Services resource types for image references. When specified, default values are applied for <code>ResourceTypeOptions</code>. For the default values, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-ami-references.html#how-ami-references-works">How AMI reference checks work</a> in the <i>Amazon EC2 User Guide</i>. If you also specify <code>ResourceTypes</code> with <code>ResourceTypeOptions</code>, your specified values override the default values.</p> <p>Supported resource types: <code>ec2:Instance</code> | <code>ec2:LaunchTemplate</code> | <code>ssm:Parameter</code> | <code>imagebuilder:ImageRecipe</code> | <code>imagebuilder:ContainerRecipe</code></p> <p>Either <code>IncludeAllResourceTypes</code> or <code>ResourceTypes</code> must be specified.</p><br>
    ///   - [`resource_types(ResourceTypeRequest)`](crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder::resource_types) / [`set_resource_types(Option<Vec::<ResourceTypeRequest>>)`](crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder::set_resource_types):<br>required: **false**<br><p>The Amazon Web Services resource types to check for image references.</p> <p>Either <code>IncludeAllResourceTypes</code> or <code>ResourceTypes</code> must be specified.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder::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>
    ///   - [`dry_run(bool)`](crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder::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>
    ///   - [`max_results(i32)`](crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder::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><br>
    /// - On success, responds with [`DescribeImageReferencesOutput`](crate::operation::describe_image_references::DescribeImageReferencesOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::describe_image_references::DescribeImageReferencesOutput::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>
    ///   - [`image_references(Option<Vec::<ImageReference>>)`](crate::operation::describe_image_references::DescribeImageReferencesOutput::image_references): <p>The resources that are referencing the specified images.</p>
    /// - On failure, responds with [`SdkError<DescribeImageReferencesError>`](crate::operation::describe_image_references::DescribeImageReferencesError)
    pub fn describe_image_references(&self) -> crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder {
        crate::operation::describe_image_references::builders::DescribeImageReferencesFluentBuilder::new(self.handle.clone())
    }
}