Balcony as a Python Library

Using custom boto3 Session

Balcony will use the AWS credentials in your environment by default.

You can configure the boto3 Session in your code and pass it to Balcony.

from balcony import BalconyAWS

boto3_session = boto3.session.Session(
    aws_access_key_id='...',
    aws_secret_access_key='...',
    aws_session_token = '...',
    region_name='...',
    profile_name = '...'
)

baws = BalconyAWS(boto3_session)

If you don't provide your boto3_session, default AWS credentials will be used.

Listing available AWS services

from balcony import BalconyAWS
baws = BalconyAWS()

service_names = baws.get_available_service_names()
print(service_names)

Reading a Resource Node

This operation read all operations for given resource_node_name.

For example, if iam.Policy has GetPolicy and ListPolicies operations, both of them will be read.

from balcony import BalconyAWS
baws = BalconyAWS()

all_policies = baws.read_resource_node('iam', 'Policy')
print(all_policies)

Reading a specific Operation

You can read a single operation by providing it's name.

from balcony import BalconyAWS
baws = BalconyAWS()

policies = baws.read_operation(
    service_name='iam',
    resource_node_name='Policy',
    operation_name='ListPolicies'
)
print(policies)

Listing the ResourceNodes of a Service

You can traverse the ResourceNodes through the ServiceNode.

from balcony import BalconyAWS
baws = BalconyAWS()

service_node = baws.get_service_node(service_name='s3')
print(service_node)
resource_nodes = service_node.get_resource_nodes() 
print(resource_nodes)