Amazon IoT TwinMaker Pricingplan API

openapi: 3.0.0
info:
  version: '2021-11-29'
  x-release: v4
  title: AWS IoT TwinMaker Pricingplan API
  description: IoT TwinMaker is a service with which you can build operational digital twins of physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors, cameras, and enterprise applications so you can create data visualizations to monitor your physical factory, building, or industrial plant. You can use this real-world data to monitor operations and diagnose and repair errors.
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: iottwinmaker
  x-aws-signingName: iottwinmaker
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iottwinmaker-2021-11-29.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://iottwinmaker.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS IoT TwinMaker multi-region endpoint
- url: https://iottwinmaker.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS IoT TwinMaker multi-region endpoint
- url: http://iottwinmaker.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS IoT TwinMaker endpoint for China (Beijing) and China (Ningxia)
- url: https://iottwinmaker.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS IoT TwinMaker endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Pricingplan
paths:
  /pricingplan:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    get:
      operationId: GetPricingPlan
      description: Gets the pricing plan.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPricingPlanResponse'
        '480':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters: []
      summary: Amazon IoT TwinMaker Get Pricing Plan
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Pricingplan
    post:
      operationId: UpdatePricingPlan
      description: Update the pricing plan.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePricingPlanResponse'
        '480':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - pricingMode
              properties:
                pricingMode:
                  description: The pricing mode.
                  type: string
                  enum:
                  - BASIC
                  - STANDARD
                  - TIERED_BUNDLE
                bundleNames:
                  description: The bundle names.
                  type: array
                  items:
                    $ref: '#/components/schemas/BundleName'
                  minItems: 1
                  maxItems: 10
      summary: Amazon IoT TwinMaker Update Pricing Plan
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Pricingplan
components:
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  schemas:
    PricingMode:
      type: string
      enum:
      - BASIC
      - STANDARD
      - TIERED_BUNDLE
    BundleInformation:
      type: object
      required:
      - bundleNames
      properties:
        bundleNames:
          allOf:
          - $ref: '#/components/schemas/PricingBundles'
          - description: The bundle names.
        pricingTier:
          allOf:
          - $ref: '#/components/schemas/PricingTier'
          - description: The pricing tier.
      description: Information about the pricing bundle.
    UpdateReason:
      type: string
      enum:
      - DEFAULT
      - PRICING_TIER_UPDATE
      - ENTITY_COUNT_UPDATE
      - PRICING_MODE_UPDATE
      - OVERWRITTEN
    GetPricingPlanResponse:
      type: object
      required:
      - currentPricingPlan
      properties:
        currentPricingPlan:
          allOf:
          - $ref: '#/components/schemas/PricingPlan'
          - description: The chosen pricing plan for the current billing cycle.
        pendingPricingPlan:
          allOf:
          - $ref: '#/components/schemas/PricingPlan'
          - description: The pending pricing plan.
    AccessDeniedException: {}
    PricingTier:
      type: string
      enum:
      - TIER_1
      - TIER_2
      - TIER_3
      - TIER_4
    BundleName:
      type: string
      pattern: .*
      minLength: 1
      maxLength: 256
    UpdatePricingPlanResponse:
      type: object
      required:
      - currentPricingPlan
      properties:
        currentPricingPlan:
          allOf:
          - $ref: '#/components/schemas/PricingPlan'
          - description: Update the current pricing plan.
        pendingPricingPlan:
          allOf:
          - $ref: '#/components/schemas/PricingPlan'
          - description: Update the pending pricing plan.
    PricingBundles:
      type: array
      items:
        $ref: '#/components/schemas/BundleName'
      minItems: 1
      maxItems: 10
    ThrottlingException: {}
    ValidationException: {}
    Long:
      type: integer
    Timestamp:
      type: string
      description: supports epoch seconds value
      format: date-time
    InternalServerException: {}
    PricingPlan:
      type: object
      required:
      - effectiveDateTime
      - pricingMode
      - updateDateTime
      - updateReason
      properties:
        billableEntityCount:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: The billable entity count.
        bundleInformation:
          allOf:
          - $ref: '#/components/schemas/BundleInformation'
          - description: The pricing plan's bundle information.
        effectiveDateTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The effective date and time of the pricing plan.
        pricingMode:
          allOf:
          - $ref: '#/components/schemas/PricingMode'
          - description: The pricing mode.
        updateDateTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The set date and time for updating a pricing plan.
        updateReason:
          allOf:
          - $ref: '#/components/schemas/UpdateReason'
          - description: The update reason for changing a pricing plan.
      description: The pricing plan.
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/iottwinmaker/
x-hasEquivalentPaths: true