Amazon EC2 Image Builder Delete Image API

openapi: 3.1.0
info:
  title: EC2 Image Builder Deleteimage API
  version: '2019-12-02'
  description: Generated from AWS's published Smithy model for EC2 Image Builder. 1 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://imagebuilder.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /DeleteImage:
    delete:
      operationId: DeleteImage
      summary: Delete Image
      description: Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container images that
        are created during the image build process. You must clean those up separately, using the appropriate Amazon EC2 or
        Amazon ECR console actions, or API or CLI commands. The request fails with ResourceDependencyException if the image
        is shared with other accounts, or if other resources depend on it. It also fails while the image build is still running.
        Cancel an in-progress build with CancelImageCreation before you delete the image. To deregister an EC2 Linux AMI,
        see Deregister your Linux AMI in the Amazon EC2 User Guide . To deregister an EC2 Windows AMI, see Deregister your
        Windows AMI in the Amazon EC2 Windows Guide . To delete a container image from Amazon ECR, see Deleting an image in
        the Amazon ECR User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteImageResponse'
              example:
                requestId: fd45526c-ec37-4345-8843-329e4268e00e
                imageBuildVersionArn: arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1
        '429':
          description: CallRateLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallRateLimitExceededException'
        '400':
          description: ClientException; InvalidRequestException; ResourceDependencyException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteImageRequest'
            example:
              imageBuildVersionArn: arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1
      tags:
      - Deleteimage
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: imagebuilder
  schemas:
    CallRateLimitExceededException:
      type: object
      properties:
        message:
          type: string
    ClientException:
      type: object
      properties:
        message:
          type: string
    DeleteImageRequest:
      type: object
      properties:
        imageBuildVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Image Builder image resource to delete.
      required:
      - imageBuildVersionArn
    DeleteImageResponse:
      type: object
      properties:
        requestId:
          type: string
          description: The request ID that uniquely identifies this request.
        imageBuildVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Image Builder image resource that this request deleted.
    ForbiddenException:
      type: object
      properties:
        message:
          type: string
    ServiceException:
      type: object
      properties:
        message:
          type: string
    ServiceUnavailableException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/imagebuilder/service/2019-12-02/imagebuilder-2019-12-02.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)