deephaven.experimental.s3¶

class Credentials(_j_object)[source]¶

Bases: JObjectWrapper

Credentials object for authenticating with an S3 server.

classmethod anonymous()[source]¶

Anonymous credentials provider, which can only be used to read data with S3 policy set to allow anonymous access. :rtype: Credentials

Returns:
Credentials: the credentials object.

classmethod basic(access_key_id, secret_access_key)[source]¶

Basic credentials provider with the specified access key id and secret access key.

Parameters:

access_key_id (str) – the access key id, used to identify the user.
secret_access_key (str) – the secret access key, used to authenticate the user.

Returns:

the credentials object.

Return type:

Credentials

classmethod default()[source]¶

Default credentials provider used by the AWS SDK that looks for credentials in this order: Java System Properties (aws.accessKeyId and aws.secretAccessKey), Environment Variables (AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY), Credential profiles file at the default location (~/.aws/credentials), and Instance profile credentials delivered through the Amazon EC2 metadata service.

Returns:: the credentials object.
Return type:: Credentials

j_object_type¶: alias of Credentials

classmethod profile()[source]¶

Use the profile name, config file path, or credentials file path from S3 Instructions for loading the credentials and fail if none found.

Returns:: the credentials object.
Return type:: Credentials

classmethod resolving()[source]¶

Default credentials provider used by Deephaven which resolves credentials in the following order:

1. If a profile name, config file path, or credentials file path is provided via S3 Instructions, use the profile_name for loading the credentials from the config and credentials file and fail if none is found.

2. Otherwise, use the default AWS SDK behavior that looks for credentials in this order: Java System Properties (aws.accessKeyId and aws.secretAccessKey), Environment Variables (AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY), Credential profiles file at the default location (~/.aws/credentials), or Instance profile credentials delivered through the Amazon EC2 metadata service. If still none found, fall back to anonymous credentials, which can only be used to read data with S3 policy set to allow anonymous access.

Returns:: the credentials object.
Return type:: Credentials

classmethod session(access_key_id, secret_access_key, session_token)[source]¶

Session credentials provider with the specified access key id, secret access key, and session token. This is useful when using temporary credentials from AWS STS or similar services.

Parameters:

access_key_id (str) – the access key id, used to identify the user.
secret_access_key (str) – the secret access key, used to authenticate the user.
session_token (str) – the session token, used for temporary credentials.

Returns:

the credentials object.

Return type:

Credentials

class S3Instructions(region_name=None, credentials=None, max_concurrent_requests=None, read_ahead_count=None, fragment_size=None, connection_timeout=None, read_timeout=None, write_timeout=None, access_key_id=None, secret_access_key=None, anonymous_access=False, endpoint_override=None, write_part_size=None, num_concurrent_write_parts=None, profile_name=None, config_file_path=None, credentials_file_path=None)[source]¶

Bases: JObjectWrapper

S3Instructions provides specialized instructions for reading from and writing to S3-compatible APIs.

j_object_type¶: alias of S3Instructions