Skip to content

JoinDomainOutput

Source code in docs_src/capo_storage_gateway/types/join_domain_output.py
class JoinDomainOutput(TypedDict, closed=True):
    gateway_arn: NotRequired["capo_storage_gateway.types.gateway_arn.GatewayARN"]
    """<p>The unique Amazon Resource Name (ARN) of the gateway that joined the domain.</p>"""
    active_directory_status: NotRequired[
        "capo_storage_gateway.types.active_directory_status.ActiveDirectoryStatus"
    ]
    """<p>Indicates the status of the gateway as a member of the Active Directory domain.</p> <note> <p>This field is only used as part of a <code>JoinDomain</code> request. It is not affected by Active Directory connectivity changes that occur after the <code>JoinDomain</code> request succeeds.</p> </note> <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>INSUFFICIENT_PERMISSIONS</code>: Indicates that the <code>JoinDomain</code> operation failed because the specified user lacks the necessary permissions to join the domain.</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>"""

active_directory_status instance-attribute

active_directory_status: NotRequired[ActiveDirectoryStatus]

Indicates the status of the gateway as a member of the Active Directory domain.

This field is only used as part of a JoinDomain request. It is not affected by Active Directory connectivity changes that occur after the JoinDomain request succeeds.

  • ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

  • DETACHED: Indicates that gateway is not joined to a domain.

  • JOINED: Indicates that the gateway has successfully joined a domain.

  • JOINING: Indicates that a JoinDomain operation is in progress.

  • INSUFFICIENT_PERMISSIONS: Indicates that the JoinDomain operation failed because the specified user lacks the necessary permissions to join the domain.

  • NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

  • TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.

  • UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

gateway_arn instance-attribute

gateway_arn: NotRequired[GatewayARN]

The unique Amazon Resource Name (ARN) of the gateway that joined the domain.