Menu
AWS Storage Gateway Service
API Reference (API Version 2013-06-30)

JoinDomain

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

Request Syntax

{ "DomainName": "string", "GatewayARN": "string", "Password": "string", "UserName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DomainName

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

Type: String

Pattern: ^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$

Required: Yes

GatewayARN

The unique Amazon Resource Name (ARN) of the file gateway you want to add to the Active Directory domain.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: Yes

Password

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

Type: String

Pattern: ^[ -~]+$

Required: Yes

UserName

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

Type: String

Pattern: ^\w[\w\.\- ]*$

Required: Yes

Response Syntax

{ "GatewayARN": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

GatewayARN

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

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An internal server error has occurred during the request. For more information, see the error and message fields.

HTTP Status Code: 400

InvalidGatewayRequestException

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

HTTP Status Code: 400

See Also

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