"DirectoryId": "string", "RegionName": "string", "VPCSettings": {
"SubnetIds": [ "string" ], "VpcId": "string"
}}
Request Parameters
The request accepts the following data in JSON format.
DirectoryId (p. 10)
The identifier of the directory to which you want to add Region replication.
Type: String
Pattern: ^d-[0-9a-f]{10}$
Required: Yes RegionName (p. 10)
The name of the Region where you want to add domain controllers for replication. For example, us-east-1.
Type: String
Length Constraints: Minimum length of 8. Maximum length of 32.
Required: Yes VPCSettings (p. 10)
Contains VPC information for the CreateDirectory (p. 33) or CreateMicrosoftAD (p. 39) operation.
Type: DirectoryVpcSettings (p. 214) object Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 247).
See Also
AccessDeniedException
Client authentication is not available in this region at this time.
HTTP Status Code: 400 ClientException
A client exception has occurred.
HTTP Status Code: 400
DirectoryAlreadyInRegionException
The Region you specified is the same Region where the AWS Managed Microsoft AD directory was created. Specify a different Region and try again.
HTTP Status Code: 400 DirectoryDoesNotExistException
The specified directory does not exist in the system.
HTTP Status Code: 400 DirectoryUnavailableException
The specified directory is unavailable or could not be found.
HTTP Status Code: 400 EntityDoesNotExistException
The specified entity could not be found.
HTTP Status Code: 400 InvalidParameterException
One or more parameters are not valid.
HTTP Status Code: 400 RegionLimitExceededException
You have reached the limit for maximum number of simultaneous Region replications per directory.
HTTP Status Code: 400 ServiceException
An exception has occurred in AWS Directory Service.
HTTP Status Code: 500 UnsupportedOperationException
The operation is not supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
See Also
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AddTagsToResource
AddTagsToResource
Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.
Request Syntax
{
"ResourceId": "string", "Tags": [
{
"Key": "string", "Value": "string"
} ]}
Request Parameters
The request accepts the following data in JSON format.
ResourceId (p. 13)
Identifier (ID) for the directory to which to add the tag.
Type: String
Pattern: ^[d]-[0-9a-f]{10}$
Required: Yes Tags (p. 13)
The tags to be assigned to the directory.
Type: Array of Tag (p. 240) objects Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 247).
ClientException
A client exception has occurred.
HTTP Status Code: 400 EntityDoesNotExistException
The specified entity could not be found.
Examples
HTTP Status Code: 400 InvalidParameterException
One or more parameters are not valid.
HTTP Status Code: 400 ServiceException
An exception has occurred in AWS Directory Service.
HTTP Status Code: 500 TagLimitExceededException
The maximum allowed number of tags was exceeded.
HTTP Status Code: 400
Examples
The following examples are formatted for legibility.
Example Request
This example illustrates one usage of AddTagsToResource.
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 87
X-Amz-Target: DirectoryService_20150416.AddTagsToResource X-Amz-Date: 20161212T222805Z
User-Agent: aws-cli/1.11.24 Python/2.7.9 Windows/7 botocore/1.4.81 Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
Credential=AKIAI7E3BYXS3example/20161212/us-west-2/ds/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target,
Signature=2756d8b256b5e6b3d74879557e4f421d21111510a78c6c3650a7a93809d533c4 { "ResourceId":"d-926example",
"Tags":[
This example illustrates one usage of AddTagsToResource.
HTTP/1.1 200 OK
x-amzn-RequestId: 419ff1d5-c0ba-11e6-9ed0-172b3469d361 Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Mon, 12 Dec 2016 22:28:07 GMT
See Also
{ }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CancelSchemaExtension
CancelSchemaExtension
Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema.
Request Syntax
{
"DirectoryId": "string", "SchemaExtensionId": "string"
}
Request Parameters
The request accepts the following data in JSON format.
DirectoryId (p. 16)
The identifier of the directory whose schema extension will be canceled.
Type: String
Pattern: ^d-[0-9a-f]{10}$
Required: Yes
SchemaExtensionId (p. 16)
The identifier of the schema extension that will be canceled.
Type: String
Pattern: ^e-[0-9a-f]{10}$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 247).
ClientException
A client exception has occurred.
HTTP Status Code: 400 EntityDoesNotExistException
The specified entity could not be found.
HTTP Status Code: 400
Examples
ServiceException
An exception has occurred in AWS Directory Service.
HTTP Status Code: 500
Examples
The following examples are formatted for legibility.
Example Request
This example illustrates one usage of CancelSchemaExtension.
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 68
X-Amz-Target: DirectoryService_20150416.CancelSchemaExtension X-Amz-Date: 20161212T231630Z
User-Agent: aws-cli/1.11.24 Python/2.7.9 Windows/7 botocore/1.4.81 Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
Credential=AKIAI7E3BYXS3example/20161212/us-west-2/ds/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target,
Signature=14da7b7426d03c907c02a3e29f96158b8c1cd2be2e0f323a86b338a1614848f1 { "DirectoryId": "d-926example",
"SchemaExtensionId": "e-926731d2a0"
}
Example Response
This example illustrates one usage of CancelSchemaExtension.
HTTP/1.1 200 OK
x-amzn-RequestId: 04eada50-c0c1-11e6-887b-29887bf36843 Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Mon, 12 Dec 2016 23:16:32 GMT {
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
See Also
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ConnectDirectory
ConnectDirectory
Creates an AD Connector to connect to a self-managed directory.
Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
Request Syntax
{ "ConnectSettings": {
"CustomerDnsIps": [ "string" ], "CustomerUserName": "string", "SubnetIds": [ "string" ], "VpcId": "string"
},
"Description": "string", "Name": "string",
"Password": "string", "ShortName": "string", "Size": "string", "Tags": [
The request accepts the following data in JSON format.
ConnectSettings (p. 19)
A DirectoryConnectSettings (p. 203) object that contains additional information for the operation.
Type: DirectoryConnectSettings (p. 203) object Required: Yes
Description (p. 19)
A description for the directory.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$
Required: No Name (p. 19)
The fully qualified name of your self-managed directory, such as corp.example.com.
Type: String