Skip to content

RegisterDomainInput

Source code in docs_src/capo_swf/types/register_domain_input.py 
16
17
18
19
20
21
22
23
24
25
26
class RegisterDomainInput(TypedDict, closed=True):
    name: "capo_swf.types.domain_name.DomainName"
    r"""<p>Name of the domain to register. The name must be unique in the region that the domain is registered in.</p> <p>The specified string must not start or end with whitespace. It must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (<code>\u0000-\u001f</code> | <code>\u007f-\u009f</code>). Also, it must <i>not</i> be the literal string <code>arn</code>.</p>"""
    description: NotRequired["capo_swf.types.description.Description"]
    """<p>A text description of the domain.</p>"""
    workflow_execution_retention_period_in_days: (
        "capo_swf.types.duration_in_days.DurationInDays"
    )
    """<p>The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn't available in the results of visibility calls.</p> <p>If you pass the value <code>NONE</code> or <code>0</code> (zero), then the workflow execution history isn't retained. As soon as the workflow execution completes, the execution record and its history are deleted.</p> <p>The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-limits.html">Amazon SWF Service Limits</a> in the <i>Amazon SWF Developer Guide</i>.</p>"""
    tags: NotRequired["capo_swf.types.resource_tag_list.ResourceTagList"]
    """<p>Tags to be added when registering a domain.</p> <p>Tags may only contain unicode letters, digits, whitespace, or these symbols: <code>_ . : / = + - @</code>.</p>"""

description instance-attribute 

description: NotRequired[Description]

A text description of the domain.

name instance-attribute 

name: DomainName

Name of the domain to register. The name must be unique in the region that the domain is registered in.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

tags instance-attribute 

tags: NotRequired[ResourceTagList]

Tags to be added when registering a domain.

Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

workflow_execution_retention_period_in_days instance-attribute 

workflow_execution_retention_period_in_days: DurationInDays

The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn't available in the results of visibility calls.

If you pass the value NONE or 0 (zero), then the workflow execution history isn't retained. As soon as the workflow execution completes, the execution record and its history are deleted.

The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.