S3Config
The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data. Amazon S3 is an object storage service that stores data as objects within buckets. For more information, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide.
Contents
- bucketArn
-
The Amazon Resource Name (ARN) of the Amazon S3 bucket.
Type: String
Length Constraints: Minimum length of 16. Maximum length of 100.
Pattern:
arn:(aws[a-zA-Z0-9-]*):s3:::.+
Required: Yes
- dataFormat
-
Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.
-
Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.
-
JSON - Store data in a standard text-based JSON file format.
Type: String
Valid Values:
JSON | PARQUET
Required: No
-
- prefix
-
(Optional) Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
By default, AWS IoT FleetWise sets the prefix
processed-data/year=YY/month=MM/date=DD/hour=HH/
(in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefixvehicles
, the prefix will bevehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[a-zA-Z0-9-_:./!*'()]+
Required: No
- storageCompressionFormat
-
By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.
Type: String
Valid Values:
NONE | GZIP
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: