Amazon EC2 Image Builder CancelImageCreation API

openapi: 3.1.0
info:
  title: EC2 Image Builder Cancelimagecreation 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:
  /CancelImageCreation:
    put:
      operationId: CancelImageCreation
      summary: Cancel Image Creation
      description: 'Cancels the creation of an image. This operation can only be used on images in a non-terminal state. Cancellation
        is asynchronous: the request returns immediately, then Image Builder stops the running build and moves the image to
        the CANCELLED state. Output resources that the build already created, such as AMIs and snapshots, aren''t removed.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelImageCreationResponse'
              example:
                requestId: fead325f-72d9-42b5-b2ed-c5294984c6a9
                clientToken: a1b2c3d4-5678-90ab-cdef-EXAMPLE77777
                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; IdempotentParameterMismatchException; InvalidRequestException; ResourceInUseException
          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/CancelImageCreationRequest'
            example:
              imageBuildVersionArn: arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1
              clientToken: a1b2c3d4-5678-90ab-cdef-EXAMPLE77777
      tags:
      - Cancelimagecreation
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
    CancelImageCreationRequest:
      type: object
      properties:
        imageBuildVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the image that you want to cancel creation for.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one
            time. If you retry a request with the same client token, Image Builder returns the original response without running
            the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
      required:
      - imageBuildVersionArn
      - clientToken
    CancelImageCreationResponse:
      type: object
      properties:
        requestId:
          type: string
          description: The request ID that uniquely identifies this request.
        clientToken:
          type: string
          description: The client token that uniquely identifies the request.
        imageBuildVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the image whose creation this request canceled.
    ClientException:
      type: object
      properties:
        message:
          type: string
    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)