altimeter.aws.resource.organizations package

Submodules

altimeter.aws.resource.organizations.account module

Resource representing an AWS Account as viewed in Orgs. This tags on things like the Org itself and the OU in which this account lives.

class OrgsAccountResourceSpec

Bases: altimeter.aws.resource.organizations.OrganizationsResourceSpec

Resource representing an AWS Account as viewed in Orgs.

allow_clobber: List[Type] = [<class 'altimeter.aws.resource.unscanned_account.UnscannedAccountResourceSpec'>]
classmethod get_full_type_name()

Get the fully qualified type name for this class, generally something like aws:ec2:instance, aws:iam:role, etc.

Returns

ec2:instance”

Return type

string of full type name, generally something like “aws

classmethod list_from_aws(client, account_id, region)

Return a dict of dicts of the format:

{‘ou_1_arn’: {org_1_dict},

‘ou_2_arn’: {org_2_dict}, …}

Where the dicts represent results from list_accounts_for_parent.

Return type

ListFromAWSResult

schema: Schema = <altimeter.core.graph.schema.Schema object>
type_name: str = 'account'

altimeter.aws.resource.organizations.org module

Resource representing an AWS Organization.

class OrgResourceSpec

Bases: altimeter.aws.resource.organizations.OrganizationsResourceSpec

Resource representing an AWS Org.

classmethod get_full_type_name()

Get the fully qualified type name for this class, generally something like aws:ec2:instance, aws:iam:role, etc.

Returns

ec2:instance”

Return type

string of full type name, generally something like “aws

classmethod list_from_aws(client, account_id, region)

Return a dict of dicts of the format:

{‘org_1_arn’: {org_1_dict},

‘org_2_arn’: {org_2_dict}, …}

Where the dicts represent results from describe_organization.

Return type

ListFromAWSResult

schema: Schema = <altimeter.core.graph.schema.Schema object>
type_name: str = 'organization'

altimeter.aws.resource.organizations.ou module

Resource representing an AWS Organizational Unit.

class OUResourceSpec

Bases: altimeter.aws.resource.organizations.OrganizationsResourceSpec

Resource representing an AWS OU.

classmethod get_full_type_name()

Get the fully qualified type name for this class, generally something like aws:ec2:instance, aws:iam:role, etc.

Returns

ec2:instance”

Return type

string of full type name, generally something like “aws

classmethod list_from_aws(client, account_id, region)

Return a dict of dicts of the format:

{‘ou_1_arn’: {ou_1_dict},

‘ou_2_arn’: {ou_2_dict}, …}

Where the dicts represent results from list_organizational_units_for_parent with some additional info ‘Path’) tagged on.

Return type

ListFromAWSResult

schema: Schema = <altimeter.core.graph.schema.Schema object>
type_name: str = 'ou'

Module contents

Base class for AWS organizations resources.

class OrganizationsResourceSpec

Bases: altimeter.aws.resource.resource_spec.AWSResourceSpec

Base class for AWS organizations resources.

scan_granularity: altimeter.aws.resource.resource_spec.ScanGranularity = 2
service_name: str = 'organizations'
classmethod skip_resource_scan(client, account_id, region)

Return a bool indicating whether this resource class scan should be skipped, in this case skip if the current account is not an org master.

Return type

bool