AwsAccount

Aws Account resource for Zscaler Cloud & Branch Connector.

Resource operations

This resource supports the following standard methods: create(), load(), update(), delete(). They operate on the instance state — set properties with dot notation, then call the method with no arguments. Any other action listed below is a custom action that takes explicit keyword arguments and returns a value.

Quick Start

import zssdk
import logging

# Enable debug logging for AwsAccount
logging.getLogger('zssdk.ztw').setLevel(logging.DEBUG)
logging.basicConfig(level=logging.DEBUG)

session = zssdk.Session(
    vanity_domain="your-vanity-domain",
    client_id="your-client-id",
    client_secret="your-client-secret",
)

# Get a specific AwsAccount
resource = session.ztw.AwsAccount(id="your-resource-id")
resource.load()
print(resource)

# Debug output shows HTTP request/response details

Identifiers

Name	Type	Description
id	string	Unique identifier

Actions

create()

Creates a new AwsAccount. Set properties on the resource instance, then call create() — this method takes no arguments.

Properties for creation:

Name	Type	Required	Description
account_details	AwsAccountDetails	No	-
account_groups	EntityReferenceWrapperCollection	No	-
cloud_type	string	No	-
external_id	string	No	-
last_mod_time	integer	No	-
last_mod_user	EntityReference	No	-
last_sync_time	integer	No	-
name	string	Yes	-
permission_status	StringRecord	No	-
region_status	RegionStatusWrapperCollection	No	-
supported_regions	SupportedRegionWrapperCollection	Yes	-

Returns: AwsAccount

Example:

resource = session.ztw.AwsAccount()
resource.name = "example-name"
resource.supported_regions = [{"cloud_type": "value", "id": 3600, "name": "example-name"}]
resource.create()
print(f"Created with ID: {resource.id}")

delete()

Deletes a AwsAccount by id. Only the id identifier is required; delete() takes no other arguments.

Example:

resource = session.ztw.AwsAccount(id="your-resource-id")
resource.delete()

disable_aws_account()

Parameters:

Name	Type	Required	Description
enable	boolean	No	-

Returns: AwsAccount

Example:

resource = session.ztw.AwsAccount(id="your-resource-id")
result = resource.disable_aws_account()
print(result)

generate_external_id()

Parameters:

Name	Type	Required	Description
aws_account_id	string	No	-
aws_role_name	string	No	-

Example:

resource = session.ztw.AwsAccount()
result = resource.generate_external_id()
print(result)

get_aws_account_count()

Example:

resource = session.ztw.AwsAccount()
result = resource.get_aws_account_count()
print(result)

get_cloud_formation_template_url()

Parameters:

Name	Type	Required	Description
aws_account_id	string	No	-

Example:

resource = session.ztw.AwsAccount()
result = resource.get_cloud_formation_template_url()
print(result)

load()

Fetches an existing AwsAccount by id. Only the id identifier is required; load() takes no other arguments.

Returns: AwsAccount

Example:

resource = session.ztw.AwsAccount(id="your-resource-id")
resource.load()
print(resource.name)

update()

Updates an existing AwsAccount. Call load() first, modify properties, then call update() — this method takes no arguments.

Properties for update:

Name	Type	Required	Description
account_details	AwsAccountDetails	No	-
account_groups	EntityReferenceWrapperCollection	No	-
cloud_type	string	No	-
external_id	string	No	-
last_mod_time	integer	No	-
last_mod_user	EntityReference	No	-
last_sync_time	integer	No	-
name	string	Yes	-
permission_status	StringRecord	No	-
region_status	RegionStatusWrapperCollection	No	-
supported_regions	SupportedRegionWrapperCollection	Yes	-

Returns: AwsAccount

Example:

resource = session.ztw.AwsAccount(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

Attributes

Name	Type	Required	Description
account_details	AwsAccountDetails	No	-
account_groups	EntityReferenceWrapperCollection	No	-
cloud_type	string	No	-
external_id	string	No	-
id	integer	Yes	-
last_mod_time	integer	No	-
last_mod_user	EntityReference	No	-
last_sync_time	integer	No	-
name	string	Yes	-
permission_status	StringRecord	No	-
region_status	RegionStatusWrapperCollection	No	-
supported_regions	SupportedRegionWrapperCollection	Yes	-

Related

• AwsAccount - Data structure definition
• Logging guide - enable verbose logs while debugging this resource