awsapilib.controltower.resources package¶

Submodules¶

awsapilib.controltower.resources.configuration module¶

configuration module.

Import all parts from configuration here

awsapilib.controltower.resources.resources module¶

resources module.

Import all parts from resources here

class awsapilib.controltower.resources.resources.AccountFactory(service_catalog_client, data)[source]¶

Bases: object

Models the account factory data of service catalog.

class awsapilib.controltower.resources.resources.ControlTowerAccount(control_tower, data, info_polling_interval=30)[source]¶

Bases: LoggerMixin

Models the account data.

property arn¶: Arn.

attach_service_control_policy(name)[source]¶

Attaches a Service Control Policy to the account.

Parameters:: name (str) – The name of the SCP to attach
Returns:: True on success, False otherwise.
Return type:: result (bool)

property created_time¶: Created Time.

delete(suspended_ou_name=None)[source]¶: Delete.

detach_service_control_policy(name)[source]¶

Detaches a Service Control Policy from the account.

Parameters:: name (str) – The name of the SCP to detach
Returns:: True on success, False otherwise.
Return type:: result (bool)

property email¶: Email.

property guardrail_compliance_status¶

Retrieves the guardrail compliancy status for the account.

Returns:: COMPLIANT|NON COMPLIANT
Return type:: status (str)

property has_available_update: bool¶: If the account is behind the landing zone version.

property id¶: Id.

property idempotency_token¶: Idempotency Token.

property landing_zone_version¶: Landing zone version.

property last_record_id¶: Last Record ID.

property name¶: Name.

property organizational_unit¶: Organizational Unit.

property owner¶: Owner.

property physical_id¶: Physical ID.

property provision_state¶: Provision state.

property provisioning_artifact_id¶: Provisioning artifact ID.

property service_catalog_id¶: Service Catalog ID.

property service_catalog_product_id¶: Service catalog product ID.

property service_catalog_status¶: Service catalog status.

property service_catalog_tags¶: Service catalog tags.

property service_catalog_type¶: Service catalog type.

property service_catalog_user_arn¶: Service catalog user arn.

property sso_user_email¶: SSO user email.

property sso_user_portal¶: SSO user portal.

property stack_arn¶: Stack Arn.

property status¶: Status.

update()[source]¶

Updates the account in service catalog.

Returns:: True if the call succeeded False otherwise

property user_arn_session¶: User arn session.

class awsapilib.controltower.resources.resources.ControlTowerOU(control_tower, data)[source]¶

Bases: LoggerMixin

Model the data of a Control Tower managed OU.

property child_ous¶

The list child OUs for this ou.

Returns:: List of Child OUs
Return type:: response (list)

property create_date¶: The date the ou was created in timestamp.

delete()[source]¶

Deletes the ou.

Returns:: True on success, False otherwise.
Return type:: response (bool)

property id¶: OU ID.

property name¶: The name of the OU.

property parent_ou_id¶: The id of the parent OU.

property parent_ou_name¶: The name of the parent OU.

property status¶: The status of the OU.

property type¶: The type of the OU.

class awsapilib.controltower.resources.resources.CoreAccount(control_tower, account_label, data)[source]¶

Bases: object

Models the core landing zone account data.

property core_resource_mappings¶: Core resource mappings.

property email¶: Email.

property id¶: Id.

property label¶: Account label.

property stack_set_arn¶: Stack set arn.

class awsapilib.controltower.resources.resources.GuardRail(control_tower, data)[source]¶

Bases: LoggerMixin

Models the guard rail data.

property behavior¶: Behavior.

property category¶: Category.

property compliancy_status¶: Compliancy status.

property description¶: Description.

property display_name¶: DisplayName.

property name¶: Name.

property provider¶: Provider.

property regional_preference¶: Regional preference.

property type¶: Type.

class awsapilib.controltower.resources.resources.OrganizationsOU(data)[source]¶

Bases: object

Model the data of an Organizations managed OU.

property arn¶: The arn of the OU.

property id¶: The id of the OU.

property name¶: The name of the OU.

property parent_ou_arn¶: The arn of the parent.

property parent_ou_id¶: The id of the parent.

property parent_ou_name¶: The name of the parent.

class awsapilib.controltower.resources.resources.ResultOU(data)[source]¶

Bases: object

Model the data of an child OU described by the api.

property create_date¶: The timestamp of the creation.

property id¶: The id of the OU.

property name¶: The name of the OU.

property parent_ou_id¶: The id of the parent.

property status¶: The status of the OU.

class awsapilib.controltower.resources.resources.ServiceControlPolicy(data)[source]¶

Bases: object

Models the account factory data of service catalog.

property arn¶: Arn.

property aws_managed¶: Aws Managed.

property description¶: Description.

property id¶: Id.

property name¶: Name.

property type¶: Type.

Module contents¶

configuration module.

Import all parts from configuration here