S3DestinationConfiguration - AWS IoT Analytics
ContentsSee Also

S3DestinationConfiguration

Configuration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3).

Contents

bucket

The name of the S3 bucket to which dataset contents are delivered.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Pattern: ^[a-zA-Z0-9.\-_]*$

Required: Yes

key

The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key.

You can create a unique key with the following options:

  • Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query run.

  • Use !{iotanalytics:versionId} to insert a unique hash that identifies a dataset content.

  • Use !{iotanalytics:creationTime} to insert the creation time of a dataset content.

The following example creates a unique key for a CSV file: dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv

Note

If you don't use !{iotanalytics:versionId} to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same scheduleTime but different versionIds. This means that one dataset content overwrites the other.

Type: String

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

Pattern: ^[a-zA-Z0-9!_.*'()/{}:-]*$

Required: Yes

roleArn

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

glueConfiguration

Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL) service.

Type: GlueConfiguration object

Required: No

See Also

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