Domains¶

SWF domain management.

`DomainConfiguration`	Domain configuration.
`DomainDetails`	Domain details and configuration.
`DomainInfo`	Domain details.
`deprecate_domain`	Deprecate (deactivate) a domain.
`describe_domain`	Describe a domain.
`get_domain_tags`	Get a domain's tags.
`list_domains`	List domains; retrieved semi-lazily.
`register_domain`	Register a new domain.
`tag_domain`	Add tags to domain.
`undeprecate_domain`	Undeprecate (reactivate) a domain.
`untag_domain`	Remove tags from a domain.

class swf_typed.DomainConfiguration(execution_retention: timedelta)[source]¶

Domain configuration.

execution_retention: timedelta¶: Maximum age of retained executions.

classmethod from_api(data) → DomainConfiguration[source]¶: Deserialise from SWF API response data.

class swf_typed.DomainDetails(info: DomainInfo, configuration: DomainConfiguration)[source]¶

Domain details and configuration.

configuration: DomainConfiguration¶: Domain configuration.

classmethod from_api(data) → DomainDetails[source]¶: Deserialise from SWF API response data.

info: DomainInfo¶: Domain details.

class swf_typed.DomainInfo(name: str, is_deprecated: bool, arn: str, description: str = None)[source]¶

Domain details.

arn: str¶: Domain ARN.

description: str = None¶: Domain description.

classmethod from_api(data) → DomainInfo[source]¶: Deserialise from SWF API response data.

is_deprecated: bool¶: Domain is deprecated and not active.

name: str¶: Domain name.

swf_typed.deprecate_domain(domain: str, client: botocore.client.BaseClient = None) → None[source]¶

Deprecate (deactivate) a domain.

Parameters:

domain – domain to deprecate
client – SWF client

swf_typed.describe_domain(domain: str, client: botocore.client.BaseClient = None) → DomainDetails[source]¶

Describe a domain.

Parameters:

domain – domain to describe
client – SWF client

Returns:

domain details and configuration

swf_typed.get_domain_tags(domain_arn: str, client: botocore.client.BaseClient = None) → Dict[str, str][source]¶

Get a domain’s tags.

Parameters:

domain_arn – domain AWS ARN
client – SWF client

Returns:

domain’s resource tags

swf_typed.list_domains(deprecated: bool = False, reverse: bool = False, client: botocore.client.BaseClient = None) → Generator[DomainInfo, None, None][source]¶

List domains; retrieved semi-lazily.

Parameters:

deprecated – list deprecated domains instead of non-deprecated
reverse – return results in reverse alphabetical order
client – SWF client

Returns:

domains

swf_typed.register_domain(domain: str, configuration: DomainConfiguration, description: str = None, tags: Dict[str, str] = None, client: botocore.client.BaseClient = None) → None[source]¶

Parameters:

domain – domain name
configuration – configuration
description – domain description
tags – domain’s resource tags
client – SWF client

swf_typed.tag_domain(domain_arn: str, tags: Dict[str, str], client: botocore.client.BaseClient = None) → None[source]¶

Add tags to domain.

Parameters:

domain_arn – domain AWS ARN
tags – tags to add
client – SWF client

swf_typed.undeprecate_domain(domain: str, client: botocore.client.BaseClient = None) → None[source]¶

Undeprecate (reactivate) a domain.

Parameters:

domain – domain to undeprecate
client – SWF client

swf_typed.untag_domain(domain_arn: str, tags: List[str], client: botocore.client.BaseClient = None) → None[source]¶

Remove tags from a domain.

Parameters:

domain_arn – domain AWS ARN
tags – tags (keys) to remove
client – SWF client