aws_sdk_ecr/client/
batch_get_image.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`BatchGetImage`](crate::operation::batch_get_image::builders::BatchGetImageFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`registry_id(impl Into<String>)`](crate::operation::batch_get_image::builders::BatchGetImageFluentBuilder::registry_id) / [`set_registry_id(Option<String>)`](crate::operation::batch_get_image::builders::BatchGetImageFluentBuilder::set_registry_id):<br>required: **false**<br><p>The Amazon Web Services account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.</p><br>
7    ///   - [`repository_name(impl Into<String>)`](crate::operation::batch_get_image::builders::BatchGetImageFluentBuilder::repository_name) / [`set_repository_name(Option<String>)`](crate::operation::batch_get_image::builders::BatchGetImageFluentBuilder::set_repository_name):<br>required: **true**<br><p>The repository that contains the images to describe.</p><br>
8    ///   - [`image_ids(ImageIdentifier)`](crate::operation::batch_get_image::builders::BatchGetImageFluentBuilder::image_ids) / [`set_image_ids(Option<Vec::<ImageIdentifier>>)`](crate::operation::batch_get_image::builders::BatchGetImageFluentBuilder::set_image_ids):<br>required: **true**<br><p>A list of image ID references that correspond to images to describe. The format of the <code>imageIds</code> reference is <code>imageTag=tag</code> or <code>imageDigest=digest</code>.</p><br>
9    ///   - [`accepted_media_types(impl Into<String>)`](crate::operation::batch_get_image::builders::BatchGetImageFluentBuilder::accepted_media_types) / [`set_accepted_media_types(Option<Vec::<String>>)`](crate::operation::batch_get_image::builders::BatchGetImageFluentBuilder::set_accepted_media_types):<br>required: **false**<br><p>The accepted media types for the request.</p> <p>Valid values: <code>application/vnd.docker.distribution.manifest.v1+json</code> | <code>application/vnd.docker.distribution.manifest.v2+json</code> | <code>application/vnd.oci.image.manifest.v1+json</code></p><br>
10    /// - On success, responds with [`BatchGetImageOutput`](crate::operation::batch_get_image::BatchGetImageOutput) with field(s):
11    ///   - [`images(Option<Vec::<Image>>)`](crate::operation::batch_get_image::BatchGetImageOutput::images): <p>A list of image objects corresponding to the image references in the request.</p>
12    ///   - [`failures(Option<Vec::<ImageFailure>>)`](crate::operation::batch_get_image::BatchGetImageOutput::failures): <p>Any failures associated with the call.</p>
13    /// - On failure, responds with [`SdkError<BatchGetImageError>`](crate::operation::batch_get_image::BatchGetImageError)
14    pub fn batch_get_image(&self) -> crate::operation::batch_get_image::builders::BatchGetImageFluentBuilder {
15        crate::operation::batch_get_image::builders::BatchGetImageFluentBuilder::new(self.handle.clone())
16    }
17}