S3AccessKeyCredentials

classView source ↗

class S3AccessKeyCredentials(
    aws_access_key_id: str | dict | Secret,
    aws_secret_access_key: str | dict | Secret,
)

Bases: S3Credentials

Categories: credentials

Credentials class to store the credentials needed to access an S3 bucket using access key credentials (access key id and secret access key).

Attributes: aws_access_key_id (Secret): The AWS access key id. aws_secret_access_key (Secret): The AWS secret access key.

Methods: to_dict() -> dict: Convert the S3AccessKeyCredentials object to a dictionary

Initialize the S3AccessKeyCredentials object.

Parameters

parameter

aws_access_key_idstr | dict | Secret

The AWS access key id.

parameter

aws_secret_access_keystr | dict | Secret

The AWS secret access key.

Properties

property

aws_access_key_idSecret

The AWS access key id.

property

aws_secret_access_keySecret

The AWS secret access key.

Methods

method

View source ↗

to_dict

def to_dict() -> dict

Convert the S3AccessKeyCredentials object to a dictionary.

Returns:

dict: A dictionary representation of the S3AccessKeyCredentials object.