Skip to content

S3File

Used by
Source code in docs_src/capo_socialmessaging/types/s3_file.py 
 8
 9
10
11
12
class S3File(TypedDict, closed=True):
    bucket_name: "str"
    """<p>The bucket name.</p>"""
    key: "str"
    """<p>The S3 key prefix that defines the storage location of your media files. The prefix works like a folder path in S3, and is combined with the WhatsApp mediaId to create the final file path.</p> <p>For example, if a media file's WhatsApp mediaId is <code>123.ogg</code>, and the key is <code>audio/example.ogg</code>, the final file path is <code>audio/example.ogg123.ogg</code>.</p> <p>For the same mediaId, a key of <code>audio/</code> results in the file path <code>audio/123.ogg</code>.</p>"""

bucket_name instance-attribute 

bucket_name: str

The bucket name.

key instance-attribute 

key: str

The S3 key prefix that defines the storage location of your media files. The prefix works like a folder path in S3, and is combined with the WhatsApp mediaId to create the final file path.

For example, if a media file's WhatsApp mediaId is 123.ogg, and the key is audio/example.ogg, the final file path is audio/example.ogg123.ogg.

For the same mediaId, a key of audio/ results in the file path audio/123.ogg.