Amazon EC2 Image Builder CreateComponent API

openapi: 3.1.0
info:
  title: EC2 Image Builder Createcomponent 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:
  /CreateComponent:
    put:
      operationId: CreateComponent
      summary: Create Component
      description: 'Creates a new component that can be used to build, validate, test, and assess your image. The component
        is based on a YAML document that you specify using exactly one of the following methods: Inline, using the data property
        in the request body. A URL that points to a YAML document file stored in Amazon S3, using the uri property in the
        request body. Image Builder determines the component type from the document. If the document contains a single phase
        named test, the component type is TEST. Otherwise, the component type is BUILD.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateComponentResponse'
              example:
                requestId: 0cec8e32-a5c6-4aeb-ac3a-6471c8a2a8a9
                clientToken: a1b2c3d4-5678-90ab-cdef-EXAMPLE10101
                componentBuildVersionArn: arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/1.0.0/1
                latestVersionReferences:
                  latestVersionArn: arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/x.x.x
                  latestMajorVersionArn: arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/1.x.x
                  latestMinorVersionArn: arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/1.0.x
                  latestPatchVersionArn: arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/1.0.0
        '429':
          description: CallRateLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallRateLimitExceededException'
        '400':
          description: ClientException; IdempotentParameterMismatchException; InvalidParameterCombinationException; InvalidRequestException;
            InvalidVersionNumberException; ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
        '412':
          description: DryRunOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DryRunOperationException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateComponentRequest'
            example:
              name: my-example-parameterized-component
              semanticVersion: 1.0.0
              description: Installs a configurable version of my application
              platform: Linux
              uri: s3://amzn-s3-demo-bucket/components/install-my-app.yaml
              clientToken: a1b2c3d4-5678-90ab-cdef-EXAMPLE10101
      tags:
      - Createcomponent
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
    CreateComponentRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the component. Image Builder generates the component ARN from a normalized form of the
            name, so names that differ only in case, spaces, or underscores count as the same name. If a component with the
            same name and semantic version already exists in your account in the same Amazon Web Services Region, the request
            creates a new build version for it. If the content is also identical to the latest build version, the request
            fails because the component already exists.
        semanticVersion:
          type: string
          description: 'The semantic version of the component. This version follows the semantic version syntax. The semantic
            version has four nodes: ../. You can assign values for the first three, and can filter on all of them. Assignment:
            For the first three nodes, you can assign any positive integer value, including zero. The upper limit is 2^30-1,
            or 1073741823, for each node. Image Builder automatically assigns the build number to the fourth node. Patterns:
            You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign.
            For example, you might choose a software versi'
        description:
          type: string
          description: Describes the contents of the component.
        changeDescription:
          type: string
          description: The change description of the component. Describes what change has been made in this version, or what
            makes this version different from other versions of the component.
        platform:
          type: string
          enum:
          - Windows
          - Linux
          - macOS
          description: The operating system platform of the component.
        supportedOsVersions:
          type: array
          items:
            type: string
          description: The operating system (OS) version supported by the component. If the OS information is available, a
            prefix match is performed against the base image OS version during image recipe creation.
        data:
          type: string
          description: Component data contains inline YAML document content for the component. Alternatively, you can specify
            the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
        uri:
          type: string
          description: The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and you must have
            permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to
            your service quota for component size, which is 64 KB by default. Alternatively, you can specify the YAML document
            inline, using the component data property. You cannot specify both properties.
        kmsKeyId:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component.
            This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key
            Management Service Developer Guide. If you don't specify a key, Image Builder encrypts the component data with
            a KMS key that Image Builder owns.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags that apply to the component.
        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.
        dryRun:
          type: boolean
          description: Validates the required permissions and request parameters without performing the operation. If validation
            succeeds, the operation returns a DryRunOperationException error response.
      required:
      - name
      - semanticVersion
      - platform
      - clientToken
    CreateComponentResponse:
      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.
        componentBuildVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the component that the request created.
        latestVersionReferences:
          $ref: '#/components/schemas/LatestVersionReferences'
    DryRunOperationException:
      type: object
      properties:
        message:
          type: string
    ForbiddenException:
      type: object
      properties:
        message:
          type: string
    LatestVersionReferences:
      type: object
      properties:
        latestVersionArn:
          type: string
          description: The latest version Amazon Resource Name (ARN) of the Image Builder resource.
        latestMajorVersionArn:
          type: string
          description: The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
        latestMinorVersionArn:
          type: string
          description: The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
        latestPatchVersionArn:
          type: string
          description: The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.
    ServiceException:
      type: object
      properties:
        message:
          type: string
    ServiceQuotaExceededException:
      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)