Configure storage settings in AWS IoT SiteWise

To configure storage settings in the console

1. Navigate to the AWS IoT SiteWise console.

2. In the navigation pane, under Settings, choose Storage.

3. In the upper-right corner, choose Edit.

4. On the Edit storage page, do the following:

5. For Hot tier settings, do the following:

   • If you want to set a retention period for how long your data is stored in the hot tier before it's deleted, and moved to the service managed warm tier storage, choose Enable retention period.

   • To configure a retention period, enter a whole number and choose a unit. The retention period must be greater than or equal to 30 days.

   AWS IoT SiteWise deletes any data in the hot tier that's older than the retention period. If you don't set a retention period, your data is stored indefinitely.

6. (Recommended) For Warm tier settings, do the following:

   • To opt in to warm tier storage, select I confirm to the opt-in of warm tier storage to opt in for the warm tier storage.

   • (Optional) To configure a retention period, enter a whole number and choose a unit. The retention period must be greater than or equal to 365 days.

   AWS IoT SiteWise deletes data in the warm tier that existed earlier than the retention period. If you don't set a retention period, your data is stored indefinitely.

   Note

   • When you opt in for warm tier, the configuration displays once only.

   • To set hot tier retention, you must have either warm or cold tier storage. For cost efficiency and historical data retrieval, AWS IoT SiteWise recommends that you store long term data in the warm tier.

   • To set warm tier retention, you must have cold tier storage.

7. Choose Save to save your storage settings.

Configure storage settings using AWS CLI with existing cold tier storage

• Run the following command to configure the storage settings. Replace file-name with the name of the file that contains the AWS IoT SiteWise storage configuration.

  aws iotsitewise put-storage-configuration --cli-input-json file://file-name.json

  Example AWS IoT SiteWise storage configuration

  • Replace amzn-s3-demo-bucket with your Amazon S3 bucket name.

  • Replace prefix with your Amazon S3 prefix.

  • Replace aws-account-id with your AWS account ID.

  • Replace role-name with the name of the Amazon S3 access role that allows AWS IoT SiteWise to send data to Amazon S3.

  • Replace hot-tier-retention-in-days with a whole number greater than or equal to 30 days.

  • Replace warm-tier-retention-in-days with a whole number greater than or equal to 365 days.

  Note

  AWS IoT SiteWise will delete any data in the warm tier that's older than the retention period of the cold tier. If you don't set a retention period, your data is stored indefinitely.

  {
        "storageType": "MULTI_LAYER_STORAGE",
          "multiLayerStorage": {
            "customerManagedS3Storage": {
                "s3ResourceArn": "arn:aws:s3:::amzn-s3-demo-bucket/prefix/",
                "roleArn": "arn:aws:iam::aws-account-id:role/role-name"
                }
            },
      "disassociatedDataStorage": "ENABLED",
      "retentionPeriod": {
        "numberOfDays": hot-tier-retention-in-days
      },
      "warmTier": "ENABLED",
      "warmTierRetentionPeriod": {
        "numberOfDays": warm-tier-retention-in-days
      }
  }

  Example response

  {
        "storageType": "MULTI_LAYER_STORAGE",
        "configurationStatus": {
          "state": "UPDATE_IN_PROGRESS"
         }
  }

To configure storage settings in the console

1. Navigate to the AWS IoT SiteWise console.

2. In the navigation pane, under Settings, choose Storage.

3. In the upper-right corner, choose Edit.

4. On the Edit storage page, do the following:

   1. For Storage settings, choose Enable cold tier storage. The cold tier storage is disabled by default.

   2. For S3 bucket location, enter the name of an existing Amazon S3 bucket and a prefix.

      Note

      • Amazon S3 uses the prefix as a folder name in the Amazon S3 bucket. The prefix must have 1-255 characters and end with a forward slash (/). Your AWS IoT SiteWise data is saved in this folder.

      • If you don't have an Amazon S3 bucket, choose View, and then create one in the Amazon S3 console. For more information, see Create your first S3 bucket in the Amazon S3 User Guide.

   3. For S3 access role, do one of the following:

      • Choose Create a role from an AWS managed template, AWS automatically creates an IAM role that allows AWS IoT SiteWise to send data to Amazon S3.

      • Choose Use an existing role, and then choose the role that you created from the list.

        Note

        • You must use the same Amazon S3 bucket name for the S3 bucket location that you used in the previous step and in your IAM policy.

        • Make sure that your role has the permissions shown in the following example.

          Example permissions policy:

          {
                "Version": "2012-10-17",
                "Statement": [
                    {
                        "Effect": "Allow",
                        "Action": [
                            "s3:PutObject",
                            "s3:GetObject",
                            "s3:DeleteObject",
                            "s3:GetBucketLocation",
                            "s3:ListBucket"
                        ],
                        "Resource": [
                            "arn:aws:s3:::amzn-s3-demo-bucket",
                            "arn:aws:s3:::amzn-s3-demo-bucket/*"
                        ]
                    }
                ]
            }

          Replace amzn-s3-demo-bucket with the name of your Amazon S3 bucket.

        • If the S3 bucket is encrypted using a customer managed KMS key, the KMS key must have an access policy with an IAM role for kms:Decrypt and kms:GenerateDataKey operations.

   4. To setup hot tier, see Step 5 in Configure storage settings for warm tier (console).

   5. (Optional) For AWS IoT Analytics integration, do the following.

      1. If you want to use AWS IoT Analytics to query your data, choose Enabled AWS IoT Analytics data store.

      2. AWS IoT SiteWise generates a name for your data store or you can enter a different name.

      AWS IoT SiteWise automatically creates a data store in AWS IoT Analytics to save your data. To query the data, you can use AWS IoT Analytics to create datasets. For more information, see Working with AWS IoT SiteWise data in the AWS IoT Analytics User Guide.

   6. Choose Save.

