DomainInfo - Amazon Simple Workflow Service
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

DomainInfo

Contains general information about a domain.

Contents

name

The name of the domain. This name is unique within the account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

status

The status of the domain:

  • REGISTERED – The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.

  • DEPRECATED – The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.

Type: String

Valid Values: REGISTERED | DEPRECATED

Required: Yes

arn

The ARN of the domain.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: No

description

The description of the domain provided through RegisterDomain.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: