DomainInfo

Contains general information about a domain.

AutomationTask CoordinationWorkflow

Properties

Name Type Description
name object
status object
description object
arn object
View JSON Schema on GitHub

JSON Schema

amazon-swf-domaininfo-schema.json Raw ↑
{
  "type": "object",
  "required": [
    "name",
    "status"
  ],
  "properties": {
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DomainName"
        },
        {
          "description": "The name of the domain. This name is unique within the account."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RegistrationStatus"
        },
        {
          "description": "<p>The status of the domain:</p> <ul> <li> <p> <code>REGISTERED</code> \u2013 The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions. </p> </li> <li> <p> <code>DEPRECATED</code> \u2013 The domain was deprecated using <a>DeprecateDomain</a>, but is still in use. You should not create new workflow executions in this domain. </p> </li> </ul>"
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "The description of the domain provided through <a>RegisterDomain</a>."
        }
      ]
    },
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The ARN of the domain."
        }
      ]
    }
  },
  "description": "Contains general information about a domain.",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DomainInfo"
}