To configure storage settings using AWS CLI

1. To export data to an Amazon S3 bucket in your account, run the following command to configure the storage settings. Replace file-name with the name of the file that contains the AWS IoT SiteWise storage configuration.

   aws iotsitewise put-storage-configuration --cli-input-json file://file-name.json

   Example AWS IoT SiteWise storage configuration

   • Replace amzn-s3-demo-bucket with your Amazon S3 bucket name.

   • Replace prefix with your Amazon S3 prefix.

   • Replace aws-account-id with your AWS account ID.

   • Replace role-name with the name of the Amazon S3 access role that allows AWS IoT SiteWise to send data to Amazon S3.

   • Replace retention-in-days with a whole number than is greater than or equal to 30 days.

   {
         "storageType": "MULTI_LAYER_STORAGE",
         "multiLayerStorage": {
             "customerManagedS3Storage": {
                 "s3ResourceArn": "arn:aws:s3:::amzn-s3-demo-bucket/prefix/",
                 "roleArn": "arn:aws:iam::aws-account-id:role/role-name"
             }
         }, 
         "retentionPeriod": { 
             "numberOfDays": retention-in-days,
             "unlimited": false
         }
     }

   Note

   • You must use the same Amazon S3 bucket name in the AWS IoT SiteWise storage configuration and IAM policy.

   • Make sure that your role has the permissions shown in the following example.

     Example permissions policy:

     {
           "Version": "2012-10-17",
           "Statement": [
               {
                   "Effect": "Allow",
                   "Action": [
                       "s3:PutObject",
                       "s3:GetObject",
                       "s3:DeleteObject",
                       "s3:GetBucketLocation",
                       "s3:ListBucket"
                   ],
                   "Resource": [
                       "arn:aws:s3:::amzn-s3-demo-bucket",
                       "arn:aws:s3:::amzn-s3-demo-bucket/*"
                   ]
               }
           ]
       }

     Replace amzn-s3-demo-bucket with the name of your Amazon S3 bucket.

   • If the S3 bucket is encrypted using a customer managed KMS key, the KMS key must have an access policy with an IAM role for kms:Decrypt and kms:GenerateDataKey operations.

   Example response

   {
       "storageType": "MULTI_LAYER_STORAGE",
       "retentionPeriod": {
           "numberOfDays": 100,
           "unlimited": false
       },
       "configurationStatus": {
           "state": "UPDATE_IN_PROGRESS"
       }
   }

   Note

   It can take a few minutes for AWS IoT SiteWise to update the storage configuration.

2. To retrieve the storage configuration information, run the following command.

   aws iotsitewise describe-storage-configuration

   Example response

   {
         "storageType": "MULTI_LAYER_STORAGE",
         "multiLayerStorage": {
             "customerManagedS3Storage": {
                 "s3ResourceArn": "arn:aws:s3:::amzn-s3-demo-bucket/torque/",
                 "roleArn": "arn:aws:iam::123456789012:role/SWAccessS3Role"
             }
         },
         "retentionPeriod": { 
             "numberOfDays": 100,
             "unlimited": false
         },
         "configurationStatus": {
             "state": "ACTIVE"
         },
         "lastUpdateDate": "2021-03-30T15:54:14-07:00"
     }

3. To stop exporting data to the Amazon S3 bucket, run the following command to configure storage settings.

   aws iotsitewise put-storage-configuration --storage-type SITEWISE_DEFAULT_STORAGE

   Note

   By default, your data is only stored in the hot tier of AWS IoT SiteWise.

   Example response

   {
         "storageType": "SITEWISE_DEFAULT_STORAGE",
         "configurationStatus": {
             "state": "UPDATE_IN_PROGRESS"
         }
     }

4. To retrieve the storage configuration information, run the following command.

   aws iotsitewise describe-storage-configuration

   Example response

   {
         "storageType": "SITEWISE_DEFAULT_STORAGE",
         "configurationStatus": {
             "state": "ACTIVE"
         },
         "lastUpdateDate": "2021-03-30T15:57:14-07:00"
     }