The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 1 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults
is 4000.
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 4 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults
is 20000.
Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId
of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property''s
alias, see UpdateAssetProperty.
With respect to Unix epoch
time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive
range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error.
For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer
TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV.
IoT SiteWise authorizes
access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue
authorization in the IoT SiteWise User Guide.
Contains an identity that can access an IoT SiteWise Monitor resource.
Currently, you can''t use Amazon Web Services APIs to retrieve IAM Identity Center identity IDs. You can find the IAM Identity Center identity IDs in the URL of user and group pages in the IAM Identity Center console.
ADMINISTRATOR is also known as a project owner.
type: string
enum:
- ADMINISTRATOR
- VIEWER
clientToken:
description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
type: string
pattern: '\S{36,64}'
minLength: 36
maxLength: 64
tags:
description: 'A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging
your IoT SiteWise resources in the IoT SiteWise User Guide.'
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
summary: Amazon IoT SiteWise Create Access Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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: ListAccessPolicies
description: 'Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal
or project).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAccessPoliciesResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: identityType
in: query
required: false
description: 'The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required if you specify identityId.'
schema:
type: string
enum:
- USER
- GROUP
- IAM
- name: identityId
in: query
required: false
description: The ID of the identity. This parameter is required if you specify USER or GROUP for identityType.
schema:
type: string
pattern: \S+
minLength: 1
maxLength: 256
- name: resourceType
in: query
required: false
description: The type of resource (portal or project). This parameter is required if you specify resourceId.
schema:
type: string
enum:
- PORTAL
- PROJECT
- name: resourceId
in: query
required: false
description: The ID of the resource. This parameter is required if you specify resourceType.
schema:
type: string
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
minLength: 36
maxLength: 36
- name: iamArn
in: query
required: false
description: 'The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide.
This parameter is required if you specify IAM for identityType.'
schema:
type: string
pattern: .*
minLength: 1
maxLength: 1600
- name: nextToken
in: query
required: false
description: The token to be used for the next set of paginated results.
schema:
type: string
pattern: '[A-Za-z0-9+/=]+'
minLength: 1
maxLength: 4096
- name: maxResults
in: query
required: false
description: 'The maximum number of results to return for each paginated request.
Default: 50
' schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT SiteWise List Access Policies x-microcks-operation: delay: 0 dispatcher: FALLBACK /assets: post: operationId: CreateAsset description: 'Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.' responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateAssetResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '486': description: ConflictingOperationException content: application/json: schema: $ref: '#/components/schemas/ConflictingOperationException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - assetName - assetModelId properties: assetName: description: A friendly name for the asset. type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 maxLength: 256 assetModelId: description: The ID of the asset model from which to create the asset. type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 clientToken: description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required. type: string pattern: '\S{36,64}' minLength: 36 maxLength: 64 tags: description: 'A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.' type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' assetDescription: description: A description for the asset. type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 maxLength: 2048 summary: Amazon IoT SiteWise Create Asset x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: ListAssets description: 'Retrieves a paginated list of asset summaries.
You can use this operation to do the following:
List assets based on a specific asset model.
List top-level assets.
You can''t use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListAssetsResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: nextToken in: query required: false description: The token to be used for the next set of paginated results. schema: type: string pattern: '[A-Za-z0-9+/=]+' minLength: 1 maxLength: 4096 - name: maxResults in: query required: false description: 'The maximum number of results to return for each paginated request.
Default: 50
' schema: type: integer minimum: 1 maximum: 250 - name: assetModelId in: query required: false description: The ID of the asset model by which to filter the list of assets. This parameter is required if you chooseALL for filter.
schema:
type: string
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
minLength: 36
maxLength: 36
- name: filter
in: query
required: false
description: 'The filter for the requested list of assets. Choose one of the following options:
ALL – The list includes all assets for a given asset model ID. The
assetModelId parameter is required if you filter by ALL.
TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.
Default: ALL
The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
' type: array items: $ref: '#/components/schemas/AssetModelPropertyDefinition' assetModelHierarchies: description: 'The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
' type: array items: $ref: '#/components/schemas/AssetModelHierarchyDefinition' assetModelCompositeModels: description: The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model. type: array items: $ref: '#/components/schemas/AssetModelCompositeModelDefinition' clientToken: description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required. type: string pattern: '\S{36,64}' minLength: 36 maxLength: 64 tags: description: 'A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.' type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' summary: Amazon IoT SiteWise Create Asset Model x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: ListAssetModels description: Retrieves a paginated list of summaries of all asset models. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListAssetModelsResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: nextToken in: query required: false description: The token to be used for the next set of paginated results. schema: type: string pattern: '[A-Za-z0-9+/=]+' minLength: 1 maxLength: 4096 - name: maxResults in: query required: false description: 'The maximum number of results to return for each paginated request.
Default: 50
' schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT SiteWise List Asset Models x-microcks-operation: delay: 0 dispatcher: FALLBACK /jobs: post: operationId: CreateBulkImportJob description: 'Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more information about how to configure storage settings, see PutStorageConfiguration.
The maximum number of results to return for each paginated request.
Default: 50
' schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT SiteWise List Gateways x-microcks-operation: delay: 0 dispatcher: FALLBACK /portals: post: operationId: CreatePortal description: 'Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.
Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide.
The service to use to authenticate users to the portal. Choose from the following options:
SSO – The portal uses IAM Identity Center (successor
to Single Sign-On) to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information,
see Enabling IAM Identity Center in the IoT SiteWise User Guide. This
option is only available in Amazon Web Services Regions other than the China Regions.
IAM – The portal uses Identity and Access Management to authenticate
users and manage user permissions.
You can''t change this value after you create a portal.
Default: SSO
The email address that sends alarm notifications.
If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.
The maximum number of results to return for each paginated request.
Default: 50
' schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT SiteWise List Portals x-microcks-operation: delay: 0 dispatcher: FALLBACK /projects: post: operationId: CreateProject description:Creates a project in the specified portal.
Make sure that the project name and description don't contain confidential information.
Contains an identity that can access an IoT SiteWise Monitor resource.
Currently, you can''t use Amazon Web Services APIs to retrieve IAM Identity Center identity IDs. You can find the IAM Identity Center identity IDs in the URL of user and group pages in the IAM Identity Center console.
ADMINISTRATOR is also known as a project owner.
type: string
enum:
- ADMINISTRATOR
- VIEWER
clientToken:
description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
type: string
pattern: '\S{36,64}'
minLength: 36
maxLength: 64
summary: Amazon IoT SiteWise Update Access Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/assets/{assetId}':
delete:
operationId: DeleteAsset
description: 'Deletes an asset. This action can''t be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
You can''t delete an asset that''s associated to another asset. For more information, see DisassociateAssets.
Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model''s property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.
This operation overwrites the existing model with the provided model. To avoid deleting your asset model''s properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel.
If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can''t change the type or data type of an existing property.
The updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
' type: array items: $ref: '#/components/schemas/AssetModelProperty' assetModelHierarchies: description: 'The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
' type: array items: $ref: '#/components/schemas/AssetModelHierarchy' assetModelCompositeModels: description: The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model. type: array items: $ref: '#/components/schemas/AssetModelCompositeModel' clientToken: description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required. type: string pattern: '\S{36,64}' minLength: 36 maxLength: 64 summary: Amazon IoT SiteWise Update Asset Model x-microcks-operation: delay: 0 dispatcher: FALLBACK '/dashboards/{dashboardId}': delete: operationId: DeleteDashboard description: Deletes a dashboard from IoT SiteWise Monitor. responses: '204': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteDashboardResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: dashboardId in: path required: true description: The ID of the dashboard to delete. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 - name: clientToken in: query required: false description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required. schema: type: string pattern: '\S{36,64}' minLength: 36 maxLength: 64 summary: Amazon IoT SiteWise Delete Dashboard x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: DescribeDashboard description: Retrieves information about a dashboard. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeDashboardResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: dashboardId in: path required: true description: The ID of the dashboard. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 summary: Amazon IoT SiteWise Describe Dashboard x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateDashboard description: Updates an IoT SiteWise Monitor dashboard. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateDashboardResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: dashboardId in: path required: true description: The ID of the dashboard to update. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 requestBody: required: true content: application/json: schema: type: object required: - dashboardName - dashboardDefinition properties: dashboardName: description: A new friendly name for the dashboard. type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 maxLength: 256 dashboardDescription: description: A new description for the dashboard. type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 maxLength: 2048 dashboardDefinition: description: 'The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.' type: string pattern: .+ minLength: 0 maxLength: 204800 clientToken: description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required. type: string pattern: '\S{36,64}' minLength: 36 maxLength: 64 summary: Amazon IoT SiteWise Update Dashboard x-microcks-operation: delay: 0 dispatcher: FALLBACK '/20200301/gateways/{gatewayId}': delete: operationId: DeleteGateway description: 'Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway''s files remain in your gateway''s file system.' responses: '200': description: Success '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: gatewayId in: path required: true description: The ID of the gateway to delete. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 summary: Amazon IoT SiteWise Delete Gateway x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: DescribeGateway description: Retrieves information about a gateway. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeGatewayResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: gatewayId in: path required: true description: The ID of the gateway device. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 summary: Amazon IoT SiteWise Describe Gateway x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateGateway description: Updates a gateway's name. responses: '200': description: Success '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ConflictingOperationException content: application/json: schema: $ref: '#/components/schemas/ConflictingOperationException' '483': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: gatewayId in: path required: true description: The ID of the gateway to update. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 requestBody: required: true content: application/json: schema: type: object required: - gatewayName properties: gatewayName: description: 'A unique, friendly name for the gateway.' type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 maxLength: 256 summary: Amazon IoT SiteWise Update Gateway x-microcks-operation: delay: 0 dispatcher: FALLBACK '/portals/{portalId}': delete: operationId: DeletePortal description: Deletes a portal from IoT SiteWise Monitor. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/DeletePortalResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: ConflictingOperationException content: application/json: schema: $ref: '#/components/schemas/ConflictingOperationException' parameters: - name: portalId in: path required: true description: The ID of the portal to delete. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 - name: clientToken in: query required: false description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required. schema: type: string pattern: '\S{36,64}' minLength: 36 maxLength: 64 summary: Amazon IoT SiteWise Delete Portal x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: DescribePortal description: Retrieves information about a portal. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribePortalResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: portalId in: path required: true description: The ID of the portal. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 summary: Amazon IoT SiteWise Describe Portal x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdatePortal description: Updates an IoT SiteWise Monitor portal. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdatePortalResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: ConflictingOperationException content: application/json: schema: $ref: '#/components/schemas/ConflictingOperationException' parameters: - name: portalId in: path required: true description: The ID of the portal to update. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 requestBody: required: true content: application/json: schema: type: object required: - portalName - portalContactEmail - roleArn properties: portalName: description: A new friendly name for the portal. type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 maxLength: 256 portalDescription: description: A new description for the portal. type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 maxLength: 2048 portalContactEmail: description: The Amazon Web Services administrator's contact email address. type: string pattern: '[^@]+@[^@]+' minLength: 1 maxLength: 255 portalLogoImage: description: 'Contains an image that is one of the following:
An image file. Choose this option to upload a new image.
The ID of an existing image. Choose this option to keep an existing image.
Deletes a time series (data stream). If you delete a time series that''s associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.
To identify a time series, do one of the following:
If the time series isn''t associated with an asset property, specify the alias
of the time series.
If the time series is associated with an asset property, specify one of the following:
The alias of the time series.
The assetId and propertyId that identifies the asset property.
Retrieves information about an asset property.
When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation''s response includes the new default value.
This operation doesn''t return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeAssetPropertyResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: assetId in: path required: true description: The ID of the asset. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 - name: propertyId in: path required: true description: The ID of the asset property. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 summary: Amazon IoT SiteWise Describe Asset Property x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' put: operationId: UpdateAssetProperty description: 'Updates an asset property''s alias and notification state.
This operation overwrites the property''s existing alias and notification state. To keep your existing property''s alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.
The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
see Mapping industrial data streams to asset properties in the IoT SiteWise User
Guide.
If you omit this parameter, the alias is removed from the property.
' type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 propertyNotificationState: description: 'The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.
If you omit this parameter, the notification state is set to DISABLED.
assetModelProperty
in the asset model.'
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 256
summary: Amazon IoT SiteWise Update Asset Property
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/jobs/{jobId}':
get:
operationId: DescribeBulkImportJob
description: 'Retrieves information about a bulk import job request. For more information, see Describe
a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeBulkImportJobResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: jobId
in: path
required: true
description: The ID of the job.
schema:
type: string
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
minLength: 36
maxLength: 36
summary: Amazon IoT SiteWise Describe Bulk Import Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/configuration/account/encryption:
get:
operationId: DescribeDefaultEncryptionConfiguration
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'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters: []
summary: Amazon IoT SiteWise Describe Default Encryption Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
post:
operationId: PutDefaultEncryptionConfiguration
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'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'484':
description: ConflictingOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictingOperationException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- encryptionType
properties:
encryptionType:
description: The type of encryption used for the encryption configuration.
type: string
enum:
- SITEWISE_DEFAULT_ENCRYPTION
- KMS_BASED_ENCRYPTION
kmsKeyId:
description: The Key ID of the customer managed key used for KMS encryption. This is required if you use KMS_BASED_ENCRYPTION.
type: string
minLength: 1
maxLength: 2048
summary: Amazon IoT SiteWise Put Default Encryption Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/20200301/gateways/{gatewayId}/capability/{capabilityNamespace}':
get:
operationId: DescribeGatewayCapabilityConfiguration
description: 'Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source
configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations
for a gateway, use DescribeGateway.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeGatewayCapabilityConfigurationResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: gatewayId
in: path
required: true
description: The ID of the gateway that defines the capability configuration.
schema:
type: string
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
minLength: 36
maxLength: 36
- name: capabilityNamespace
in: path
required: true
description: 'The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version,
where version is a number such as 1.'
schema:
type: string
pattern: '^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$'
minLength: 1
maxLength: 512
summary: Amazon IoT SiteWise Describe Gateway Capability Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/logging:
get:
operationId: DescribeLoggingOptions
description: Retrieves the current IoT SiteWise logging options.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeLoggingOptionsResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters: []
summary: Amazon IoT SiteWise Describe Logging Options
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
put:
operationId: PutLoggingOptions
description: Sets logging options for IoT SiteWise.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutLoggingOptionsResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'483':
description: ConflictingOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictingOperationException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- loggingOptions
properties:
loggingOptions:
description: Contains logging options.
type: object
properties:
level:
allOf:
- $ref: '#/components/schemas/LoggingLevel'
- description: The IoT SiteWise logging verbosity level.
summary: Amazon IoT SiteWise Put Logging Options
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/configuration/account/storage:
get:
operationId: DescribeStorageConfiguration
description: Retrieves information about the storage configuration for IoT SiteWise.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeStorageConfigurationResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'485':
description: ConflictingOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictingOperationException'
parameters: []
summary: Amazon IoT SiteWise Describe Storage Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
post:
operationId: PutStorageConfiguration
description: Configures storage settings for IoT SiteWise.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutStorageConfigurationResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'485':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'486':
description: ConflictingOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictingOperationException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- storageType
properties:
storageType:
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.
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.
' type: string enum: - ENABLED - DISABLED retentionPeriod: description: 'How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.' type: object properties: numberOfDays: allOf: - $ref: '#/components/schemas/NumberOfDays' - description: 'The number of days that your data is kept.
If you specified a value for this parameter, the unlimited parameter must be false.
If true, your data is kept indefinitely.
If configured to true, you must not specify a value for the numberOfDays parameter.
Retrieves information about a time series (data stream).
To identify a time series, do one of the following:
If the time series isn''t associated with an asset
property, specify the alias of the time series.
If the time series is associated with an asset property, specify one of the following:
The alias
of the time series.
The assetId and propertyId that identifies the asset property.
Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId
of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property''s
alias, see UpdateAssetProperty.
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.'
schema:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
- name: aggregateTypes
in: query
required: true
description: The data aggregating function.
schema:
type: array
items:
$ref: '#/components/schemas/AggregateType'
minItems: 1
- name: resolution
in: query
required: true
description: The time interval over which to aggregate data.
schema:
type: string
pattern: 1m|15m|1h|1d
minLength: 2
maxLength: 3
- name: qualities
in: query
required: false
description: The quality by which to filter asset data.
schema:
type: array
items:
$ref: '#/components/schemas/Quality'
minItems: 1
maxItems: 1
- name: startDate
in: query
required: true
description: 'The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.'
schema:
type: string
format: date-time
- name: endDate
in: query
required: true
description: 'The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.'
schema:
type: string
format: date-time
- name: timeOrdering
in: query
required: false
description: 'The chronological sorting order of the requested information.
Default: ASCENDING
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 1 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 250.
Gets an asset property''s current value. For more information, see Querying current values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId
of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property''s
alias, see UpdateAssetProperty.
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.'
schema:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
summary: Amazon IoT SiteWise Get Asset Property Value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/properties/history:
get:
operationId: GetAssetPropertyValueHistory
description: 'Gets the history of an asset property''s values. For more information, see Querying historical values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId
of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property''s
alias, see UpdateAssetProperty.
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.'
schema:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
- name: startDate
in: query
required: false
description: 'The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.'
schema:
type: string
format: date-time
- name: endDate
in: query
required: false
description: 'The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.'
schema:
type: string
format: date-time
- name: qualities
in: query
required: false
description: The quality by which to filter asset data.
schema:
type: array
items:
$ref: '#/components/schemas/Quality'
minItems: 1
maxItems: 1
- name: timeOrdering
in: query
required: false
description: 'The chronological sorting order of the requested information.
Default: ASCENDING
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 4 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 20000.
Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.
For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property''s alias, see UpdateAssetProperty.
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.'
schema:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
- name: startTimeInSeconds
in: query
required: true
description: 'The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.'
schema:
type: integer
minimum: 1
maximum: 9223372036854774
- name: startTimeOffsetInNanos
in: query
required: false
description: The nanosecond offset converted from startTimeInSeconds.
schema:
type: integer
minimum: 0
maximum: 999999999
- name: endTimeInSeconds
in: query
required: true
description: 'The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.'
schema:
type: integer
minimum: 1
maximum: 9223372036854774
- name: endTimeOffsetInNanos
in: query
required: false
description: The nanosecond offset converted from endTimeInSeconds.
schema:
type: integer
minimum: 0
maximum: 999999999
- name: quality
in: query
required: true
description: The quality of the asset property value. You can use this parameter as a filter to choose only the asset property values that have a specific quality.
schema:
type: string
enum:
- GOOD
- BAD
- UNCERTAIN
- name: intervalInSeconds
in: query
required: true
description: The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.
schema:
type: integer
minimum: 1
maximum: 320000000
- name: nextToken
in: query
required: false
description: The token to be used for the next set of paginated results.
schema:
type: string
pattern: '[A-Za-z0-9+/=]+'
minLength: 1
maxLength: 4096
- name: maxResults
in: query
required: false
description: 'The maximum number of results to return for each paginated request. If not specified, the default value is 10.'
schema:
type: integer
minimum: 1
- name: type
in: query
required: true
description: 'The interpolation type.
Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION
LINEAR_INTERPOLATION – Estimates missing data
using linear interpolation.
For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9 AM, and so on.
LOCF_INTERPOLATION – Estimates missing data using last observation carried forward interpolation
If no data point is found for an interval, IoT SiteWise returns the last observed data point for the previous interval and carries forward this interpolated value until a new data point is found.
For example, you can get the state of an on-off valve every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first interpolated value. If a data point isn''t found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.
The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by using data points from the timestamp of each interval, minus the window to the timestamp of each interval plus the window. If not specified, the window ranges between the start time minus the interval and the end time plus the interval.
If you specify a value
for the intervalWindowInSeconds parameter, the value for the type parameter must be LINEAR_INTERPOLATION.
If a data point isn''t found during the specified query window, IoT SiteWise won''t return an interpolated value for the interval. This indicates that there''s a gap in the ingested data points.
For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the second interpolated value, and so on.
' schema: type: integer minimum: 1 maximum: 320000000 summary: Amazon IoT SiteWise Get Interpolated Asset Property Values x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' '/asset-models/{assetModelId}/properties': get: operationId: ListAssetModelProperties description: 'Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListAssetModelPropertiesResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: assetModelId in: path required: true description: The ID of the asset model. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 - name: nextToken in: query required: false description: The token to be used for the next set of paginated results. schema: type: string pattern: '[A-Za-z0-9+/=]+' minLength: 1 maxLength: 4096 - name: maxResults in: query required: false description: 'The maximum number of results to return for each paginated request. If not specified, the default value is 50.' schema: type: integer minimum: 1 maximum: 250 - name: filter in: query required: false description: 'Filters the requested list of asset model properties. You can choose one of the following options:
ALL – The list includes all asset model properties
for a given asset model ID.
BASE – The list includes only base asset model properties for a given asset model ID.
Default: BASE
Filters the requested list of asset properties. You can choose one of the following options:
ALL – The list includes all asset properties for a given
asset model ID.
BASE – The list includes only base asset properties for a given asset model ID.
Default: BASE
The type of traversal to use to identify asset relationships. Choose the following option:
PATH_TO_ROOT – Identify the asset''s parent assets up to
the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.
Retrieves a paginated list of associated assets.
You can use this operation to do the following:
List child assets associated to a parent asset by a hierarchy that you specify.
List an asset''s parent asset.
The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset
or DescribeAssetModel operations. This parameter is required if you choose CHILD
for traversalDirection.
For more information, see Asset hierarchies in the IoT SiteWise User Guide.
' schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 - name: traversalDirection in: query required: false description: 'The direction to list associated assets. Choose one of the following options:
CHILD – The list includes all child assets associated to the asset.
The hierarchyId parameter is required if you choose CHILD.
PARENT – The list includes the asset''s parent asset.
Default:
CHILD
The maximum number of results to return for each paginated request.
Default: 50
' schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT SiteWise List Associated Assets x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /dashboards#projectId: get: operationId: ListDashboards description: Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDashboardsResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: projectId in: query required: true description: The ID of the project. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 - name: nextToken in: query required: false description: The token to be used for the next set of paginated results. schema: type: string pattern: '[A-Za-z0-9+/=]+' minLength: 1 maxLength: 4096 - name: maxResults in: query required: false description: 'The maximum number of results to return for each paginated request.
Default: 50
' schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT SiteWise List Dashboards x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' '/projects/{projectId}/assets': get: operationId: ListProjectAssets description: Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListProjectAssetsResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: projectId in: path required: true description: The ID of the project. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 - name: nextToken in: query required: false description: The token to be used for the next set of paginated results. schema: type: string pattern: '[A-Za-z0-9+/=]+' minLength: 1 maxLength: 4096 - name: maxResults in: query required: false description: 'The maximum number of results to return for each paginated request.
Default: 50
' schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT SiteWise List Project Assets x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /projects#portalId: get: operationId: ListProjects description: Retrieves a paginated list of projects for an IoT SiteWise Monitor portal. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListProjectsResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: portalId in: query required: true description: The ID of the portal. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 - name: nextToken in: query required: false description: The token to be used for the next set of paginated results. schema: type: string pattern: '[A-Za-z0-9+/=]+' minLength: 1 maxLength: 4096 - name: maxResults in: query required: false description: 'The maximum number of results to return for each paginated request.
Default: 50
' schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT SiteWise List Projects x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /tags#resourceArn: get: operationId: ListTagsForResource description: Retrieves the list of tags for an IoT SiteWise resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: ConflictingOperationException content: application/json: schema: $ref: '#/components/schemas/ConflictingOperationException' '485': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '486': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' parameters: - name: resourceArn in: query required: true description: 'The ARN of the resource.' schema: type: string minLength: 1 maxLength: 1011 summary: Amazon IoT SiteWise List Tags for Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' post: operationId: TagResource description: 'Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag''s value.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: ConflictingOperationException content: application/json: schema: $ref: '#/components/schemas/ConflictingOperationException' '485': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '486': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '487': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' parameters: - name: resourceArn in: query required: true description: 'The ARN of the resource to tag.' schema: type: string minLength: 1 maxLength: 1011 requestBody: required: true content: application/json: schema: type: object required: - tags properties: tags: description: 'A list of key-value pairs that contain metadata for the resource. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.' type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' summary: Amazon IoT SiteWise Tag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK /timeseries/: get: operationId: ListTimeSeries description: Retrieves a paginated list of time series (data streams). responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTimeSeriesResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: nextToken in: query required: false description: The token to be used for the next set of paginated results. schema: type: string pattern: '[A-Za-z0-9+/=]+' minLength: 1 maxLength: 4096 - name: maxResults in: query required: false description: The maximum number of results to return for each paginated request. schema: type: integer minimum: 1 maximum: 250 - name: assetId in: query required: false description: The ID of the asset in which the asset property was created. schema: type: string pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' minLength: 36 maxLength: 36 - name: aliasPrefix in: query required: false description: The alias prefix of the time series. schema: type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 - name: timeSeriesType in: query required: false description: 'The type of the time series. The time series type can be one of the following values:
ASSOCIATED – The time series is associated with an asset property.
DISASSOCIATED – The time series isn''t associated with any asset property.
iotsitewise:opcuacollector:version, where version is a number such as 1.'
type: string
pattern: '^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$'
minLength: 1
maxLength: 512
capabilityConfiguration:
description: 'The JSON document that defines the configuration for the gateway capability. For more information, see Configuring
data sources (CLI) in the IoT SiteWise User Guide.'
type: string
minLength: 1
maxLength: 104857600
summary: Amazon IoT SiteWise Update Gateway Capability Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
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-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-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
schemas:
InvalidRequestException: {}
ResourceAlreadyExistsException: {}
ResourceNotFoundException: {}
InternalFailureException: {}
LimitExceededException: {}
ThrottlingException: {}
ConflictingOperationException: {}
BatchAssociateProjectAssetsResponse:
type: object
properties:
errors:
allOf:
- $ref: '#/components/schemas/BatchAssociateProjectAssetsErrors'
- description: 'A list of associated error information, if any.'
ID:
type: string
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
minLength: 36
maxLength: 36
BatchDisassociateProjectAssetsResponse:
type: object
properties:
errors:
allOf:
- $ref: '#/components/schemas/BatchDisassociateProjectAssetsErrors'
- description: 'A list of associated error information, if any.'
BatchGetAssetPropertyAggregatesResponse:
type: object
required:
- errorEntries
- successEntries
- skippedEntries
properties:
errorEntries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyAggregatesErrorEntries'
- description: A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
successEntries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyAggregatesSuccessEntries'
- description: A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query
result.
skippedEntries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyAggregatesSkippedEntries'
- description: A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry
contains the entryId of the entry that skipped.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'The token for the next set of results, or null if there are no additional results.'
BatchGetAssetPropertyAggregatesEntry:
type: object
required:
- entryId
- aggregateTypes
- resolution
- startDate
- endDate
properties:
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The ID of the entry.
assetId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset in which the asset property was created.
propertyId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset property.
propertyAlias:
allOf:
- $ref: '#/components/schemas/AssetPropertyAlias'
- description: 'The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see
Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.'
aggregateTypes:
allOf:
- $ref: '#/components/schemas/AggregateTypes'
- description: The data aggregating function.
resolution:
allOf:
- $ref: '#/components/schemas/Resolution'
- description: The time interval over which to aggregate data.
startDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.'
endDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.'
qualities:
allOf:
- $ref: '#/components/schemas/Qualities'
- description: The quality by which to filter asset data.
timeOrdering:
allOf:
- $ref: '#/components/schemas/TimeOrdering'
- description: 'The chronological sorting order of the requested information.
Default: ASCENDING
Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A
propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property''s alias, see UpdateAssetProperty.
entryId of the entry that failed.
successEntries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueSuccessEntries'
- description: A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query
result.
skippedEntries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueSkippedEntries'
- description: A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry
contains the entryId of the entry that skipped.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'The token for the next set of results, or null if there are no additional results.'
BatchGetAssetPropertyValueEntry:
type: object
required:
- entryId
properties:
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The ID of the entry.
assetId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset in which the asset property was created.
propertyId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset property.
propertyAlias:
allOf:
- $ref: '#/components/schemas/AssetPropertyAlias'
- description: 'The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see
Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.'
description: 'Contains information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A
propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property''s alias, see UpdateAssetProperty.
entryId of the entry that failed.
successEntries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueHistorySuccessEntries'
- description: A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query
result.
skippedEntries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueHistorySkippedEntries'
- description: A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry
contains the entryId of the entry that skipped.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'The token for the next set of results, or null if there are no additional results.'
BatchGetAssetPropertyValueHistoryEntry:
type: object
required:
- entryId
properties:
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The ID of the entry.
assetId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset in which the asset property was created.
propertyId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset property.
propertyAlias:
allOf:
- $ref: '#/components/schemas/AssetPropertyAlias'
- description: 'The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see
Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.'
startDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.'
endDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.'
qualities:
allOf:
- $ref: '#/components/schemas/Qualities'
- description: The quality by which to filter asset data.
timeOrdering:
allOf:
- $ref: '#/components/schemas/TimeOrdering'
- description: 'The chronological sorting order of the requested information.
Default: ASCENDING
Contains information for an asset property historical value entry that is associated with the BatchGetAssetPropertyValueHistory API.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A
propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property''s alias, see UpdateAssetProperty.
entryId of the entry that failed.
PutAssetPropertyValueEntry:
type: object
required:
- entryId
- propertyValues
properties:
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The user specified ID for the entry. You can use this ID to identify which entries failed.
assetId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset to update.
propertyId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset property for this entry.
propertyAlias:
allOf:
- $ref: '#/components/schemas/AssetPropertyAlias'
- description: 'The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see
Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.'
propertyValues:
allOf:
- $ref: '#/components/schemas/AssetPropertyValues'
- description: 'The list of property values to upload. You can specify up to 10 propertyValues array elements. '
description: 'Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValue
API operation.'
CreateAccessPolicyResponse:
type: object
required:
- accessPolicyId
- accessPolicyArn
properties:
accessPolicyId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the access policy.
accessPolicyArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: 'The ARN of the access policy, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide.
If you delete the IAM user, access policies that contain this identity include an empty arn. You can delete the access policy for the IAM user that no longer exists.
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
CREATING after successfully calling this operation) and any error message.'
CreateAssetModelResponse:
type: object
required:
- assetModelId
- assetModelArn
- assetModelStatus
properties:
assetModelId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset model. You can use this ID when you call other IoT SiteWise APIs.
assetModelArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: 'The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
CREATING after successfully calling this operation) and any error message.'
AssetModelPropertyDefinition:
type: object
required:
- name
- dataType
- type
properties:
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the property definition.
dataType:
allOf:
- $ref: '#/components/schemas/PropertyDataType'
- description: 'The data type of the property definition.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for
this property.
The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.
The options for this
parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.
Newtons or RPM.'
type:
allOf:
- $ref: '#/components/schemas/PropertyType'
- description: The property definition type (see PropertyType). You can only specify one type in a property definition.
description: Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
AssetModelHierarchyDefinition:
type: object
required:
- name
- childAssetModelId
properties:
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'The name of the asset model hierarchy definition (as specified in the CreateAssetModel
or UpdateAssetModel API operation).'
childAssetModelId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of an asset model for this hierarchy.
description: Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy.
AssetModelCompositeModelDefinition:
type: object
required:
- name
- type
properties:
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the composite model.
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: The description of the composite model.
type:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'The type of the composite model. For alarm composite models, this type is AWS/ALARM.'
properties:
description: The asset property definitions for this composite model.
description: Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.
CreateBulkImportJobResponse:
type: object
required:
- jobId
- jobName
- jobStatus
properties:
jobId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the job.
jobName:
allOf:
- $ref: '#/components/schemas/Name'
- description: The unique name that helps identify the job request.
jobStatus:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: The status of the bulk import job can be one of following values.
PENDING – IoT SiteWise is waiting for the current bulk import job to
finish.
CANCELLED – The bulk import job has been canceled.
RUNNING – IoT SiteWise is processing your request to import
your data from Amazon S3.
COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.
FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot
issues.
COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified
error report location in Amazon S3 to troubleshoot issues.
The ARN of the dashboard, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
The ARN of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
AWSIoTSiteWiseEdgeAccess policy. For more information,
see Using IoT SiteWise at the edge in the IoT SiteWise User Guide.'
CreatePortalResponse:
type: object
required:
- portalId
- portalArn
- portalStartUrl
- portalStatus
- ssoApplicationId
properties:
portalId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the created portal.
portalArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: 'The ARN of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
CREATING after successfully calling this operation) and any error message.'
ssoApplicationId:
allOf:
- $ref: '#/components/schemas/SSOApplicationId'
- description: 'The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.'
ImageFileData:
type: string
minLength: 1
maxLength: 1500000
ImageFileType:
type: string
enum:
- PNG
ARN:
type: string
pattern: .*
minLength: 1
maxLength: 1600
CreateProjectResponse:
type: object
required:
- projectId
- projectArn
properties:
projectId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the project.
projectArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: 'The ARN of the project, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
DELETING after successfully calling this operation) and any error message.'
DeleteAssetModelResponse:
type: object
required:
- assetModelStatus
properties:
assetModelStatus:
allOf:
- $ref: '#/components/schemas/AssetModelStatus'
- description: 'The status of the asset model, which contains a state (DELETING after successfully calling this operation) and any error message.'
DeleteDashboardResponse:
type: object
properties: {}
DeletePortalResponse:
type: object
required:
- portalStatus
properties:
portalStatus:
allOf:
- $ref: '#/components/schemas/PortalStatus'
- description: 'The status of the portal, which contains a state (DELETING after successfully calling this operation) and any error message.'
DeleteProjectResponse:
type: object
properties: {}
DescribeAccessPolicyResponse:
type: object
required:
- accessPolicyId
- accessPolicyArn
- accessPolicyIdentity
- accessPolicyResource
- accessPolicyPermission
- accessPolicyCreationDate
- accessPolicyLastUpdateDate
properties:
accessPolicyId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the access policy.
accessPolicyArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: 'The ARN of the access policy, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
ADMINISTRATOR is also known as a project owner.
accessPolicyCreationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date the access policy was created, in Unix epoch time.'
accessPolicyLastUpdateDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date the access policy was last updated, in Unix epoch time.'
DescribeAssetResponse:
type: object
required:
- assetId
- assetArn
- assetName
- assetModelId
- assetProperties
- assetHierarchies
- assetCreationDate
- assetLastUpdateDate
- assetStatus
properties:
assetId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset.
assetArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: 'The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
The list of asset properties for the asset.
This object doesn't include properties that you define in composite models. You can find composite model properties in
the assetCompositeModels object.
hierarchyId. A hierarchy specifies allowed parent/child asset relationships.
assetCompositeModels:
allOf:
- $ref: '#/components/schemas/AssetCompositeModels'
- description: The composite models for the asset.
assetCreationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date the asset was created, in Unix epoch time.'
assetLastUpdateDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date the asset was last updated, in Unix epoch time.'
assetStatus:
allOf:
- $ref: '#/components/schemas/AssetStatus'
- description: 'The current status of the asset, which contains a state and any error message.'
assetDescription:
allOf:
- $ref: '#/components/schemas/Description'
- description: A description for the asset.
DescribeAssetModelResponse:
type: object
required:
- assetModelId
- assetModelArn
- assetModelName
- assetModelDescription
- assetModelProperties
- assetModelHierarchies
- assetModelCreationDate
- assetModelLastUpdateDate
- assetModelStatus
properties:
assetModelId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset model.
assetModelArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: 'The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
The list of asset properties for the asset model.
This object doesn't include properties that you define in composite models. You can find composite model properties
in the assetModelCompositeModels object.
childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed
parent/child asset relationships for an asset model.
assetModelCompositeModels:
allOf:
- $ref: '#/components/schemas/AssetModelCompositeModels'
- description: The list of composite asset models for the asset model.
assetModelCreationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date the asset model was created, in Unix epoch time.'
assetModelLastUpdateDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date the asset model was last updated, in Unix epoch time.'
assetModelStatus:
allOf:
- $ref: '#/components/schemas/AssetModelStatus'
- description: 'The current status of the asset model, which contains a state and any error message.'
DescribeAssetPropertyResponse:
type: object
required:
- assetId
- assetName
- assetModelId
properties:
assetId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset.
assetName:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the asset.
assetModelId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset model.
assetProperty:
allOf:
- $ref: '#/components/schemas/Property'
- description: 'The asset property''s definition, alias, and notification state.
This response includes this object for normal asset properties. If you describe an asset property in
a composite model, this response includes the asset property information in compositeModel.
The status of the bulk import job can be one of following values.
PENDING – IoT SiteWise is waiting for the current bulk import job to
finish.
CANCELLED – The bulk import job has been canceled.
RUNNING – IoT SiteWise is processing your request to import
your data from Amazon S3.
COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.
FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot
issues.
COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified
error report location in Amazon S3 to troubleshoot issues.
The ARN of the dashboard, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
KMS_BASED_ENCRYPTION.
configurationStatus:
allOf:
- $ref: '#/components/schemas/ConfigurationStatus'
- description: 'The status of the account configuration. This contains the ConfigurationState. If there''s an error, it also contains the ErrorDetails.'
DescribeGatewayResponse:
type: object
required:
- gatewayId
- gatewayName
- gatewayArn
- gatewayCapabilitySummaries
- creationDate
- lastUpdateDate
properties:
gatewayId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the gateway device.
gatewayName:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the gateway.
gatewayArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: 'The ARN of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the
capability configuration.
OUT_OF_SYNC – The gateway hasn''t received the capability configuration.
SYNC_FAILED – The gateway
rejected the capability configuration.
The ARN of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
portalClientId for only portals that use IAM
Identity Center to authenticate users.
portalStartUrl:
allOf:
- $ref: '#/components/schemas/Url'
- description: 'The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication,
you must use the IoT SiteWise console to get a URL that you can use to access the portal.'
portalContactEmail:
allOf:
- $ref: '#/components/schemas/Email'
- description: The Amazon Web Services administrator's contact email address.
portalStatus:
allOf:
- $ref: '#/components/schemas/PortalStatus'
- description: 'The current status of the portal, which contains a state and any error message.'
portalCreationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date the portal was created, in Unix epoch time.'
portalLastUpdateDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date the portal was last updated, in Unix epoch time.'
portalLogoImageLocation:
allOf:
- $ref: '#/components/schemas/ImageLocation'
- description: 'The portal''s logo image, which is available at a URL.'
roleArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: 'The ARN of the service role that allows the portal''s users to access your IoT SiteWise
resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor
in the IoT SiteWise User Guide.'
portalAuthMode:
allOf:
- $ref: '#/components/schemas/AuthMode'
- description: The service to use to authenticate users to the portal.
notificationSenderEmail:
allOf:
- $ref: '#/components/schemas/Email'
- description: The email address that sends alarm notifications.
alarms:
allOf:
- $ref: '#/components/schemas/Alarms'
- description: Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
DescribeProjectResponse:
type: object
required:
- projectId
- projectArn
- projectName
- portalId
- projectCreationDate
- projectLastUpdateDate
properties:
projectId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the project.
projectArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: 'The ARN of the project, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
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.
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: allOf: - $ref: '#/components/schemas/RetentionPeriod' - description: 'How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.' configurationStatus: $ref: '#/components/schemas/ConfigurationStatus' lastUpdateDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The date the storage configuration was last updated, in Unix epoch time.' DescribeTimeSeriesResponse: type: object required: - timeSeriesId - dataType - timeSeriesCreationDate - timeSeriesLastUpdateDate - timeSeriesArn properties: assetId: allOf: - $ref: '#/components/schemas/ID' - description: The ID of the asset in which the asset property was created. propertyId: allOf: - $ref: '#/components/schemas/ID' - description: The ID of the asset property. alias: allOf: - $ref: '#/components/schemas/PropertyAlias' - description: The alias that identifies the time series. timeSeriesId: allOf: - $ref: '#/components/schemas/TimeSeriesId' - description: The ID of the time series. dataType: allOf: - $ref: '#/components/schemas/PropertyDataType' - description: 'The data type of the time series.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this time
series.
The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.
The options for this
parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in
alarm composite models.
The ARN of the time series, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
KMS_BASED_ENCRYPTION.
configurationStatus:
allOf:
- $ref: '#/components/schemas/ConfigurationStatus'
- description: 'The status of the account configuration. This contains the ConfigurationState. If there is an error, it also contains the ErrorDetails.'
PutLoggingOptionsResponse:
type: object
properties: {}
LoggingLevel:
type: string
enum:
- ERROR
- INFO
- 'OFF'
PutStorageConfigurationResponse:
type: object
required:
- storageType
- configurationStatus
properties:
storageType:
allOf:
- $ref: '#/components/schemas/StorageType'
- 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.
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' CustomerManagedS3Storage: type: object required: - s3ResourceArn - roleArn properties: s3ResourceArn: allOf: - $ref: '#/components/schemas/ARN' - 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: allOf: - $ref: '#/components/schemas/ARN' - description: 'The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.' description: Contains information about a customer managed Amazon S3 bucket. NumberOfDays: type: integer minimum: 30 Unlimited: type: boolean TagResourceResponse: type: object properties: {} TooManyTagsException: {} UntagResourceResponse: type: object properties: {} TagKey: type: string minLength: 1 maxLength: 128 UpdateAccessPolicyResponse: type: object properties: {} UpdateAssetResponse: type: object required: - assetStatus properties: assetStatus: allOf: - $ref: '#/components/schemas/AssetStatus' - description: 'The status of the asset, which contains a state (UPDATING after successfully calling this operation) and any error message.'
UpdateAssetModelResponse:
type: object
required:
- assetModelStatus
properties:
assetModelStatus:
allOf:
- $ref: '#/components/schemas/AssetModelStatus'
- description: 'The status of the asset model, which contains a state (UPDATING after successfully calling this operation) and any error message.'
AssetModelProperty:
type: object
required:
- name
- dataType
- type
properties:
id:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset model property.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the asset model property.
dataType:
allOf:
- $ref: '#/components/schemas/PropertyDataType'
- description: The data type of the asset model property.
dataTypeSpec:
allOf:
- $ref: '#/components/schemas/Name'
- description: The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
unit:
allOf:
- $ref: '#/components/schemas/PropertyUnit'
- description: 'The unit of the asset model property, such as Newtons or RPM.'
type:
allOf:
- $ref: '#/components/schemas/PropertyType'
- description: The property type (see PropertyType).
description: Contains information about an asset model property.
AssetModelHierarchy:
type: object
required:
- name
- childAssetModelId
properties:
id:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset model hierarchy. This ID is a hierarchyId.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'The name of the asset model hierarchy that you specify by using the CreateAssetModel
or UpdateAssetModel API operation.'
childAssetModelId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset model. All assets in this hierarchy must be instances of the childAssetModelId asset model.
description: 'Describes an asset hierarchy that contains a hierarchy''s name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.'
AssetModelCompositeModel:
type: object
required:
- name
- type
properties:
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the composite model.
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: The description of the composite model.
type:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'The type of the composite model. For alarm composite models, this type is AWS/ALARM.'
properties:
description: The asset property definitions for this composite model.
id:
allOf:
- $ref: '#/components/schemas/ID'
- description: ' The ID of the asset model composite model. '
description: Contains information about a composite model in an asset model. This object contains the asset property definitions that you define in the composite model.
UpdateDashboardResponse:
type: object
properties: {}
UpdateGatewayCapabilityConfigurationResponse:
type: object
required:
- capabilityNamespace
- capabilitySyncStatus
properties:
capabilityNamespace:
allOf:
- $ref: '#/components/schemas/CapabilityNamespace'
- description: The namespace of the gateway capability.
capabilitySyncStatus:
allOf:
- $ref: '#/components/schemas/CapabilitySyncStatus'
- description: 'The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the
capability configuration.
OUT_OF_SYNC – The gateway hasn''t received the capability configuration.
SYNC_FAILED – The gateway
rejected the capability configuration.
After you update a capability configuration, its sync status is OUT_OF_SYNC until the gateway receives and applies or
rejects the updated configuration.
UPDATING after successfully calling this operation) and any error message.'
ImageFile:
type: object
required:
- data
- type
properties:
data:
allOf:
- $ref: '#/components/schemas/ImageFileData'
- description: 'The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.'
type:
allOf:
- $ref: '#/components/schemas/ImageFileType'
- description: The file type of the image.
description: Contains an image file.
UpdateProjectResponse:
type: object
properties: {}
AccessPolicySummary:
type: object
required:
- id
- identity
- resource
- permission
properties:
id:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the access policy.
identity:
allOf:
- $ref: '#/components/schemas/Identity'
- description: 'The identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user).'
resource:
allOf:
- $ref: '#/components/schemas/Resource'
- description: The IoT SiteWise Monitor resource (a portal or project).
permission:
allOf:
- $ref: '#/components/schemas/Permission'
- description: The permissions for the access policy. Note that a project ADMINISTRATOR is also known as a project owner.
creationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date the access policy was created, in Unix epoch time.'
lastUpdateDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date the access policy was last updated, in Unix epoch time.'
description: Contains an access policy that defines an identity's access to an IoT SiteWise Monitor resource.
AccessPolicySummaries:
type: array
items:
$ref: '#/components/schemas/AccessPolicySummary'
Identity:
type: object
properties:
user:
allOf:
- $ref: '#/components/schemas/UserIdentity'
- description: An IAM Identity Center user identity.
group:
allOf:
- $ref: '#/components/schemas/GroupIdentity'
- description: An IAM Identity Center group identity.
iamUser:
allOf:
- $ref: '#/components/schemas/IAMUserIdentity'
- description: An IAM user identity.
iamRole:
allOf:
- $ref: '#/components/schemas/IAMRoleIdentity'
- description: An IAM role identity.
description: 'Contains an identity that can access an IoT SiteWise Monitor resource.
Currently, you can''t use Amazon Web Services APIs to retrieve IAM Identity Center identity IDs. You can find the IAM Identity Center identity IDs in the URL of user and group pages in the IAM Identity Center console.
AWS/ALARM.'
properties:
description: The asset properties that this composite model defines.
id:
allOf:
- $ref: '#/components/schemas/ID'
- description: ' The ID of the asset composite model. '
description: Contains information about a composite model in an asset. This object contains the asset's properties that you define in the composite model.
AssetCompositeModels:
type: array
items:
$ref: '#/components/schemas/AssetCompositeModel'
AssetErrorCode:
type: string
enum:
- INTERNAL_FAILURE
AssetErrorMessage:
type: string
AssetErrorDetails:
type: object
required:
- assetId
- code
- message
properties:
assetId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset.
code:
allOf:
- $ref: '#/components/schemas/AssetErrorCode'
- description: The error code.
message:
allOf:
- $ref: '#/components/schemas/AssetErrorMessage'
- description: The error message.
description: Contains error details for the requested associate project asset action.
AssetHierarchy:
type: object
required:
- name
properties:
id:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the hierarchy. This ID is a hierarchyId.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'The hierarchy name provided in the CreateAssetModel or UpdateAssetModel
API operation.'
description: Describes an asset hierarchy that contains a hierarchy's name and ID.
AssetHierarchies:
type: array
items:
$ref: '#/components/schemas/AssetHierarchy'
AssetHierarchyInfo:
type: object
properties:
parentAssetId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the parent asset in this asset relationship.
childAssetId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the child asset in this asset relationship.
description: Contains information about a parent asset and a child asset that are related through an asset hierarchy.
AssetIDs:
type: array
items:
$ref: '#/components/schemas/ID'
AssetModelCompositeModelDefinitions:
type: array
items:
$ref: '#/components/schemas/AssetModelCompositeModelDefinition'
AssetModelCompositeModels:
type: array
items:
$ref: '#/components/schemas/AssetModelCompositeModel'
AssetModelHierarchies:
type: array
items:
$ref: '#/components/schemas/AssetModelHierarchy'
AssetModelHierarchyDefinitions:
type: array
items:
$ref: '#/components/schemas/AssetModelHierarchyDefinition'
AssetModelProperties:
type: array
items:
$ref: '#/components/schemas/AssetModelProperty'
PropertyDataType:
type: string
enum:
- STRING
- INTEGER
- DOUBLE
- BOOLEAN
- STRUCT
PropertyUnit:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 256
PropertyType:
type: object
properties:
attribute:
allOf:
- $ref: '#/components/schemas/Attribute'
- description: 'Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT
wind turbine.'
measurement:
allOf:
- $ref: '#/components/schemas/Measurement'
- description: 'Specifies an asset measurement property. A measurement represents a device''s raw sensor data stream, such as timestamped temperature values or timestamped power values.'
transform:
allOf:
- $ref: '#/components/schemas/Transform'
- description: 'Specifies an asset transform property. A transform contains a mathematical expression that maps a property''s data points from one form to another, such as a unit conversion from
Celsius to Fahrenheit.'
metric:
allOf:
- $ref: '#/components/schemas/Metric'
- description: 'Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a
single data point, such as to calculate the average hourly temperature.'
description: 'Contains a property type, which can be one of attribute, measurement, metric, or transform.'
AssetModelPropertyDefinitions:
type: array
items:
$ref: '#/components/schemas/AssetModelPropertyDefinition'
AssetModelPropertySummary:
type: object
required:
- name
- dataType
- type
properties:
id:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the property.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the property.
dataType:
allOf:
- $ref: '#/components/schemas/PropertyDataType'
- description: The data type of the property.
dataTypeSpec:
allOf:
- $ref: '#/components/schemas/Name'
- description: The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
unit:
allOf:
- $ref: '#/components/schemas/PropertyUnit'
- description: The unit (such as Newtons or RPM) of the property.
type:
$ref: '#/components/schemas/PropertyType'
assetModelCompositeModelId:
allOf:
- $ref: '#/components/schemas/ID'
- description: ' The ID of the composite model that contains the asset model property. '
description: Contains a summary of a property associated with a model.
AssetModelPropertySummaries:
type: array
items:
$ref: '#/components/schemas/AssetModelPropertySummary'
AssetModelState:
type: string
enum:
- CREATING
- ACTIVE
- UPDATING
- PROPAGATING
- DELETING
- FAILED
ErrorDetails:
type: object
required:
- code
- message
properties:
code:
allOf:
- $ref: '#/components/schemas/ErrorCode'
- description: The error code.
message:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
- description: The error message.
details:
allOf:
- $ref: '#/components/schemas/DetailedErrors'
- description: ' A list of detailed errors. '
description: Contains the details of an IoT SiteWise error.
AssetModelStatus:
type: object
required:
- state
properties:
state:
allOf:
- $ref: '#/components/schemas/AssetModelState'
- description: The current state of the asset model.
error:
allOf:
- $ref: '#/components/schemas/ErrorDetails'
- description: 'Contains associated error information, if any.'
description: 'Contains current status information for an asset model. For more information, see Asset
and model states in the IoT SiteWise User Guide.'
AssetModelSummary:
type: object
required:
- id
- arn
- name
- description
- creationDate
- lastUpdateDate
- status
properties:
id:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset model (used with IoT SiteWise APIs).
arn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: 'The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
/company/windfarm/3/turbine/7/temperature). For more information, see
Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.'
notification:
allOf:
- $ref: '#/components/schemas/PropertyNotification'
- description: 'The asset property''s notification topic and state. For more information, see UpdateAssetProperty.'
dataType:
allOf:
- $ref: '#/components/schemas/PropertyDataType'
- description: The data type of the asset property.
dataTypeSpec:
allOf:
- $ref: '#/components/schemas/Name'
- description: The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
unit:
allOf:
- $ref: '#/components/schemas/PropertyUnit'
- description: The unit (such as Newtons or RPM) of the asset property.
description: Contains asset property information.
AssetProperties:
type: array
items:
$ref: '#/components/schemas/AssetProperty'
PropertyAlias:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
PropertyNotification:
type: object
required:
- topic
- state
properties:
topic:
allOf:
- $ref: '#/components/schemas/PropertyNotificationTopic'
- description: The MQTT topic to which IoT SiteWise publishes property value update notifications.
state:
allOf:
- $ref: '#/components/schemas/PropertyNotificationState'
- description: The current notification state.
description: 'Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information,
see Interacting with other services in the IoT SiteWise User Guide.'
AssetPropertyAlias:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
AssetPropertySummary:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the property.
alias:
allOf:
- $ref: '#/components/schemas/PropertyAlias'
- description: 'The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see
Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.'
unit:
allOf:
- $ref: '#/components/schemas/PropertyUnit'
- description: ' The unit of measure (such as Newtons or RPM) of the asset property. '
notification:
$ref: '#/components/schemas/PropertyNotification'
assetCompositeModelId:
allOf:
- $ref: '#/components/schemas/ID'
- description: ' The ID of the composite model that contains the asset property. '
description: Contains a summary of a property associated with an asset.
AssetPropertySummaries:
type: array
items:
$ref: '#/components/schemas/AssetPropertySummary'
Variant:
type: object
properties:
stringValue:
allOf:
- $ref: '#/components/schemas/PropertyValueStringValue'
- description: Asset property data of type string (sequence of characters).
integerValue:
allOf:
- $ref: '#/components/schemas/PropertyValueIntegerValue'
- description: Asset property data of type integer (whole number).
doubleValue:
allOf:
- $ref: '#/components/schemas/PropertyValueDoubleValue'
- description: Asset property data of type double (floating point number).
booleanValue:
allOf:
- $ref: '#/components/schemas/PropertyValueBooleanValue'
- description: Asset property data of type Boolean (true or false).
description: Contains an asset property value (of a single type only).
TimeInNanos:
type: object
required:
- timeInSeconds
properties:
timeInSeconds:
allOf:
- $ref: '#/components/schemas/TimeInSeconds'
- description: 'The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.'
offsetInNanos:
allOf:
- $ref: '#/components/schemas/OffsetInNanos'
- description: The nanosecond offset from timeInSeconds.
description: Contains a timestamp with optional nanosecond granularity.
AssetPropertyValue:
type: object
required:
- value
- timestamp
properties:
value:
allOf:
- $ref: '#/components/schemas/Variant'
- description: The value of the asset property (see Variant).
timestamp:
allOf:
- $ref: '#/components/schemas/TimeInNanos'
- description: The timestamp of the asset property value.
quality:
allOf:
- $ref: '#/components/schemas/Quality'
- description: The quality of the asset property value.
description: Contains asset property value information.
AssetPropertyValueHistory:
type: array
items:
$ref: '#/components/schemas/AssetPropertyValue'
AssetPropertyValues:
type: array
items:
$ref: '#/components/schemas/AssetPropertyValue'
AssetRelationshipSummary:
type: object
required:
- relationshipType
properties:
hierarchyInfo:
allOf:
- $ref: '#/components/schemas/AssetHierarchyInfo'
- description: The assets that are related through an asset hierarchy.
This object is present if the relationshipType is HIERARCHY.
The relationship type of the assets in this relationship. This value is one of the following:
HIERARCHY – The assets are related through an asset
hierarchy. If you specify this relationship type, this asset relationship includes the hierarchyInfo object.
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
hierarchyId. A hierarchy specifies allowed parent/child asset relationships.
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: A description for the asset.
description: Contains a summary of an asset.
AssetSummaries:
type: array
items:
$ref: '#/components/schemas/AssetSummary'
ClientToken:
type: string
pattern: '\S{36,64}'
minLength: 36
maxLength: 64
AssociateAssetsRequest:
type: object
required:
- hierarchyId
- childAssetId
title: AssociateAssetsRequest
properties:
hierarchyId:
allOf:
- $ref: '#/components/schemas/ID'
- description: 'The ID of a hierarchy in the parent asset''s model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information,
see Asset hierarchies in the IoT SiteWise User Guide.'
childAssetId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the child asset to be associated.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
AssociateTimeSeriesToAssetPropertyRequest:
type: object
title: AssociateTimeSeriesToAssetPropertyRequest
properties:
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
AssociatedAssetsSummary:
type: object
required:
- id
- arn
- name
- assetModelId
- creationDate
- lastUpdateDate
- status
- hierarchies
properties:
id:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset.
arn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: 'The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
hierarchyId. A hierarchy specifies allowed parent/child asset relationships.
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: A description for the asset.
description: Contains a summary of an associated asset.
AssociatedAssetsSummaries:
type: array
items:
$ref: '#/components/schemas/AssociatedAssetsSummary'
DefaultValue:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 1024
Attribute:
type: object
properties:
defaultValue:
allOf:
- $ref: '#/components/schemas/DefaultValue'
- description: 'The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute''s value after
you create an asset. For more information, see Updating attribute values in the IoT
SiteWise User Guide.'
description: 'Contains an asset attribute property. For more information, see Attributes in
the IoT SiteWise User Guide.'
AuthMode:
type: string
enum:
- IAM
- SSO
BatchAssociateProjectAssetsErrors:
type: array
items:
$ref: '#/components/schemas/AssetErrorDetails'
IDs:
type: array
items:
$ref: '#/components/schemas/ID'
minItems: 1
maxItems: 100
BatchAssociateProjectAssetsRequest:
type: object
required:
- assetIds
title: BatchAssociateProjectAssetsRequest
properties:
assetIds:
allOf:
- $ref: '#/components/schemas/IDs'
- description: The IDs of the assets to be associated to the project.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
BatchDisassociateProjectAssetsErrors:
type: array
items:
$ref: '#/components/schemas/AssetErrorDetails'
BatchDisassociateProjectAssetsRequest:
type: object
required:
- assetIds
title: BatchDisassociateProjectAssetsRequest
properties:
assetIds:
allOf:
- $ref: '#/components/schemas/IDs'
- description: The IDs of the assets to be disassociated from the project.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
BatchEntryCompletionStatus:
type: string
enum:
- SUCCESS
- ERROR
BatchGetAssetPropertyAggregatesEntries:
type: array
items:
$ref: '#/components/schemas/BatchGetAssetPropertyAggregatesEntry'
EntryId:
type: string
pattern: '^[a-zA-Z0-9_-]+$'
minLength: 1
maxLength: 64
Resolution:
type: string
pattern: 1m|15m|1h|1d
minLength: 2
maxLength: 3
Qualities:
type: array
items:
$ref: '#/components/schemas/Quality'
minItems: 1
maxItems: 1
TimeOrdering:
type: string
enum:
- ASCENDING
- DESCENDING
BatchGetAssetPropertyAggregatesErrorCode:
type: string
enum:
- ResourceNotFoundException
- InvalidRequestException
- AccessDeniedException
BatchGetAssetPropertyAggregatesErrorEntry:
type: object
required:
- errorCode
- errorMessage
- entryId
properties:
errorCode:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyAggregatesErrorCode'
- description: The error code.
errorMessage:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
- description: The associated error message.
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The ID of the entry.
description: 'Contains error information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates
API.'
BatchGetAssetPropertyAggregatesErrorEntries:
type: array
items:
$ref: '#/components/schemas/BatchGetAssetPropertyAggregatesErrorEntry'
ErrorMessage:
type: string
BatchGetAssetPropertyAggregatesErrorInfo:
type: object
required:
- errorCode
- errorTimestamp
properties:
errorCode:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyAggregatesErrorCode'
- description: The error code.
errorTimestamp:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date the error occurred, in Unix epoch time.'
description: 'Contains the error code and the timestamp for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates
API.'
BatchGetAssetPropertyAggregatesMaxResults:
type: integer
minimum: 1
NextToken:
type: string
pattern: '[A-Za-z0-9+/=]+'
minLength: 1
maxLength: 4096
BatchGetAssetPropertyAggregatesRequest:
type: object
required:
- entries
title: BatchGetAssetPropertyAggregatesRequest
properties:
entries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyAggregatesEntries'
- description: The list of asset property aggregate entries for the batch get request. You can specify up to 16 entries per request.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to be used for the next set of paginated results.
maxResults:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyAggregatesMaxResults'
- description: 'The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 1 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 4000.
entryId of the entry that failed.
BatchGetAssetPropertyValueHistoryErrorEntries:
type: array
items:
$ref: '#/components/schemas/BatchGetAssetPropertyValueHistoryErrorEntry'
BatchGetAssetPropertyValueHistoryErrorInfo:
type: object
required:
- errorCode
- errorTimestamp
properties:
errorCode:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueHistoryErrorCode'
- description: The error code.
errorTimestamp:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date the error occurred, in Unix epoch time.'
description: 'The error information, such as the error code and the timestamp.'
BatchGetAssetPropertyValueHistoryMaxResults:
type: integer
minimum: 1
BatchGetAssetPropertyValueHistoryRequest:
type: object
required:
- entries
title: BatchGetAssetPropertyValueHistoryRequest
properties:
entries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueHistoryEntries'
- description: The list of asset property historical value entries for the batch get request. You can specify up to 16 entries per request.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to be used for the next set of paginated results.
maxResults:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueHistoryMaxResults'
- description: 'The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 4 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 20000.
/company/windfarm/3/turbine/7/temperature). For more information, see
Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.'
notification:
allOf:
- $ref: '#/components/schemas/PropertyNotification'
- description: 'The asset property''s notification topic and state. For more information, see UpdateAssetProperty.'
dataType:
allOf:
- $ref: '#/components/schemas/PropertyDataType'
- description: The property data type.
unit:
allOf:
- $ref: '#/components/schemas/PropertyUnit'
- description: The unit (such as Newtons or RPM) of the asset property.
type:
allOf:
- $ref: '#/components/schemas/PropertyType'
- description: The property type (see PropertyType). A property contains one type.
description: Contains asset property information.
CompositeModelProperty:
type: object
required:
- name
- type
- assetProperty
properties:
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the property.
type:
allOf:
- $ref: '#/components/schemas/Name'
- description: The type of the composite model that defines this property.
assetProperty:
$ref: '#/components/schemas/Property'
id:
allOf:
- $ref: '#/components/schemas/ID'
- description: ' The ID of the composite model that contains the property. '
description: Contains information about a composite model property on an asset.
ComputeLocation:
type: string
enum:
- EDGE
- CLOUD
ErrorCode:
type: string
enum:
- VALIDATION_ERROR
- INTERNAL_FAILURE
ConfigurationErrorDetails:
type: object
required:
- code
- message
properties:
code:
allOf:
- $ref: '#/components/schemas/ErrorCode'
- description: The error code.
message:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
- description: The error message.
description: Contains the details of an IoT SiteWise configuration error.
ConfigurationState:
type: string
enum:
- ACTIVE
- UPDATE_IN_PROGRESS
- UPDATE_FAILED
ConfigurationStatus:
type: object
required:
- state
properties:
state:
allOf:
- $ref: '#/components/schemas/ConfigurationState'
- description: The current state of the configuration.
error:
allOf:
- $ref: '#/components/schemas/ConfigurationErrorDetails'
- description: 'Contains associated error information, if any.'
description: Contains current status information for the configuration.
CoreDeviceThingName:
type: string
minLength: 1
maxLength: 128
TagMap:
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
CreateAccessPolicyRequest:
type: object
required:
- accessPolicyIdentity
- accessPolicyResource
- accessPolicyPermission
title: CreateAccessPolicyRequest
properties:
accessPolicyIdentity:
allOf:
- $ref: '#/components/schemas/Identity'
- description: 'The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.'
accessPolicyResource:
allOf:
- $ref: '#/components/schemas/Resource'
- description: The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
accessPolicyPermission:
allOf:
- $ref: '#/components/schemas/Permission'
- description: The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: 'A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging
your IoT SiteWise resources in the IoT SiteWise User Guide.'
CreateAssetModelRequest:
type: object
required:
- assetModelName
title: CreateAssetModelRequest
properties:
assetModelName:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'A unique, friendly name for the asset model.'
assetModelDescription:
allOf:
- $ref: '#/components/schemas/Description'
- description: A description for the asset model.
assetModelProperties:
allOf:
- $ref: '#/components/schemas/AssetModelPropertyDefinitions'
- description: 'The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
' assetModelHierarchies: allOf: - $ref: '#/components/schemas/AssetModelHierarchyDefinitions' - description: 'The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
' assetModelCompositeModels: allOf: - $ref: '#/components/schemas/AssetModelCompositeModelDefinitions' - description: The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model. clientToken: allOf: - $ref: '#/components/schemas/ClientToken' - description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: 'A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.' CreateAssetRequest: type: object required: - assetName - assetModelId title: CreateAssetRequest properties: assetName: allOf: - $ref: '#/components/schemas/Name' - description: A friendly name for the asset. assetModelId: allOf: - $ref: '#/components/schemas/ID' - description: The ID of the asset model from which to create the asset. clientToken: allOf: - $ref: '#/components/schemas/ClientToken' - description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: 'A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.' assetDescription: allOf: - $ref: '#/components/schemas/Description' - description: A description for the asset. Files: type: array items: $ref: '#/components/schemas/File' ErrorReportLocation: type: object required: - bucket - prefix properties: bucket: allOf: - $ref: '#/components/schemas/Bucket' - description: The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent. prefix: allOf: - $ref: '#/components/schemas/String' - description: 'Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each Amazon S3 object has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/). For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.' description: The Amazon S3 destination where errors associated with the job creation request are saved. JobConfiguration: type: object required: - fileFormat properties: fileFormat: allOf: - $ref: '#/components/schemas/FileFormat' - description: The file format of the data in Amazon S3. description: 'Contains the configuration information of a job, such as the file format used to save data in Amazon S3.' CreateBulkImportJobRequest: type: object required: - jobName - jobRoleArn - files - errorReportLocation - jobConfiguration title: CreateBulkImportJobRequest properties: jobName: allOf: - $ref: '#/components/schemas/Name' - description: The unique name that helps identify the job request. jobRoleArn: allOf: - $ref: '#/components/schemas/ARN' - description: 'The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.' files: allOf: - $ref: '#/components/schemas/Files' - description: The files in the specified Amazon S3 bucket that contain your data. errorReportLocation: allOf: - $ref: '#/components/schemas/ErrorReportLocation' - description: The Amazon S3 destination where errors associated with the job creation request are saved. jobConfiguration: allOf: - $ref: '#/components/schemas/JobConfiguration' - description: 'Contains the configuration information of a job, such as the file format used to save data in Amazon S3.' JobStatus: type: string enum: - PENDING - CANCELLED - RUNNING - COMPLETED - FAILED - COMPLETED_WITH_FAILURES DashboardDefinition: type: string pattern: .+ minLength: 0 maxLength: 204800 CreateDashboardRequest: type: object required: - projectId - dashboardName - dashboardDefinition title: CreateDashboardRequest properties: projectId: allOf: - $ref: '#/components/schemas/ID' - description: The ID of the project in which to create the dashboard. dashboardName: allOf: - $ref: '#/components/schemas/Name' - description: A friendly name for the dashboard. dashboardDescription: allOf: - $ref: '#/components/schemas/Description' - description: A description for the dashboard. dashboardDefinition: allOf: - $ref: '#/components/schemas/DashboardDefinition' - description: 'The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.' clientToken: allOf: - $ref: '#/components/schemas/ClientToken' - description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: 'A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.' GatewayPlatform: type: object properties: greengrass: allOf: - $ref: '#/components/schemas/Greengrass' - description: A gateway that runs on IoT Greengrass. greengrassV2: allOf: - $ref: '#/components/schemas/GreengrassV2' - description: A gateway that runs on IoT Greengrass V2. description: Contains a gateway's platform information. CreateGatewayRequest: type: object required: - gatewayName - gatewayPlatform title: CreateGatewayRequest properties: gatewayName: allOf: - $ref: '#/components/schemas/Name' - description: 'A unique, friendly name for the gateway.' gatewayPlatform: allOf: - $ref: '#/components/schemas/GatewayPlatform' - description: The gateway's platform. You can only specify one platform in a gateway. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: 'A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.' Email: type: string pattern: '[^@]+@[^@]+' minLength: 1 maxLength: 255 CreatePortalRequest: type: object required: - portalName - portalContactEmail - roleArn title: CreatePortalRequest properties: portalName: allOf: - $ref: '#/components/schemas/Name' - description: A friendly name for the portal. portalDescription: allOf: - $ref: '#/components/schemas/Description' - description: A description for the portal. portalContactEmail: allOf: - $ref: '#/components/schemas/Email' - description: The Amazon Web Services administrator's contact email address. clientToken: allOf: - $ref: '#/components/schemas/ClientToken' - description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required. portalLogoImageFile: allOf: - $ref: '#/components/schemas/ImageFile' - description: 'A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.' roleArn: allOf: - $ref: '#/components/schemas/ARN' - description: 'The ARN of a service role that allows the portal''s users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.' tags: allOf: - $ref: '#/components/schemas/TagMap' - description: 'A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.' portalAuthMode: allOf: - $ref: '#/components/schemas/AuthMode' - description: 'The service to use to authenticate users to the portal. Choose from the following options:
SSO – The portal uses IAM Identity Center (successor
to Single Sign-On) to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information,
see Enabling IAM Identity Center in the IoT SiteWise User Guide. This option
is only available in Amazon Web Services Regions other than the China Regions.
IAM – The portal uses Identity and Access Management to authenticate users and
manage user permissions.
You can''t change this value after you create a portal.
Default: SSO
The email address that sends alarm notifications.
If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.
The number of days that your data is kept.
If you specified a value for this parameter, the unlimited parameter must be false.
If true, your data is kept indefinitely.
If configured to true, you must not specify a value for the numberOfDays parameter.
name if it's from the same asset model.
hierarchyId:
allOf:
- $ref: '#/components/schemas/Macro'
- description: 'The ID of the hierarchy to query for the property ID. You can use the hierarchy''s name instead of the hierarchy''s ID.
You use a hierarchy ID instead of a model ID because
you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model.
For more information, see Asset hierarchies in the IoT SiteWise User Guide.
iotsitewise:opcuacollector:version, where version is a number such as 1.'
capabilitySyncStatus:
allOf:
- $ref: '#/components/schemas/CapabilitySyncStatus'
- description: 'The synchronization status of the capability configuration. The sync status can be one of the following:
IN_SYNC – The gateway is running the
capability configuration.
OUT_OF_SYNC – The gateway hasn''t received the capability configuration.
SYNC_FAILED – The gateway
rejected the capability configuration.
Contains an image that is one of the following:
An image file. Choose this option to upload a new image.
The ID of an existing image. Choose this option to keep an existing image.
The status of the bulk import job can be one of following values.
PENDING – IoT SiteWise is waiting for the current bulk import job to
finish.
CANCELLED – The bulk import job has been canceled.
RUNNING – IoT SiteWise is processing your request to import
your data from Amazon S3.
COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.
FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot
issues.
COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified
error report location in Amazon S3 to troubleshoot issues.
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
' variables: allOf: - $ref: '#/components/schemas/ExpressionVariables' - description: The list of variables used in the expression. window: allOf: - $ref: '#/components/schemas/MetricWindow' - description: The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point perwindow.
processingConfig:
allOf:
- $ref: '#/components/schemas/MetricProcessingConfig'
- description: 'The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded
to the cloud.'
description: 'Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum).
The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a root metric can have up
to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of DOUBLE and consume properties with data types of INTEGER
or DOUBLE.
For more information, see Metrics in the IoT SiteWise User Guide.
' TumblingWindow: type: object required: - interval properties: interval: allOf: - $ref: '#/components/schemas/Interval' - description: 'The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday
at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
' offset: allOf: - $ref: '#/components/schemas/Offset' - description: 'The offset for the tumbling window. The offset parameter accepts the following:
The offset time.
For example, if you specify 18h
for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format.
For example, if you specify PT18H for offset and 1d for
interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock.
For example, if you specify 00:03:00 for offset, 5m for interval, and you create the metric at 2
PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).
The offset time zone.
For example, if you
specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. You can use this window in metrics to aggregate data from properties and other assets.
You can use m, h, d, and w when you specify an interval or offset. Note that m represents minutes, h
represents hours, d represents days, and w represents weeks. You can also use s to represent seconds in offset.
The interval
and offset parameters support the ISO 8601 format. For example, PT5S represents 5 seconds, PT5M represents
5 minutes, and PT5H represents 5 hours.
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
' variables: allOf: - $ref: '#/components/schemas/ExpressionVariables' - description: The list of variables used in the expression. processingConfig: allOf: - $ref: '#/components/schemas/TransformProcessingConfig' - description: The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud. description: 'Contains an asset transform property. A transform is a one-to-one mapping of a property''s data points from one form to another. For example, you can use a transform to convert a
Celsius data stream to Fahrenheit by applying the transformation expression to each data point of the Celsius stream. A transform can only have a data type of DOUBLE and consume properties
with data types of INTEGER or DOUBLE.
For more information, see Transforms in the IoT SiteWise User Guide.
' PropertyValueBooleanValue: type: boolean PropertyValueDoubleValue: type: number format: double PropertyValueIntegerValue: type: integer PropertyValueStringValue: type: string PutDefaultEncryptionConfigurationRequest: type: object required: - encryptionType title: PutDefaultEncryptionConfigurationRequest properties: encryptionType: allOf: - $ref: '#/components/schemas/EncryptionType' - description: The type of encryption used for the encryption configuration. kmsKeyId: allOf: - $ref: '#/components/schemas/KmsKeyId' - description: The Key ID of the customer managed key used for KMS encryption. This is required if you useKMS_BASED_ENCRYPTION.
PutLoggingOptionsRequest:
type: object
required:
- loggingOptions
title: PutLoggingOptionsRequest
properties:
loggingOptions:
allOf:
- $ref: '#/components/schemas/LoggingOptions'
- description: The logging options to set.
PutStorageConfigurationRequest:
type: object
required:
- storageType
title: PutStorageConfigurationRequest
properties:
storageType:
allOf:
- $ref: '#/components/schemas/StorageType'
- 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.
MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.'
disassociatedDataStorage:
allOf:
- $ref: '#/components/schemas/DisassociatedDataStorageState'
- 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' TagKeyList: type: array items: $ref: '#/components/schemas/TagKey' minItems: 0 maxItems: 200 TagResourceRequest: type: object required: - tags title: TagResourceRequest properties: tags: allOf: - $ref: '#/components/schemas/TagMap' - description: 'A list of key-value pairs that contain metadata for the resource. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.' TimeSeriesSummary: type: object required: - timeSeriesId - dataType - timeSeriesCreationDate - timeSeriesLastUpdateDate - timeSeriesArn properties: assetId: allOf: - $ref: '#/components/schemas/ID' - description: The ID of the asset in which the asset property was created. propertyId: allOf: - $ref: '#/components/schemas/ID' - description: The ID of the asset property. alias: allOf: - $ref: '#/components/schemas/PropertyAlias' - description: The alias that identifies the time series. timeSeriesId: allOf: - $ref: '#/components/schemas/TimeSeriesId' - description: The ID of the time series. dataType: allOf: - $ref: '#/components/schemas/PropertyDataType' - description: 'The data type of the time series.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this time
series.
The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.
The options for this
parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in
alarm composite models.
The ARN of the time series, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
ADMINISTRATOR is also known as a project owner.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
UpdateAssetModelRequest:
type: object
required:
- assetModelName
title: UpdateAssetModelRequest
properties:
assetModelName:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'A unique, friendly name for the asset model.'
assetModelDescription:
allOf:
- $ref: '#/components/schemas/Description'
- description: A description for the asset model.
assetModelProperties:
allOf:
- $ref: '#/components/schemas/AssetModelProperties'
- description: 'The updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
' assetModelHierarchies: allOf: - $ref: '#/components/schemas/AssetModelHierarchies' - description: 'The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
' assetModelCompositeModels: allOf: - $ref: '#/components/schemas/AssetModelCompositeModels' - description: The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model. clientToken: allOf: - $ref: '#/components/schemas/ClientToken' - description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required. UpdateAssetPropertyRequest: type: object title: UpdateAssetPropertyRequest properties: propertyAlias: allOf: - $ref: '#/components/schemas/PropertyAlias' - description: 'The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
If you omit this parameter, the alias is removed from the property.
' propertyNotificationState: allOf: - $ref: '#/components/schemas/PropertyNotificationState' - description: 'The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.
If you omit this parameter, the notification state is set to DISABLED.
assetModelProperty
in the asset model.'
UpdateAssetRequest:
type: object
required:
- assetName
title: UpdateAssetRequest
properties:
assetName:
allOf:
- $ref: '#/components/schemas/Name'
- description: A friendly name for the asset.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
assetDescription:
allOf:
- $ref: '#/components/schemas/Description'
- description: A description for the asset.
UpdateDashboardRequest:
type: object
required:
- dashboardName
- dashboardDefinition
title: UpdateDashboardRequest
properties:
dashboardName:
allOf:
- $ref: '#/components/schemas/Name'
- description: A new friendly name for the dashboard.
dashboardDescription:
allOf:
- $ref: '#/components/schemas/Description'
- description: A new description for the dashboard.
dashboardDefinition:
allOf:
- $ref: '#/components/schemas/DashboardDefinition'
- description: 'The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating
dashboards (CLI) in the IoT SiteWise User Guide.'
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
UpdateGatewayCapabilityConfigurationRequest:
type: object
required:
- capabilityNamespace
- capabilityConfiguration
title: UpdateGatewayCapabilityConfigurationRequest
properties:
capabilityNamespace:
allOf:
- $ref: '#/components/schemas/CapabilityNamespace'
- description: 'The namespace of the gateway capability configuration to be updated. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration
has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.'
capabilityConfiguration:
allOf:
- $ref: '#/components/schemas/CapabilityConfiguration'
- description: 'The JSON document that defines the configuration for the gateway capability. For more information, see Configuring
data sources (CLI) in the IoT SiteWise User Guide.'
UpdateGatewayRequest:
type: object
required:
- gatewayName
title: UpdateGatewayRequest
properties:
gatewayName:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'A unique, friendly name for the gateway.'
UpdatePortalRequest:
type: object
required:
- portalName
- portalContactEmail
- roleArn
title: UpdatePortalRequest
properties:
portalName:
allOf:
- $ref: '#/components/schemas/Name'
- description: A new friendly name for the portal.
portalDescription:
allOf:
- $ref: '#/components/schemas/Description'
- description: A new description for the portal.
portalContactEmail:
allOf:
- $ref: '#/components/schemas/Email'
- description: The Amazon Web Services administrator's contact email address.
portalLogoImage:
$ref: '#/components/schemas/Image'
roleArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: 'The ARN of a service role that allows the portal''s users to access your IoT SiteWise resources
on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in
the IoT SiteWise User Guide.'
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
notificationSenderEmail:
allOf:
- $ref: '#/components/schemas/Email'
- description: The email address that sends alarm notifications.
alarms:
allOf:
- $ref: '#/components/schemas/Alarms'
- description: 'Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset
property value is outside a specified range. For more information, see Monitoring with alarms in
the IoT SiteWise Application Guide.'
UpdateProjectRequest:
type: object
required:
- projectName
title: UpdateProjectRequest
properties:
projectName:
allOf:
- $ref: '#/components/schemas/Name'
- description: A new friendly name for the project.
projectDescription:
allOf:
- $ref: '#/components/schemas/Description'
- description: A new description for the project.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
security:
- hmac: []