Types

The structures of the data returned or required by various API calls are described here.

Responses

typeddict storage3.types.SignedUploadURL

typing.TypedDict.

Required Keys:

• signed_url (str)

• token (str)

• path (str)

Options

typeddict storage3.types.CreateOrUpdateBucketOptions

typing.TypedDict.

Optional Keys:

• public (bool)

• file_size_limit (int)

• allowed_mime_types (list[str])

typeddict storage3.types.ListBucketFilesOptions

typing.TypedDict.

Required Keys:

• limit (int)

• offset (int)

• sortBy (_sortByType)

typeddict storage3.types.TransformOptions

typing.TypedDict.

Optional Keys:

• height (int)

• width (int)

• resize (Literal['cover', 'contain', 'fill'])

• format (Literal['origin', 'avif'])

• quality (int)

typeddict storage3.types.URLOptions

typing.TypedDict.

Optional Keys:

• download (Union[str, bool])

• transform (TransformOptions)

typeddict storage3.types.CreateSignedURLsOptions

typing.TypedDict.

Optional Keys:

• download (Union[str, bool])

typeddict storage3.types.FileOptions

typing.TypedDict.

Optional Keys:

• cache-control (str)

• content-type (str)

• x-upsert (str)

typeddict storage3.types._sortByType

typing.TypedDict.

Required Keys:

• column (str)

• order (Literal['asc', 'desc'])