aws_sdk_ecr/client/
batch_delete_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 [`BatchDeleteImage`](crate::operation::batch_delete_image::builders::BatchDeleteImageFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`registry_id(impl Into<String>)`](crate::operation::batch_delete_image::builders::BatchDeleteImageFluentBuilder::registry_id) / [`set_registry_id(Option<String>)`](crate::operation::batch_delete_image::builders::BatchDeleteImageFluentBuilder::set_registry_id):<br>required: **false**<br><p>The Amazon Web Services account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.</p><br>
7    ///   - [`repository_name(impl Into<String>)`](crate::operation::batch_delete_image::builders::BatchDeleteImageFluentBuilder::repository_name) / [`set_repository_name(Option<String>)`](crate::operation::batch_delete_image::builders::BatchDeleteImageFluentBuilder::set_repository_name):<br>required: **true**<br><p>The repository that contains the image to delete.</p><br>
8    ///   - [`image_ids(ImageIdentifier)`](crate::operation::batch_delete_image::builders::BatchDeleteImageFluentBuilder::image_ids) / [`set_image_ids(Option<Vec::<ImageIdentifier>>)`](crate::operation::batch_delete_image::builders::BatchDeleteImageFluentBuilder::set_image_ids):<br>required: **true**<br><p>A list of image ID references that correspond to images to delete. The format of the <code>imageIds</code> reference is <code>imageTag=tag</code> or <code>imageDigest=digest</code>.</p><br>
9    /// - On success, responds with [`BatchDeleteImageOutput`](crate::operation::batch_delete_image::BatchDeleteImageOutput) with field(s):
10    ///   - [`image_ids(Option<Vec::<ImageIdentifier>>)`](crate::operation::batch_delete_image::BatchDeleteImageOutput::image_ids): <p>The image IDs of the deleted images.</p>
11    ///   - [`failures(Option<Vec::<ImageFailure>>)`](crate::operation::batch_delete_image::BatchDeleteImageOutput::failures): <p>Any failures associated with the call.</p>
12    /// - On failure, responds with [`SdkError<BatchDeleteImageError>`](crate::operation::batch_delete_image::BatchDeleteImageError)
13    pub fn batch_delete_image(&self) -> crate::operation::batch_delete_image::builders::BatchDeleteImageFluentBuilder {
14        crate::operation::batch_delete_image::builders::BatchDeleteImageFluentBuilder::new(self.handle.clone())
15    }
16}