miniopy_async.credentials package

Credential module.

Submodules

miniopy_async.credentials.credentials module

Credential definitions to access S3 service.

class miniopy_async.credentials.credentials.Credentials(access_key: str, secret_key: str, session_token: str | None = None, expiration: datetime | None = None)

Bases: object

Represents credentials access key, secret key and session token.

property access_key: str

Get access key.

is_expired() → bool

Check whether this credentials expired or not.

property secret_key: str

Get secret key.

property session_token: str | None

Get session token.

miniopy_async.credentials.providers module

Credential providers.

class miniopy_async.credentials.providers.AWSConfigProvider(filename: str | None = None, profile: str | None = None)

Bases: Provider

Credential provider from AWS credential file.

async retrieve() → Credentials

Retrieve credentials from AWS configuration file.

class miniopy_async.credentials.providers.AssumeRoleProvider(sts_endpoint: str, access_key: str, secret_key: str, duration_seconds: int = 0, policy: str | None = None, region: str | None = None, role_arn: str | None = None, role_session_name: str | None = None, external_id: str | None = None, client_session: Callable[[...], ClientSession | RetryClient] | None = None)

Bases: Provider

Assume-role credential provider.

async retrieve() → Credentials

Retrieve credentials.

class miniopy_async.credentials.providers.CertificateIdentityProvider(sts_endpoint: str, cert_file: str | None = None, key_file: str | None = None, key_password: str | None = None, ca_certs: str | None = None, duration_seconds: int = 0, client_session: Callable[[...], ClientSession | RetryClient] | None = None)

Bases: Provider

Credential provider using AssumeRoleWithCertificate API.

async retrieve() → Credentials

Retrieve credentials.

class miniopy_async.credentials.providers.ChainedProvider(providers: list[Provider])

Bases: Provider

Chained credential provider.

async retrieve() → Credentials

Retrieve credentials from one of available provider.

class miniopy_async.credentials.providers.ClientGrantsProvider(jwt_provider_func: Callable[[], Awaitable[dict[str, str]]], sts_endpoint: str, duration_seconds: int = 0, policy: str | None = None, client_session: Callable[[...], ClientSession | RetryClient] | None = None)

Bases: WebIdentityClientGrantsProvider

Credential provider using AssumeRoleWithClientGrants API.

class miniopy_async.credentials.providers.EnvAWSProvider

Bases: Provider

Credential provider from AWS environment variables.

async retrieve() → Credentials

Retrieve credentials.

class miniopy_async.credentials.providers.EnvMinioProvider

Bases: Provider

Credential provider from MinIO environment variables.

async retrieve() → Credentials

Retrieve credentials.

class miniopy_async.credentials.providers.IamAwsProvider(custom_endpoint: str | None = None, client_session: Callable[[...], ClientSession | RetryClient] | None = None, auth_token: str | None = None, relative_uri: str | None = None, full_uri: str | None = None, token_file: str | None = None, role_arn: str | None = None, role_session_name: str | None = None, region: str | None = None)

Bases: Provider

Credential provider using IAM roles for Amazon EC2/ECS.

async fetch(url: str, headers: dict[str, str] | None = None) → Credentials

Fetch credentials from EC2/ECS.

async retrieve() → Credentials

Retrieve credentials from WebIdentity/EC2/ECS.

class miniopy_async.credentials.providers.LdapIdentityProvider(sts_endpoint: str, ldap_username: str, ldap_password: str, client_session: Callable[[...], ClientSession | RetryClient] | None = None)

Bases: Provider

Credential provider using AssumeRoleWithLDAPIdentity API.

async retrieve() → Credentials

Retrieve credentials.

class miniopy_async.credentials.providers.MinioClientConfigProvider(filename: str | None = None, alias: str | None = None)

Bases: Provider

Credential provider from MinIO Client configuration file.

async retrieve() → Credentials

Retrieve credential value from MinIO client configuration file.

class miniopy_async.credentials.providers.Provider

Bases: object

Credential retriever.

abstract async retrieve() → Credentials

Retrieve credentials and its expiry if available.

class miniopy_async.credentials.providers.StaticProvider(access_key: str, secret_key: str, session_token: str | None = None)

Bases: Provider

Fixed credential provider.

async retrieve() → Credentials

Return passed credentials.

class miniopy_async.credentials.providers.WebIdentityClientGrantsProvider(jwt_provider_func: Callable[[], Awaitable[dict[str, str]]], sts_endpoint: str, duration_seconds: int = 0, policy: str | None = None, role_arn: str | None = None, role_session_name: str | None = None, client_session: Callable[[...], ClientSession | RetryClient] | None = None)

Bases: Provider

Base class for WebIdentity and ClientGrants credentials provider.

async retrieve() → Credentials

Retrieve credentials.

class miniopy_async.credentials.providers.WebIdentityProvider(jwt_provider_func: Callable[[], Awaitable[dict[str, str]]], sts_endpoint: str, duration_seconds: int = 0, policy: str | None = None, role_arn: str | None = None, role_session_name: str | None = None, client_session: Callable[[...], ClientSession | RetryClient] | None = None)

Bases: WebIdentityClientGrantsProvider

Credential provider using AssumeRoleWithWebIdentity API.