Amazon EC2 Image Builder StartImagePipelineExecution API

openapi: 3.1.0
info:
  title: EC2 Image Builder Startimagepipelineexecution 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:
  /StartImagePipelineExecution:
    put:
      operationId: StartImagePipelineExecution
      summary: Start Image Pipeline Execution
      description: Manually triggers a pipeline to create an image. You can start a build this way whether the pipeline is
        enabled or disabled. The response returns as soon as Image Builder creates the new image resource and queues the build.
        Use the returned imageBuildVersionArn with GetImage to track build progress.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartImagePipelineExecutionResponse'
              example:
                requestId: f477f64c-9ece-4478-977d-5821f8ed051b
                clientToken: a1b2c3d4-5678-90ab-cdef-EXAMPLE66666
                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'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '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/StartImagePipelineExecutionRequest'
            example:
              imagePipelineArn: arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline
              clientToken: a1b2c3d4-5678-90ab-cdef-EXAMPLE66666
      tags:
      - Startimagepipelineexecution
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
    ForbiddenException:
      type: object
      properties:
        message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ServiceException:
      type: object
      properties:
        message:
          type: string
    ServiceUnavailableException:
      type: object
      properties:
        message:
          type: string
    StartImagePipelineExecutionRequest:
      type: object
      properties:
        imagePipelineArn:
          type: string
          description: The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.
        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.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags for Image Builder to apply to the image resource that's created when pipeline execution starts.
      required:
      - imagePipelineArn
      - clientToken
    StartImagePipelineExecutionResponse:
      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 that the request created.
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)