PUT

/datasets/{datasetName}

http://iotanalytics.{region}.amazonaws.com/datasets/{datasetName}

Updates the settings of a dataset.

Access Token Required: API Key

Path Parameters

datasetNamestringrequired

The name of the dataset to update.

Body Params

actionsarrayrequired

A list of <code>DatasetAction</code> objects.

triggersarray

A list of <code>DatasetTrigger</code> objects. The list can be empty or can contain up to five <code>DatasetTrigger</code> objects.

lateDataRulesarray

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.

retentionPeriodobject

How long, in days, message data is kept.

contentDeliveryRulesarray

When dataset contents are created, they are delivered to destinations specified here.

versioningConfigurationobject

Information about the versioning of dataset contents.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://iotanalytics.{region}.amazonaws.com/datasets/{datasetName}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT