Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.

post/#X-Amz-Target=StorageGateway_20130630.JoinDomain

Headers

X-Amz-Target'StorageGateway_20130630.JoinDomain' required

Request body

GatewayARNstring required

The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and Amazon Web Services Region.

DomainNamestring required

The name of the domain that you want the gateway to join.

OrganizationalUnitstring

The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.

DomainControllersHost[]

List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, <code>mydc.mydomain.com:389</code>.

TimeoutInSecondsinteger

Specifies the time in seconds, in which the <code>JoinDomain</code> operation must complete. The default is 20 seconds.

UserNamestring required

Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.

Passwordstring password required

Sets the password of the user who has permission to add the gateway to the Active Directory domain.

Response

Success

GatewayARNstring

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

ActiveDirectoryStatus'ACCESS_DENIED' | 'DETACHED' | 'JOINED' | 'JOINING' | 'NETWORK_ERROR' | 'TIMEOUT' | 'UNKNOWN_ERROR'
<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>