Amazon Storage Gateway · JSON Structure

Amazon Storage Gateway Join Domain Output Structure

JoinDomainOutput

Type: object Properties: 2
BackupFile StorageGatewayHybrid CloudStorage

JoinDomainOutput is a JSON Structure definition published by Amazon Storage Gateway, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

GatewayARN ActiveDirectoryStatus

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-storage-gateway/refs/heads/main/json-structure/amazon-storage-gateway-join-domain-output-structure.json",
  "name": "JoinDomainOutput",
  "description": "JoinDomainOutput",
  "properties": {
    "GatewayARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GatewayARN"
        },
        {
          "description": "The unique Amazon Resource Name (ARN) of the gateway that joined the domain."
        }
      ]
    },
    "ActiveDirectoryStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ActiveDirectoryStatus"
        },
        {
          "description": "<p>Indicates the status of the gateway as a member of the Active Directory domain.</p> <ul> <li> <p> <code>ACCESS_DENIED</code>: Indicates that the <code>JoinDomain</code> operation failed due to an authentication error.</p> </li> <li> <p> <code>DETACHED</code>: Indicates that gateway is not joined to a domain.</p> </li> <li> <p> <code>JOINED</code>: Indicates that the gateway has successfully joined a domain.</p> </li> <li> <p> <code>JOINING</code>: Indicates that a <code>JoinDomain</code> operation is in progress.</p> </li> <li> <p> <code>NETWORK_ERROR</code>: Indicates that <code>JoinDomain</code> operation failed due to a network or connectivity error.</p> </li> <li> <p> <code>TIMEOUT</code>: Indicates that the <code>JoinDomain</code> operation failed because the operation didn't complete within the allotted time.</p> </li> <li> <p> <code>UNKNOWN_ERROR</code>: Indicates that the <code>JoinDomain</code> operation failed due to another type of error.</p> </li> </ul>"
        }
      ]
    }
  }
}