Amazon IoT SiteWise Configuration API

The Configuration API from Amazon IoT SiteWise — 2 operation(s) for configuration.

GitHub OpenAPI

Operations 4

GET /configuration/account/encryption Describe Default Encryption Configuration #
POST /configuration/account/encryption Put Default Encryption Configuration #
GET /configuration/account/storage Describe Storage Configuration #
POST /configuration/account/storage Put Storage Configuration #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-iot-sitewise:amazon-iot-sitewise-configuration-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-iot-sitewise-configuration-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS IoT SiteWise Configuration API
  version: '2019-12-02'
  description: Generated from AWS's published Smithy model for AWS IoT SiteWise. 4 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://iotsitewise.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /configuration/account/encryption:
    get:
      operationId: DescribeDefaultEncryptionConfiguration
      summary: Describe Default Encryption Configuration
      description: Retrieves information about the default encryption configuration for the Amazon Web Services account in
        the default or specified Region. For more information, see Key management in the IoT SiteWise User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDefaultEncryptionConfigurationResponse'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeDefaultEncryptionConfigurationRequest'
      tags:
      - Configuration
    post:
      operationId: PutDefaultEncryptionConfiguration
      summary: Put Default Encryption Configuration
      description: Sets the default encryption configuration for the Amazon Web Services account. For more information, see
        Key management in the IoT SiteWise User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutDefaultEncryptionConfigurationResponse'
        '409':
          description: ConflictingOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingOperationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '410':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutDefaultEncryptionConfigurationRequest'
      tags:
      - Configuration
  /configuration/account/storage:
    get:
      operationId: DescribeStorageConfiguration
      summary: Describe Storage Configuration
      description: Retrieves information about the storage configuration for IoT SiteWise.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeStorageConfigurationResponse'
        '409':
          description: ConflictingOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingOperationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '410':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeStorageConfigurationRequest'
      tags:
      - Configuration
    post:
      operationId: PutStorageConfiguration
      summary: Put Storage Configuration
      description: Configures storage settings for IoT SiteWise.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutStorageConfigurationResponse'
        '409':
          description: ConflictingOperationException; ResourceAlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingOperationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '410':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutStorageConfigurationRequest'
      tags:
      - Configuration
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: iotsitewise
  schemas:
    ConfigurationErrorDetails:
      type: object
      properties:
        code:
          type: string
          enum:
          - VALIDATION_ERROR
          - INTERNAL_FAILURE
          description: The error code.
        message:
          type: string
          description: The error message.
      required:
      - code
      - message
    ConfigurationStatus:
      type: object
      properties:
        state:
          type: string
          enum:
          - ACTIVE
          - UPDATE_IN_PROGRESS
          - UPDATE_FAILED
          description: The current state of the configuration.
        error:
          $ref: '#/components/schemas/ConfigurationErrorDetails'
      required:
      - state
    ConflictingOperationException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the resource that conflicts with this operation.
        resourceArn:
          type: string
          description: The ARN of the resource that conflicts with this operation.
      required:
      - message
      - resourceId
      - resourceArn
    CustomerManagedS3Storage:
      type: object
      properties:
        s3ResourceArn:
          type: string
          description: The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object,
            see Amazon S3 resources in the Amazon Simple Storage Service User Guide.
        roleArn:
          type: string
          description: The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon
            S3.
      required:
      - s3ResourceArn
      - roleArn
    DescribeDefaultEncryptionConfigurationRequest:
      type: object
      properties: {}
    DescribeDefaultEncryptionConfigurationResponse:
      type: object
      properties:
        encryptionType:
          type: string
          enum:
          - SITEWISE_DEFAULT_ENCRYPTION
          - KMS_BASED_ENCRYPTION
          description: The type of encryption used for the encryption configuration.
        kmsKeyArn:
          type: string
          description: The key ARN of the customer managed key used for KMS encryption if you use KMS_BASED_ENCRYPTION.
        configurationStatus:
          $ref: '#/components/schemas/ConfigurationStatus'
      required:
      - encryptionType
      - configurationStatus
    DescribeStorageConfigurationRequest:
      type: object
      properties: {}
    DescribeStorageConfigurationResponse:
      type: object
      properties:
        storageType:
          type: string
          enum:
          - SITEWISE_DEFAULT_STORAGE
          - MULTI_LAYER_STORAGE
          description: 'The storage tier that you specified for your data. The storageType parameter can be one of the following
            values: SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed
            database. MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold
            tier is a customer-managed Amazon S3 bucket.'
        multiLayerStorage:
          $ref: '#/components/schemas/MultiLayerStorage'
        disassociatedDataStorage:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: 'Contains the storage configuration for time series (data streams) that aren''t associated with asset
            properties. The disassociatedDataStorage can be one of the following values: ENABLED – IoT SiteWise accepts time
            series that aren''t associated with asset properties. After the disassociatedDataStorage is enabled, you can''t
            disable it. DISABLED – IoT SiteWise doesn''t accept time series (data streams) that aren''t associated with asset
            properties. For more information, see Data streams in the IoT SiteWise User Guide.'
        retentionPeriod:
          $ref: '#/components/schemas/RetentionPeriod'
        configurationStatus:
          $ref: '#/components/schemas/ConfigurationStatus'
        lastUpdateDate:
          type: string
          format: date-time
          description: The date the storage configuration was last updated, in Unix epoch time.
        warmTier:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered
            and historical data ingested with the CreaeBulkImportJob API.
        warmTierRetentionPeriod:
          $ref: '#/components/schemas/WarmTierRetentionPeriod'
        disallowIngestNullNaN:
          type: boolean
          description: Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The
            feature is disallowed if the value is true.
      required:
      - storageType
      - configurationStatus
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    MultiLayerStorage:
      type: object
      properties:
        customerManagedS3Storage:
          $ref: '#/components/schemas/CustomerManagedS3Storage'
      required:
      - customerManagedS3Storage
    PutDefaultEncryptionConfigurationRequest:
      type: object
      properties:
        encryptionType:
          type: string
          enum:
          - SITEWISE_DEFAULT_ENCRYPTION
          - KMS_BASED_ENCRYPTION
          description: The type of encryption used for the encryption configuration.
        kmsKeyId:
          type: string
          description: The Key ID of the customer managed key used for KMS encryption. This is required if you use KMS_BASED_ENCRYPTION.
      required:
      - encryptionType
    PutDefaultEncryptionConfigurationResponse:
      type: object
      properties:
        encryptionType:
          type: string
          enum:
          - SITEWISE_DEFAULT_ENCRYPTION
          - KMS_BASED_ENCRYPTION
          description: The type of encryption used for the encryption configuration.
        kmsKeyArn:
          type: string
          description: The Key ARN of the KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION.
        configurationStatus:
          $ref: '#/components/schemas/ConfigurationStatus'
      required:
      - encryptionType
      - configurationStatus
    PutStorageConfigurationRequest:
      type: object
      properties:
        storageType:
          type: string
          enum:
          - SITEWISE_DEFAULT_STORAGE
          - MULTI_LAYER_STORAGE
          description: 'The storage tier that you specified for your data. The storageType parameter can be one of the following
            values: SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed
            database. MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold
            tier is a customer-managed Amazon S3 bucket.'
        multiLayerStorage:
          $ref: '#/components/schemas/MultiLayerStorage'
        disassociatedDataStorage:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: 'Contains the storage configuration for time series (data streams) that aren''t associated with asset
            properties. The disassociatedDataStorage can be one of the following values: ENABLED – IoT SiteWise accepts time
            series that aren''t associated with asset properties. After the disassociatedDataStorage is enabled, you can''t
            disable it. DISABLED – IoT SiteWise doesn''t accept time series (data streams) that aren''t associated with asset
            properties. For more information, see Data streams in the IoT SiteWise User Guide.'
        retentionPeriod:
          $ref: '#/components/schemas/RetentionPeriod'
        warmTier:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered
            and historical data ingested with the CreaeBulkImportJob API.
        warmTierRetentionPeriod:
          $ref: '#/components/schemas/WarmTierRetentionPeriod'
        disallowIngestNullNaN:
          type: boolean
          description: Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The
            feature is disallowed if the value is true.
      required:
      - storageType
    PutStorageConfigurationResponse:
      type: object
      properties:
        storageType:
          type: string
          enum:
          - SITEWISE_DEFAULT_STORAGE
          - MULTI_LAYER_STORAGE
          description: 'The storage tier that you specified for your data. The storageType parameter can be one of the following
            values: SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed
            database. MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold
            tier is a customer-managed Amazon S3 bucket.'
        multiLayerStorage:
          $ref: '#/components/schemas/MultiLayerStorage'
        disassociatedDataStorage:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: 'Contains the storage configuration for time series (data streams) that aren''t associated with asset
            properties. The disassociatedDataStorage can be one of the following values: ENABLED – IoT SiteWise accepts time
            series that aren''t associated with asset properties. After the disassociatedDataStorage is enabled, you can''t
            disable it. DISABLED – IoT SiteWise doesn''t accept time series (data streams) that aren''t associated with asset
            properties. For more information, see Data streams in the IoT SiteWise User Guide.'
        retentionPeriod:
          $ref: '#/components/schemas/RetentionPeriod'
        configurationStatus:
          $ref: '#/components/schemas/ConfigurationStatus'
        warmTier:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered
            and historical data ingested with the CreaeBulkImportJob API.
        warmTierRetentionPeriod:
          $ref: '#/components/schemas/WarmTierRetentionPeriod'
        disallowIngestNullNaN:
          type: boolean
          description: Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The
            feature is disallowed if the value is true.
      required:
      - storageType
      - configurationStatus
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    RetentionPeriod:
      type: object
      properties:
        numberOfDays:
          type: integer
          description: The number of days that your data is kept. If you specified a value for this parameter, the unlimited
            parameter must be false.
        unlimited:
          type: boolean
          description: If true, your data is kept indefinitely. If configured to true, you must not specify a value for the
            numberOfDays parameter.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    WarmTierRetentionPeriod:
      type: object
      properties:
        numberOfDays:
          type: integer
          description: The number of days the data is stored in the warm tier.
        unlimited:
          type: boolean
          description: If set to true, the data is stored indefinitely in the warm tier.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/iotsitewise/service/2019-12-02/iotsitewise-2019-12-02.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)