AWS IoT Analytics
AWS IoT Analytics Documentation (API Version 2017-11-27)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

UpdateDataset

Updates the settings of a data set.

Request Syntax

PUT /datasets/datasetName HTTP/1.1 Content-type: application/json { "actions": [ { "actionName": "string", "containerAction": { "executionRoleArn": "string", "image": "string", "resourceConfiguration": { "computeType": "string", "volumeSizeInGB": number }, "variables": [ { "datasetContentVersionValue": { "datasetName": "string" }, "doubleValue": number, "name": "string", "outputFileUriValue": { "fileName": "string" }, "stringValue": "string" } ] }, "queryAction": { "filters": [ { "deltaTime": { "offsetSeconds": number, "timeExpression": "string" } } ], "sqlQuery": "string" } } ], "contentDeliveryRules": [ { "destination": { "iotEventsDestinationConfiguration": { "inputName": "string", "roleArn": "string" }, "s3DestinationConfiguration": { "bucket": "string", "glueConfiguration": { "databaseName": "string", "tableName": "string" }, "key": "string", "roleArn": "string" } }, "entryName": "string" } ], "retentionPeriod": { "numberOfDays": number, "unlimited": boolean }, "triggers": [ { "dataset": { "name": "string" }, "schedule": { "expression": "string" } } ], "versioningConfiguration": { "maxVersions": number, "unlimited": boolean } }

URI Request Parameters

The request requires the following URI parameters.

datasetName

The name of the data set to update.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Request Body

The request accepts the following data in JSON format.

actions

A list of "DatasetAction" objects.

Type: Array of DatasetAction objects

Array Members: Fixed number of 1 item.

Required: Yes

contentDeliveryRules

When data set contents are created they are delivered to destinations specified here.

Type: Array of DatasetContentDeliveryRule objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No

retentionPeriod

How long, in days, data set contents are kept for the data set.

Type: RetentionPeriod object

Required: No

triggers

A list of "DatasetTrigger" objects. The list can be empty or can contain up to five DataSetTrigger objects.

Type: Array of DatasetTrigger objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No

versioningConfiguration

[Optional] How many versions of data set contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the "retentionPeriod" parameter. (For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)

Type: VersioningConfiguration object

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the specified name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: