Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateDataset

Updates the settings of a dataset.

Important

The UpdateDataset operation in AWS IoT Analytics is no longer available to new customers. Existing customers of AWS IoT Analytics can continue to use the service as normal. Learn more

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"
      }
   ],
   "lateDataRules": [ 
      { 
         "ruleConfiguration": { 
            "deltaTimeSessionWindowConfiguration": { 
               "timeoutInMinutes": number
            }
         },
         "ruleName": "string"
      }
   ],
   "retentionPeriod": { 
      "numberOfDays": number,
      "unlimited": boolean
   },
   "triggers": [ 
      { 
         "dataset": { 
            "name": "string"
         },
         "schedule": { 
            "expression": "string"
         }
      }
   ],
   "versioningConfiguration": { 
      "maxVersions": number,
      "unlimited": boolean
   }
}

URI Request Parameters

The request uses the following URI parameters.

datasetName

The name of the dataset to update.

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

Pattern: (^(?!_{2}))(^[a-zA-Z0-9_]+$)

Required: Yes

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 dataset 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

lateDataRules

A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.

Type: Array of LateDataRule objects

Array Members: Fixed number of 1 item.

Required: No

retentionPeriod

How long, in days, dataset contents are kept for the dataset.

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 dataset 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 Keeping Multiple Versions of AWS IoT Analytics datasets in the AWS IoT Analytics User Guide.

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: 400