openapi: 3.0.0 info: version: '2019-12-02' x-release: v4 title: AWS IoT SiteWise Access Policies Timeseries API description: Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT) devices to the power of the Amazon Web Services Cloud. For more information, see the IoT SiteWise User Guide. For information about IoT SiteWise quotas, see Quotas in the IoT SiteWise User Guide. x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: iotsitewise x-aws-signingName: iotsitewise x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iotsitewise-2019-12-02.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://iotsitewise.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS IoT SiteWise multi-region endpoint - url: https://iotsitewise.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS IoT SiteWise multi-region endpoint - url: http://iotsitewise.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS IoT SiteWise endpoint for China (Beijing) and China (Ningxia) - url: https://iotsitewise.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS IoT SiteWise endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Timeseries paths: /timeseries/associate/#alias&assetId&propertyId: 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: AssociateTimeSeriesToAssetProperty description: Associates a time series (data stream) with an asset property. 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' '484': description: ConflictingOperationException content: application/json: schema: $ref: '#/components/schemas/ConflictingOperationException' parameters: - name: alias in: query required: true description: The alias that identifies the time series. schema: type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 - name: assetId in: query required: true 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: propertyId in: query 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 requestBody: required: true content: application/json: schema: type: object properties: 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 Associate Time Series to Asset Property x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Timeseries /timeseries/delete/: 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: DeleteTimeSeries description: '

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:

' 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' '484': description: ConflictingOperationException content: application/json: schema: $ref: '#/components/schemas/ConflictingOperationException' parameters: - name: alias in: query required: false description: The alias that identifies the time series. schema: type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 - 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: propertyId in: query required: false 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 requestBody: required: true content: application/json: schema: type: object properties: 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 Delete Time Series x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Timeseries /timeseries/describe/: 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: DescribeTimeSeries description: '

Retrieves information about a time series (data stream).

To identify a time series, do one of the following:

' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeTimeSeriesResponse' '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: alias in: query required: false description: The alias that identifies the time series. schema: type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 - 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: propertyId in: query required: false 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 Time Series x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Timeseries /timeseries/disassociate/#alias&assetId&propertyId: 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: DisassociateTimeSeriesFromAssetProperty description: Disassociates a time series (data stream) from an asset property. 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' '484': description: ConflictingOperationException content: application/json: schema: $ref: '#/components/schemas/ConflictingOperationException' parameters: - name: alias in: query required: true description: The alias that identifies the time series. schema: type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 - name: assetId in: query required: true 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: propertyId in: query 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 requestBody: required: true content: application/json: schema: type: object properties: 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 Disassociate Time Series from Asset Property x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Timeseries /timeseries/: 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: 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:

schema: type: string enum: - ASSOCIATED - DISASSOCIATED summary: Amazon IoT SiteWise List Time Series x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Timeseries components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 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-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false schemas: InternalFailureException: {} Timestamp: type: string format: date-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.

dataTypeSpec: allOf: - $ref: '#/components/schemas/Name' - description:

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.

timeSeriesCreationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date that the time series was created, in Unix epoch time. timeSeriesLastUpdateDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date that the time series was last updated, in Unix epoch time. timeSeriesArn: allOf: - $ref: '#/components/schemas/ARN' - description:

The ARN of the time series, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}

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.

dataTypeSpec: allOf: - $ref: '#/components/schemas/Name' - description:

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.

timeSeriesCreationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date that the time series was created, in Unix epoch time. timeSeriesLastUpdateDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date that the time series was last updated, in Unix epoch time. timeSeriesArn: allOf: - $ref: '#/components/schemas/ARN' - description:

The ARN of the time series, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}

description: Contains a summary of a time series (data stream). PropertyDataType: type: string enum: - STRING - INTEGER - DOUBLE - BOOLEAN - STRUCT InvalidRequestException: {} ConflictingOperationException: {} PropertyAlias: type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 TimeSeriesSummaries: type: array items: $ref: '#/components/schemas/TimeSeriesSummary' TimeSeriesId: type: string minLength: 36 maxLength: 73 Name: type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 maxLength: 256 ListTimeSeriesResponse: type: object required: - TimeSeriesSummaries properties: TimeSeriesSummaries: allOf: - $ref: '#/components/schemas/TimeSeriesSummaries' - description: One or more time series summaries to list. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token for the next set of results, or null if there are no additional results. 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 ThrottlingException: {} ResourceNotFoundException: {} NextToken: type: string pattern: '[A-Za-z0-9+/=]+' minLength: 1 maxLength: 4096 ARN: type: string pattern: .* minLength: 1 maxLength: 1600 securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/iotsitewise/ x-hasEquivalentPaths: true