Skip to content

S3Config

Source code in docs_src/capo_iotfleetwise/types/s3_config.py 
16
17
18
19
20
21
22
23
24
25
26
class S3Config(TypedDict, closed=True):
    bucket_arn: "capo_iotfleetwise.types.s3_bucket_arn.S3BucketArn"
    """<p>The Amazon Resource Name (ARN) of the Amazon S3 bucket.</p>"""
    data_format: NotRequired["capo_iotfleetwise.types.data_format.DataFormat"]
    """<p>Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.</p> <ul> <li> <p>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.</p> </li> <li> <p>JSON - Store data in a standard text-based JSON file format.</p> </li> </ul>"""
    storage_compression_format: NotRequired[
        "capo_iotfleetwise.types.storage_compression_format.StorageCompressionFormat"
    ]
    """<p>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.</p>"""
    prefix: NotRequired["capo_iotfleetwise.types.prefix.Prefix"]
    """<p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p>By default, Amazon Web Services IoT FleetWise sets the prefix <code>processed-data/year=YY/month=MM/date=DD/hour=HH/</code> (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 prefix <code>vehicles</code>, the prefix will be <code>vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/</code>.</p>"""

bucket_arn instance-attribute 

bucket_arn: S3BucketArn

The Amazon Resource Name (ARN) of the Amazon S3 bucket.

data_format instance-attribute 

data_format: NotRequired[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.

prefix instance-attribute 

prefix: NotRequired[Prefix]

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, Amazon Web Services 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 prefix vehicles, the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/.

storage_compression_format instance-attribute 

storage_compression_format: NotRequired[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.