openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 166 kB

JSON

{"openapi":"3.0.0","info":{"version":"2017-11-27","x-release":"v4","title":"AWS IoT Analytics","description":"IoT Analytics allows you to collect large amounts of device data, process messages, and store them. You can then query the data and run sophisticated analytics on it. IoT Analytics enables advanced data exploration through integration with Jupyter Notebooks and data visualization through integration with Amazon QuickSight. Traditional analytics and business intelligence tools are designed to process structured data. IoT data often comes from devices that record noisy processes (such as temperature, motion, or sound). As a result the data from these devices can have significant gaps, corrupted messages, and false readings that must be cleaned up before analysis can occur. Also, IoT data is often only meaningful in the context of other data from external sources. IoT Analytics automates the steps required to analyze data from IoT devices. IoT Analytics filters, transforms, and enriches IoT data before storing it in a time-series data store for analysis. You can set up the service to collect only the data you need from your devices, apply mathematical transforms to process the data, and enrich the data with device-specific metadata such as device type and location before storing it. Then, you can analyze your data by running queries using the built-in SQL query engine, or perform more complex analytics and machine learning inference. IoT Analytics includes pre-built models for common IoT use cases so you can answer questions like which devices are about to fail or which customers are at risk of abandoning their wearable devices.","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":"iotanalytics","x-aws-signingName":"iotanalytics","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iotanalytics-2017-11-27.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},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/iotanalytics/"},"servers":[{"url":"http://iotanalytics.{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 Analytics multi-region endpoint"},{"url":"https://iotanalytics.{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 Analytics multi-region endpoint"},{"url":"http://iotanalytics.{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 Analytics endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://iotanalytics.{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 Analytics endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/messages/batch":{"post":{"operationId":"BatchPutMessage","description":"Sends messages to a channel.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchPutMessageResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"482":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["channelName","messages"],"properties":{"channelName":{"description":"The name of the channel where the messages are sent.","type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128},"messages":{"description":"The list of messages to be sent. Each message has the format: { \"messageId\": \"string\", \"payload\": \"string\"}. The field names of message payloads (data) that you send to IoT Analytics: <ul> <li> Must contain only alphanumeric characters and undescores (_). No other special characters are allowed. </li> <li> Must begin with an alphabetic character or single underscore (_). </li> <li> Cannot contain hyphens (-). </li> <li> In regular expression terms: \"^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$\". </li> <li> Cannot be more than 255 characters. </li> <li> Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.) </li> </ul> For example, {\"temp_01\": 29} or {\"_temp_01\": 29} are valid, but {\"temp-01\": 29}, {\"01_temp\": 29} or {\"__temp_01\": 29} are invalid in message payloads. ","type":"array","items":{"$ref":"#/components/schemas/Message"}}}}}}}},"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"}]},"/pipelines/{pipelineName}/reprocessing/{reprocessingId}":{"delete":{"operationId":"CancelPipelineReprocessing","description":"Cancels the reprocessing of data through the pipeline.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelPipelineReprocessingResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"482":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"pipelineName","in":"path","required":true,"description":"The name of pipeline for which data reprocessing is canceled.","schema":{"type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128}},{"name":"reprocessingId","in":"path","required":true,"description":"The ID of the reprocessing task (returned by <code>StartPipelineReprocessing</code>).","schema":{"type":"string"}}]},"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"}]},"/channels":{"post":{"operationId":"CreateChannel","description":"Used to create a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ResourceAlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceAlreadyExistsException"}}}},"482":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"485":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["channelName"],"properties":{"channelName":{"description":"The name of the channel.","type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128},"channelStorage":{"description":"Where channel data is stored. You may choose one of <code>serviceManagedS3</code>, <code>customerManagedS3</code> storage. If not specified, the default is <code>serviceManagedS3</code>. This can't be changed after creation of the channel.","type":"object","properties":{"serviceManagedS3":{"allOf":[{"$ref":"#/components/schemas/ServiceManagedChannelS3Storage"},{"description":"Used to store channel data in an S3 bucket managed by IoT Analytics. You can't change the choice of S3 storage after the data store is created."}]},"customerManagedS3":{"allOf":[{"$ref":"#/components/schemas/CustomerManagedChannelS3Storage"},{"description":"Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the <code>retentionPeriod</code> parameter is ignored. You can't change the choice of S3 storage after the data store is created."}]}}},"retentionPeriod":{"description":"How long, in days, message data is kept.","type":"object","properties":{"unlimited":{"allOf":[{"$ref":"#/components/schemas/UnlimitedRetentionPeriod"},{"description":"If true, message data is kept indefinitely."}]},"numberOfDays":{"allOf":[{"$ref":"#/components/schemas/RetentionPeriodInDays"},{"description":"The number of days that message data is kept. The <code>unlimited</code> parameter must be false."}]}}},"tags":{"description":"Metadata which can be used to manage the channel.","type":"array","items":{"$ref":"#/components/schemas/Tag"},"minItems":1,"maxItems":50}}}}}}},"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":"ListChannels","description":"Retrieves a list of channels.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelsResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"482":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"nextToken","in":"query","required":false,"description":"The token for the next set of results.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in this request. The default value is 100.","schema":{"type":"integer","minimum":1,"maximum":250}}]}},"/datasets":{"post":{"operationId":"CreateDataset","description":"Used to create a dataset. A dataset stores data retrieved from a data store by applying a <code>queryAction</code> (a SQL query) or a <code>containerAction</code> (executing a containerized application). This operation creates the skeleton of a dataset. The dataset can be populated manually by calling <code>CreateDatasetContent</code> or automatically according to a trigger you specify.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDatasetResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ResourceAlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceAlreadyExistsException"}}}},"482":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"485":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["datasetName","actions"],"properties":{"datasetName":{"description":"The name of the dataset.","type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128},"actions":{"description":"A list of actions that create the dataset contents.","type":"array","items":{"$ref":"#/components/schemas/DatasetAction"},"minItems":1,"maxItems":1},"triggers":{"description":"A list of triggers. A trigger causes dataset contents to be populated at a specified time interval or when another dataset's contents are created. The list of triggers can be empty or contain up to five <code>DataSetTrigger</code> objects.","type":"array","items":{"$ref":"#/components/schemas/DatasetTrigger"},"minItems":0,"maxItems":5},"contentDeliveryRules":{"description":"When dataset contents are created, they are delivered to destinations specified here.","type":"array","items":{"$ref":"#/components/schemas/DatasetContentDeliveryRule"},"minItems":0,"maxItems":20},"retentionPeriod":{"description":"How long, in days, message data is kept.","type":"object","properties":{"unlimited":{"allOf":[{"$ref":"#/components/schemas/UnlimitedRetentionPeriod"},{"description":"If true, message data is kept indefinitely."}]},"numberOfDays":{"allOf":[{"$ref":"#/components/schemas/RetentionPeriodInDays"},{"description":"The number of days that message data is kept. The <code>unlimited</code> parameter must be false."}]}}},"versioningConfiguration":{"description":"Information about the versioning of dataset contents.","type":"object","properties":{"unlimited":{"allOf":[{"$ref":"#/components/schemas/UnlimitedVersioning"},{"description":"If true, unlimited versions of dataset contents are kept."}]},"maxVersions":{"allOf":[{"$ref":"#/components/schemas/MaxVersions"},{"description":"How many versions of dataset contents are kept. The <code>unlimited</code> parameter must be <code>false</code>."}]}}},"tags":{"description":"Metadata which can be used to manage the dataset.","type":"array","items":{"$ref":"#/components/schemas/Tag"},"minItems":1,"maxItems":50},"lateDataRules":{"description":"A list of data rules that send notifications to CloudWatch, when data arrives late. To specify <code>lateDataRules</code>, the dataset must use a <a href=\"https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html\">DeltaTimer</a> filter.","type":"array","items":{"$ref":"#/components/schemas/LateDataRule"},"minItems":1,"maxItems":1}}}}}}},"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":"ListDatasets","description":"Retrieves information about datasets.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDatasetsResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"482":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"nextToken","in":"query","required":false,"description":"The token for the next set of results.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in this request. The default value is 100.","schema":{"type":"integer","minimum":1,"maximum":250}}]}},"/datasets/{datasetName}/content":{"post":{"operationId":"CreateDatasetContent","description":"Creates the content of a dataset by applying a <code>queryAction</code> (a SQL query) or a <code>containerAction</code> (executing a containerized application).","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDatasetContentResponse"}}}},"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":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"datasetName","in":"path","required":true,"description":"The name of the dataset.","schema":{"type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"versionId":{"description":"The version ID of the dataset content. To specify <code>versionId</code> for a dataset content, the dataset must use a <a href=\"https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html\">DeltaTimer</a> filter.","type":"string","minLength":7,"maxLength":36}}}}}}},"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"}],"delete":{"operationId":"DeleteDatasetContent","description":"Deletes the content of the specified dataset.","responses":{"204":{"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":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"datasetName","in":"path","required":true,"description":"The name of the dataset whose content is deleted.","schema":{"type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128}},{"name":"versionId","in":"query","required":false,"description":"The version of the dataset whose content is deleted. You can also use the strings \"$LATEST\" or \"$LATEST_SUCCEEDED\" to delete the latest or latest successfully completed data set. If not specified, \"$LATEST_SUCCEEDED\" is the default.","schema":{"type":"string","minLength":7,"maxLength":36}}]},"get":{"operationId":"GetDatasetContent","description":"Retrieves the contents of a dataset as presigned URIs.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDatasetContentResponse"}}}},"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":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"datasetName","in":"path","required":true,"description":"The name of the dataset whose contents are retrieved.","schema":{"type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128}},{"name":"versionId","in":"query","required":false,"description":"The version of the dataset whose contents are retrieved. You can also use the strings \"$LATEST\" or \"$LATEST_SUCCEEDED\" to retrieve the contents of the latest or latest successfully completed dataset. If not specified, \"$LATEST_SUCCEEDED\" is the default.","schema":{"type":"string","minLength":7,"maxLength":36}}]}},"/datastores":{"post":{"operationId":"CreateDatastore","description":"Creates a data store, which is a repository for messages.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDatastoreResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ResourceAlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceAlreadyExistsException"}}}},"482":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"485":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["datastoreName"],"properties":{"datastoreName":{"description":"The name of the data store.","type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128},"datastoreStorage":{"description":"Where data in a data store is stored.. You can choose <code>serviceManagedS3</code> storage, <code>customerManagedS3</code> storage, or <code>iotSiteWiseMultiLayerStorage</code> storage. The default is <code>serviceManagedS3</code>. You can't change the choice of Amazon S3 storage after your data store is created. ","type":"object","properties":{"serviceManagedS3":{"allOf":[{"$ref":"#/components/schemas/ServiceManagedDatastoreS3Storage"},{"description":"Used to store data in an Amazon S3 bucket managed by IoT Analytics. You can't change the choice of Amazon S3 storage after your data store is created. "}]},"customerManagedS3":{"allOf":[{"$ref":"#/components/schemas/CustomerManagedDatastoreS3Storage"},{"description":"S3-customer-managed; When you choose customer-managed storage, the <code>retentionPeriod</code> parameter is ignored. You can't change the choice of Amazon S3 storage after your data store is created. "}]},"iotSiteWiseMultiLayerStorage":{"allOf":[{"$ref":"#/components/schemas/DatastoreIotSiteWiseMultiLayerStorage"},{"description":" Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created. "}]}}},"retentionPeriod":{"description":"How long, in days, message data is kept.","type":"object","properties":{"unlimited":{"allOf":[{"$ref":"#/components/schemas/UnlimitedRetentionPeriod"},{"description":"If true, message data is kept indefinitely."}]},"numberOfDays":{"allOf":[{"$ref":"#/components/schemas/RetentionPeriodInDays"},{"description":"The number of days that message data is kept. The <code>unlimited</code> parameter must be false."}]}}},"tags":{"description":"Metadata which can be used to manage the data store.","type":"array","items":{"$ref":"#/components/schemas/Tag"},"minItems":1,"maxItems":50},"fileFormatConfiguration":{"description":"Contains the configuration information of file formats. IoT Analytics data stores support JSON and <a href=\"https://parquet.apache.org/\">Parquet</a>. The default file format is JSON. You can specify only one format. You can't change the file format after you create the data store.","type":"object","properties":{"jsonConfiguration":{"allOf":[{"$ref":"#/components/schemas/JsonConfiguration"},{"description":"Contains the configuration information of the JSON format."}]},"parquetConfiguration":{"allOf":[{"$ref":"#/components/schemas/ParquetConfiguration"},{"description":"Contains the configuration information of the Parquet format."}]}}},"datastorePartitions":{"description":" Contains information about the partition dimensions in a data store. ","type":"object","properties":{"partitions":{"allOf":[{"$ref":"#/components/schemas/Partitions"},{"description":" A list of partition dimensions in a data store. "}]}}}}}}}}},"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":"ListDatastores","description":"Retrieves a list of data stores.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDatastoresResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"482":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"nextToken","in":"query","required":false,"description":"The token for the next set of results.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in this request. The default value is 100.","schema":{"type":"integer","minimum":1,"maximum":250}}]}},"/pipelines":{"post":{"operationId":"CreatePipeline","description":"Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a <code>channel</code> and a <code>datastore</code> activity and, optionally, as many as 23 additional activities in the <code>pipelineActivities</code> array.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePipelineResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ResourceAlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceAlreadyExistsException"}}}},"482":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"485":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["pipelineName","pipelineActivities"],"properties":{"pipelineName":{"description":"The name of the pipeline.","type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128},"pipelineActivities":{"description":"A list of <code>PipelineActivity</code> objects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda unctions on messages for advanced processing; or performing mathematical transformations to normalize device data. The list can be 2-25 <code>PipelineActivity</code> objects and must contain both a <code>channel</code> and a <code>datastore</code> activity. Each entry in the list must contain only one activity. For example: <code>pipelineActivities = [ { \"channel\": { ... } }, { \"lambda\": { ... } }, ... ]</code> ","type":"array","items":{"$ref":"#/components/schemas/PipelineActivity"},"minItems":1,"maxItems":25},"tags":{"description":"Metadata which can be used to manage the pipeline.","type":"array","items":{"$ref":"#/components/schemas/Tag"},"minItems":1,"maxItems":50}}}}}}},"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":"ListPipelines","description":"Retrieves a list of pipelines.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPipelinesResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"482":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"nextToken","in":"query","required":false,"description":"The token for the next set of results.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in this request. The default value is 100.","schema":{"type":"integer","minimum":1,"maximum":250}}]}},"/channels/{channelName}":{"delete":{"operationId":"DeleteChannel","description":"Deletes the specified channel.","responses":{"204":{"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":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"channelName","in":"path","required":true,"description":"The name of the channel to delete.","schema":{"type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128}}]},"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":"DescribeChannel","description":"Retrieves information about a channel.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeChannelResponse"}}}},"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":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"channelName","in":"path","required":true,"description":"The name of the channel whose information is retrieved.","schema":{"type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128}},{"name":"includeStatistics","in":"query","required":false,"description":"If true, additional statistical information about the channel is included in the response. This feature can't be used with a channel whose S3 storage is customer-managed.","schema":{"type":"boolean"}}]},"put":{"operationId":"UpdateChannel","description":"Used to update the settings of a channel.","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":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"channelName","in":"path","required":true,"description":"The name of the channel to be updated.","schema":{"type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"channelStorage":{"description":"Where channel data is stored. You may choose one of <code>serviceManagedS3</code>, <code>customerManagedS3</code> storage. If not specified, the default is <code>serviceManagedS3</code>. This can't be changed after creation of the channel.","type":"object","properties":{"serviceManagedS3":{"allOf":[{"$ref":"#/components/schemas/ServiceManagedChannelS3Storage"},{"description":"Used to store channel data in an S3 bucket managed by IoT Analytics. You can't change the choice of S3 storage after the data store is created."}]},"customerManagedS3":{"allOf":[{"$ref":"#/components/schemas/CustomerManagedChannelS3Storage"},{"description":"Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the <code>retentionPeriod</code> parameter is ignored. You can't change the choice of S3 storage after the data store is created."}]}}},"retentionPeriod":{"description":"How long, in days, message data is kept.","type":"object","properties":{"unlimited":{"allOf":[{"$ref":"#/components/schemas/UnlimitedRetentionPeriod"},{"description":"If true, message data is kept indefinitely."}]},"numberOfDays":{"allOf":[{"$ref":"#/components/schemas/RetentionPeriodInDays"},{"description":"The number of days that message data is kept. The <code>unlimited</code> parameter must be false."}]}}}}}}}}}},"/datasets/{datasetName}":{"delete":{"operationId":"DeleteDataset","description":"Deletes the specified dataset. You do not have to delete the content of the dataset before you perform this operation.","responses":{"204":{"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":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"datasetName","in":"path","required":true,"description":"The name of the dataset to delete.","schema":{"type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128}}]},"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":"DescribeDataset","description":"Retrieves information about a dataset.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeDatasetResponse"}}}},"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":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"datasetName","in":"path","required":true,"description":"The name of the dataset whose information is retrieved.","schema":{"type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128}}]},"put":{"operationId":"UpdateDataset","description":"Updates the settings of a dataset.","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":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"datasetName","in":"path","required":true,"description":"The name of the dataset to update.","schema":{"type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["actions"],"properties":{"actions":{"description":"A list of <code>DatasetAction</code> objects.","type":"array","items":{"$ref":"#/components/schemas/DatasetAction"},"minItems":1,"maxItems":1},"triggers":{"description":"A list of <code>DatasetTrigger</code> objects. The list can be empty or can contain up to five <code>DatasetTrigger</code> objects.","type":"array","items":{"$ref":"#/components/schemas/DatasetTrigger"},"minItems":0,"maxItems":5},"contentDeliveryRules":{"description":"When dataset contents are created, they are delivered to destinations specified here.","type":"array","items":{"$ref":"#/components/schemas/DatasetContentDeliveryRule"},"minItems":0,"maxItems":20},"retentionPeriod":{"description":"How long, in days, message data is kept.","type":"object","properties":{"unlimited":{"allOf":[{"$ref":"#/components/schemas/UnlimitedRetentionPeriod"},{"description":"If true, message data is kept indefinitely."}]},"numberOfDays":{"allOf":[{"$ref":"#/components/schemas/RetentionPeriodInDays"},{"description":"The number of days that message data is kept. The <code>unlimited</code> parameter must be false."}]}}},"versioningConfiguration":{"description":"Information about the versioning of dataset contents.","type":"object","properties":{"unlimited":{"allOf":[{"$ref":"#/components/schemas/UnlimitedVersioning"},{"description":"If true, unlimited versions of dataset contents are kept."}]},"maxVersions":{"allOf":[{"$ref":"#/components/schemas/MaxVersions"},{"description":"How many versions of dataset contents are kept. The <code>unlimited</code> parameter must be <code>false</code>."}]}}},"lateDataRules":{"description":"A list of data rules that send notifications to CloudWatch, when data arrives late. To specify <code>lateDataRules</code>, the dataset must use a <a href=\"https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html\">DeltaTimer</a> filter.","type":"array","items":{"$ref":"#/components/schemas/LateDataRule"},"minItems":1,"maxItems":1}}}}}}}},"/datastores/{datastoreName}":{"delete":{"operationId":"DeleteDatastore","description":"Deletes the specified data store.","responses":{"204":{"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":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"datastoreName","in":"path","required":true,"description":"The name of the data store to delete.","schema":{"type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128}}]},"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":"DescribeDatastore","description":"Retrieves information about a data store.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeDatastoreResponse"}}}},"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":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"datastoreName","in":"path","required":true,"description":"The name of the data store","schema":{"type":"string","pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)","minLength":1,"maxLength":128}},{"name":"includeStatistics","in":"query","required":false,"description":"If true, additional statistical information about the data store is included in the response. This feature can't be used with a data store whose S3 storage is customer-managed.","schema":{"type":"boolean"}}]},"put":{"operationId":"UpdateDatastore","description":"Used to update the settings of a data store.","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":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"da