Provides a botocore.session.Session implementation for accessing EchoStream Tenant resources
Project description
echostream-botocore
Provides a botocore.session.Session
implementation for accessing EchoStream Tenant resources
This package provides two primary mechanisms to create a botocore.session.Session
object in your EchoStream Tenant; ApiSession
or AppSession
. These session objects will automatically refresh both your Cognito credentials and your botocore credentials (using the EchoStream AppSync API).
Installation
pip install echostream-botocore
Common parameters
Parameter | ENV VAR | Description | Required |
---|---|---|---|
appsync_endpoint |
APPSYNC_ENDPOINT |
The EchoStream AppSync endpoint | If cognito not provided |
client_id |
CLIENT_ID |
The Cognito Client Id for the provided user_pool_id |
If cognito not provided |
cognito |
N/A | A pycognito.Cognito object |
If other parameters are not provided |
duration |
N/A | The length of time that the underlying credentials should be good for in seconds; shoudl be greater than 900 |
Defaults to 3600 |
password |
PASSWORD |
The password associated with username |
If cognito not provided |
tenant |
TENANT |
The name of the EchoStream Tenant | Yes |
user_pool_id |
USER_POOL_ID |
The Cognito User Pool Id | If cognito not provided |
username |
USER_NAME |
The username of the ApiUser |
If cognito not provided |
ApiSession
ApiSession
objects are used to gain a Tenant-level botocore.session.Session
in your Tenant using an EchoStream ApiUser
.
ApiSession
s may be created using a pycognito.Cognito
instance or via a combination of environment variables and parameters. The environment variables or parameters are interchangeable. All parameters/environment variables are required if a Cognito
object is not provided. If a Cognito
object is provided, then all parameters/environment varaiables are ignored and it is assumed that the Cognito
object references an ApiUser
.
Usage (assuming correct ENV setup)
from boto3 import Session
from echostream_botocore import ApiSession
session = Session(
botocore_session=ApiSession(),
region_name="us-east-1"
)
ddb_client = session.client("dynamodb")
...
AppSession
AppSession
objects are used to gain a App-level botocore.session.Session
in your Tenant using an EchoStream AppUser
.
AppSession
s may be created using a pycognito.Cognito
instance or via a combination of environment variables and parameters. The environment variables or parameters are interchangeable. All parameters/environment variables are required if a Cognito
object is not provided. If a Cognito
object is provided, then all parameters/environment varaiables are ignored and it is assumed that the Cognito
object references an AppUser
.
Additional Parameters
Parameter | ENV VAR | Description | Required |
---|---|---|---|
app |
APP |
The name of the EchoStream App | Yes |
Usage (assuming correct ENV setup)
from boto3 import Session
from echostream_botocore import AppSession
session = Session(
botocore_session=AppSession(),
region_name="us-east-1"
)
ddb_client = session.client("dynamodb")
...
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for echostream-botocore-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d7f62e2e5a5dca29b0569934fbcb90cf88b1a7ba0862a1a26907e577e8b73e4 |
|
MD5 | f7e9ecf7087da47c59f69b0a46f8efdb |
|
BLAKE2b-256 | 19e6e65c6df60891572f5773a239feff791aa7d3744d342594805bf12bf66a21 |
Hashes for echostream_botocore-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 781253697f4ab2f8a720dd037e4ae73e8ed3d2e7cf0def3f995d228fbfd2a656 |
|
MD5 | db24bfd13b2c7a7803c7e932c33fc085 |
|
BLAKE2b-256 | b972be5d7ad29dcb77d5916983c1b030f0c315e0c29b0ee5c086610422643dc4 |