# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AcceptSharedDirectory](API_AcceptSharedDirectory.md) 
+  [AddIpRoutes](API_AddIpRoutes.md) 
+  [AddRegion](API_AddRegion.md) 
+  [AddTagsToResource](API_AddTagsToResource.md) 
+  [CancelSchemaExtension](API_CancelSchemaExtension.md) 
+  [ConnectDirectory](API_ConnectDirectory.md) 
+  [CreateAlias](API_CreateAlias.md) 
+  [CreateComputer](API_CreateComputer.md) 
+  [CreateConditionalForwarder](API_CreateConditionalForwarder.md) 
+  [CreateDirectory](API_CreateDirectory.md) 
+  [CreateHybridAD](API_CreateHybridAD.md) 
+  [CreateLogSubscription](API_CreateLogSubscription.md) 
+  [CreateMicrosoftAD](API_CreateMicrosoftAD.md) 
+  [CreateSnapshot](API_CreateSnapshot.md) 
+  [CreateTrust](API_CreateTrust.md) 
+  [DeleteADAssessment](API_DeleteADAssessment.md) 
+  [DeleteConditionalForwarder](API_DeleteConditionalForwarder.md) 
+  [DeleteDirectory](API_DeleteDirectory.md) 
+  [DeleteLogSubscription](API_DeleteLogSubscription.md) 
+  [DeleteSnapshot](API_DeleteSnapshot.md) 
+  [DeleteTrust](API_DeleteTrust.md) 
+  [DeregisterCertificate](API_DeregisterCertificate.md) 
+  [DeregisterEventTopic](API_DeregisterEventTopic.md) 
+  [DescribeADAssessment](API_DescribeADAssessment.md) 
+  [DescribeCAEnrollmentPolicy](API_DescribeCAEnrollmentPolicy.md) 
+  [DescribeCertificate](API_DescribeCertificate.md) 
+  [DescribeClientAuthenticationSettings](API_DescribeClientAuthenticationSettings.md) 
+  [DescribeConditionalForwarders](API_DescribeConditionalForwarders.md) 
+  [DescribeDirectories](API_DescribeDirectories.md) 
+  [DescribeDirectoryDataAccess](API_DescribeDirectoryDataAccess.md) 
+  [DescribeDomainControllers](API_DescribeDomainControllers.md) 
+  [DescribeEventTopics](API_DescribeEventTopics.md) 
+  [DescribeHybridADUpdate](API_DescribeHybridADUpdate.md) 
+  [DescribeLDAPSSettings](API_DescribeLDAPSSettings.md) 
+  [DescribeRegions](API_DescribeRegions.md) 
+  [DescribeSettings](API_DescribeSettings.md) 
+  [DescribeSharedDirectories](API_DescribeSharedDirectories.md) 
+  [DescribeSnapshots](API_DescribeSnapshots.md) 
+  [DescribeTrusts](API_DescribeTrusts.md) 
+  [DescribeUpdateDirectory](API_DescribeUpdateDirectory.md) 
+  [DisableCAEnrollmentPolicy](API_DisableCAEnrollmentPolicy.md) 
+  [DisableClientAuthentication](API_DisableClientAuthentication.md) 
+  [DisableDirectoryDataAccess](API_DisableDirectoryDataAccess.md) 
+  [DisableLDAPS](API_DisableLDAPS.md) 
+  [DisableRadius](API_DisableRadius.md) 
+  [DisableSso](API_DisableSso.md) 
+  [EnableCAEnrollmentPolicy](API_EnableCAEnrollmentPolicy.md) 
+  [EnableClientAuthentication](API_EnableClientAuthentication.md) 
+  [EnableDirectoryDataAccess](API_EnableDirectoryDataAccess.md) 
+  [EnableLDAPS](API_EnableLDAPS.md) 
+  [EnableRadius](API_EnableRadius.md) 
+  [EnableSso](API_EnableSso.md) 
+  [GetDirectoryLimits](API_GetDirectoryLimits.md) 
+  [GetSnapshotLimits](API_GetSnapshotLimits.md) 
+  [ListADAssessments](API_ListADAssessments.md) 
+  [ListCertificates](API_ListCertificates.md) 
+  [ListIpRoutes](API_ListIpRoutes.md) 
+  [ListLogSubscriptions](API_ListLogSubscriptions.md) 
+  [ListSchemaExtensions](API_ListSchemaExtensions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [RegisterCertificate](API_RegisterCertificate.md) 
+  [RegisterEventTopic](API_RegisterEventTopic.md) 
+  [RejectSharedDirectory](API_RejectSharedDirectory.md) 
+  [RemoveIpRoutes](API_RemoveIpRoutes.md) 
+  [RemoveRegion](API_RemoveRegion.md) 
+  [RemoveTagsFromResource](API_RemoveTagsFromResource.md) 
+  [ResetUserPassword](API_ResetUserPassword.md) 
+  [RestoreFromSnapshot](API_RestoreFromSnapshot.md) 
+  [ShareDirectory](API_ShareDirectory.md) 
+  [StartADAssessment](API_StartADAssessment.md) 
+  [StartSchemaExtension](API_StartSchemaExtension.md) 
+  [UnshareDirectory](API_UnshareDirectory.md) 
+  [UpdateConditionalForwarder](API_UpdateConditionalForwarder.md) 
+  [UpdateDirectorySetup](API_UpdateDirectorySetup.md) 
+  [UpdateHybridAD](API_UpdateHybridAD.md) 
+  [UpdateNumberOfDomainControllers](API_UpdateNumberOfDomainControllers.md) 
+  [UpdateRadius](API_UpdateRadius.md) 
+  [UpdateSettings](API_UpdateSettings.md) 
+  [UpdateTrust](API_UpdateTrust.md) 
+  [VerifyTrust](API_VerifyTrust.md) 

# AcceptSharedDirectory
<a name="API_AcceptSharedDirectory"></a>

Accepts a directory sharing request that was sent from the directory owner account.

## Request Syntax
<a name="API_AcceptSharedDirectory_RequestSyntax"></a>

```
{
   "SharedDirectoryId": "string"
}
```

## Request Parameters
<a name="API_AcceptSharedDirectory_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [SharedDirectoryId](#API_AcceptSharedDirectory_RequestSyntax) **   <a name="DirectoryService-AcceptSharedDirectory-request-SharedDirectoryId"></a>
Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.   
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Syntax
<a name="API_AcceptSharedDirectory_ResponseSyntax"></a>

```
{
   "SharedDirectory": { 
      "CreatedDateTime": number,
      "LastUpdatedDateTime": number,
      "OwnerAccountId": "string",
      "OwnerDirectoryId": "string",
      "SharedAccountId": "string",
      "SharedDirectoryId": "string",
      "ShareMethod": "string",
      "ShareNotes": "string",
      "ShareStatus": "string"
   }
}
```

## Response Elements
<a name="API_AcceptSharedDirectory_ResponseElements"></a>

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

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

 ** [SharedDirectory](#API_AcceptSharedDirectory_ResponseSyntax) **   <a name="DirectoryService-AcceptSharedDirectory-response-SharedDirectory"></a>
The shared directory in the directory consumer account.  
Type: [SharedDirectory](API_SharedDirectory.md) object

## Errors
<a name="API_AcceptSharedDirectory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryAlreadySharedException **   
The specified directory has already been shared with this AWS account.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## See Also
<a name="API_AcceptSharedDirectory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/AcceptSharedDirectory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/AcceptSharedDirectory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/AcceptSharedDirectory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/AcceptSharedDirectory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/AcceptSharedDirectory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/AcceptSharedDirectory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/AcceptSharedDirectory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/AcceptSharedDirectory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/AcceptSharedDirectory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/AcceptSharedDirectory) 

# AddIpRoutes
<a name="API_AddIpRoutes"></a>

If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. *AddIpRoutes* adds this address block. You can also use *AddIpRoutes* to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC. 

Before you call *AddIpRoutes*, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the *AddIpRoutes* operation, see [AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference](http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

## Request Syntax
<a name="API_AddIpRoutes_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "IpRoutes": [ 
      { 
         "CidrIp": "string",
         "CidrIpv6": "string",
         "Description": "string"
      }
   ],
   "UpdateSecurityGroupForDirectoryControllers": boolean
}
```

## Request Parameters
<a name="API_AddIpRoutes_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_AddIpRoutes_RequestSyntax) **   <a name="DirectoryService-AddIpRoutes-request-DirectoryId"></a>
Identifier (ID) of the directory to which to add the address block.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [IpRoutes](#API_AddIpRoutes_RequestSyntax) **   <a name="DirectoryService-AddIpRoutes-request-IpRoutes"></a>
IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your self-managed domain.  
Type: Array of [IpRoute](API_IpRoute.md) objects  
Required: Yes

 ** [UpdateSecurityGroupForDirectoryControllers](#API_AddIpRoutes_RequestSyntax) **   <a name="DirectoryService-AddIpRoutes-request-UpdateSecurityGroupForDirectoryControllers"></a>
If set to true, updates the inbound and outbound rules of the security group that has the description: "AWS created security group for *directory ID* directory controllers." Following are the new rules:   
Inbound:  
+ Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: DNS (UDP), Protocol: UDP, Range: 53, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: DNS (TCP), Protocol: TCP, Range: 53, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: LDAP, Protocol: TCP, Range: 389, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
+ Type: All ICMP, Protocol: All, Range: N/A, Source: AWS Managed Microsoft AD VPC IPv4 CIDR
  
Outbound:  
+ Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0
These security rules impact an internal network interface that is not exposed publicly.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_AddIpRoutes_ResponseElements"></a>

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

## Errors
<a name="API_AddIpRoutes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityAlreadyExistsException **   
The specified entity already exists.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** IpRouteLimitExceededException **   
The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_AddIpRoutes_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_AddIpRoutes_Example_1"></a>

This example illustrates one usage of AddIpRoutes.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 98
X-Amz-Target: DirectoryService_20150416.AddIpRoutes
X-Amz-Date: 20161212T212029Z
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=477f3a2802dcc303f69499723eb2e29a455fe3d1b646df0dacfd7c005a3a9509

 {
   "DirectoryId":"d-926example",
   "IpRoutes":[
      {
         "Description":"my IpRoute",
         "CidrIp":"12.12.12.12/32"
      }
   ]
 }
```

### Example Response
<a name="API_AddIpRoutes_Example_2"></a>

This example illustrates one usage of AddIpRoutes.

```
HTTP/1.1 200 OK
x-amzn-RequestId: cfc1cbc8-c0b0-11e6-aa44-41d91ee57463
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Mon, 12 Dec 2016 21:20:31 GMT

 {
 }
```

## See Also
<a name="API_AddIpRoutes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/AddIpRoutes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/AddIpRoutes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/AddIpRoutes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/AddIpRoutes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/AddIpRoutes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/AddIpRoutes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/AddIpRoutes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/AddIpRoutes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/AddIpRoutes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/AddIpRoutes) 

# AddRegion
<a name="API_AddRegion"></a>

Adds two domain controllers in the specified Region for the specified directory.

## Request Syntax
<a name="API_AddRegion_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "RegionName": "string",
   "VPCSettings": { 
      "SubnetIds": [ "string" ],
      "VpcId": "string"
   }
}
```

## Request Parameters
<a name="API_AddRegion_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_AddRegion_RequestSyntax) **   <a name="DirectoryService-AddRegion-request-DirectoryId"></a>
The identifier of the directory to which you want to add Region replication.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [RegionName](#API_AddRegion_RequestSyntax) **   <a name="DirectoryService-AddRegion-request-RegionName"></a>
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](#API_AddRegion_RequestSyntax) **   <a name="DirectoryService-AddRegion-request-VPCSettings"></a>
Contains VPC information for the [CreateDirectory](API_CreateDirectory.md), [CreateMicrosoftAD](API_CreateMicrosoftAD.md), or [CreateHybridAD](API_CreateHybridAD.md) operation.  
Type: [DirectoryVpcSettings](API_DirectoryVpcSettings.md) object  
Required: Yes

## Response Elements
<a name="API_AddRegion_ResponseElements"></a>

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

## Errors
<a name="API_AddRegion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
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.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** RegionLimitExceededException **   
You have reached the limit for maximum number of simultaneous Region replications per directory.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_AddRegion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/AddRegion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/AddRegion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/AddRegion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/AddRegion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/AddRegion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/AddRegion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/AddRegion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/AddRegion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/AddRegion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/AddRegion) 

# AddTagsToResource
<a name="API_AddTagsToResource"></a>

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
<a name="API_AddTagsToResource_RequestSyntax"></a>

```
{
   "ResourceId": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_AddTagsToResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ResourceId](#API_AddTagsToResource_RequestSyntax) **   <a name="DirectoryService-AddTagsToResource-request-ResourceId"></a>
Identifier (ID) for the directory to which to add the tag.  
Type: String  
Pattern: `^[d]-[0-9a-f]{10}$`   
Required: Yes

 ** [Tags](#API_AddTagsToResource_RequestSyntax) **   <a name="DirectoryService-AddTagsToResource-request-Tags"></a>
The tags to be assigned to the directory.  
Type: Array of [Tag](API_Tag.md) objects  
Required: Yes

## Response Elements
<a name="API_AddTagsToResource_ResponseElements"></a>

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

## Errors
<a name="API_AddTagsToResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** TagLimitExceededException **   
The maximum allowed number of tags was exceeded.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_AddTagsToResource_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_AddTagsToResource_Example_1"></a>

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":[  
      {  
         "Key":"environment",
         "Value":"production"
      }
   ]
 }
```

### Example Response
<a name="API_AddTagsToResource_Example_2"></a>

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
<a name="API_AddTagsToResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/AddTagsToResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/AddTagsToResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/AddTagsToResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/AddTagsToResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/AddTagsToResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/AddTagsToResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/AddTagsToResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/AddTagsToResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/AddTagsToResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/AddTagsToResource) 

# CancelSchemaExtension
<a name="API_CancelSchemaExtension"></a>

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
<a name="API_CancelSchemaExtension_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "SchemaExtensionId": "string"
}
```

## Request Parameters
<a name="API_CancelSchemaExtension_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_CancelSchemaExtension_RequestSyntax) **   <a name="DirectoryService-CancelSchemaExtension-request-DirectoryId"></a>
The identifier of the directory whose schema extension will be canceled.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [SchemaExtensionId](#API_CancelSchemaExtension_RequestSyntax) **   <a name="DirectoryService-CancelSchemaExtension-request-SchemaExtensionId"></a>
The identifier of the schema extension that will be canceled.  
Type: String  
Pattern: `^e-[0-9a-f]{10}$`   
Required: Yes

## Response Elements
<a name="API_CancelSchemaExtension_ResponseElements"></a>

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

## Errors
<a name="API_CancelSchemaExtension_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_CancelSchemaExtension_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_CancelSchemaExtension_Example_1"></a>

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
<a name="API_CancelSchemaExtension_Example_2"></a>

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
<a name="API_CancelSchemaExtension_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/CancelSchemaExtension) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/CancelSchemaExtension) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/CancelSchemaExtension) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/CancelSchemaExtension) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/CancelSchemaExtension) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/CancelSchemaExtension) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/CancelSchemaExtension) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/CancelSchemaExtension) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/CancelSchemaExtension) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/CancelSchemaExtension) 

# ConnectDirectory
<a name="API_ConnectDirectory"></a>

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](http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

## Request Syntax
<a name="API_ConnectDirectory_RequestSyntax"></a>

```
{
   "ConnectSettings": { 
      "CustomerDnsIps": [ "string" ],
      "CustomerDnsIpsV6": [ "string" ],
      "CustomerUserName": "string",
      "SubnetIds": [ "string" ],
      "VpcId": "string"
   },
   "Description": "string",
   "Name": "string",
   "NetworkType": "string",
   "Password": "string",
   "ShortName": "string",
   "Size": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_ConnectDirectory_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ConnectSettings](#API_ConnectDirectory_RequestSyntax) **   <a name="DirectoryService-ConnectDirectory-request-ConnectSettings"></a>
A [DirectoryConnectSettings](API_DirectoryConnectSettings.md) object that contains additional information for the operation.  
Type: [DirectoryConnectSettings](API_DirectoryConnectSettings.md) object  
Required: Yes

 ** [Description](#API_ConnectDirectory_RequestSyntax) **   <a name="DirectoryService-ConnectDirectory-request-Description"></a>
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](#API_ConnectDirectory_RequestSyntax) **   <a name="DirectoryService-ConnectDirectory-request-Name"></a>
The fully qualified name of your self-managed directory, such as `corp.example.com`.  
Type: String  
Pattern: `^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$`   
Required: Yes

 ** [NetworkType](#API_ConnectDirectory_RequestSyntax) **   <a name="DirectoryService-ConnectDirectory-request-NetworkType"></a>
The network type for your directory. The default value is `IPv4` or `IPv6` based on the provided subnet capabilities.  
Type: String  
Valid Values: `Dual-stack | IPv4 | IPv6`   
Required: No

 ** [Password](#API_ConnectDirectory_RequestSyntax) **   <a name="DirectoryService-ConnectDirectory-request-Password"></a>
The password for your self-managed user account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** [ShortName](#API_ConnectDirectory_RequestSyntax) **   <a name="DirectoryService-ConnectDirectory-request-ShortName"></a>
The NetBIOS name of your self-managed directory, such as `CORP`.  
Type: String  
Pattern: `^[^\\/:*?"<>|.]+[^\\/:*?"<>|]*$`   
Required: No

 ** [Size](#API_ConnectDirectory_RequestSyntax) **   <a name="DirectoryService-ConnectDirectory-request-Size"></a>
The size of the directory.  
Type: String  
Valid Values: `Small | Large`   
Required: Yes

 ** [Tags](#API_ConnectDirectory_RequestSyntax) **   <a name="DirectoryService-ConnectDirectory-request-Tags"></a>
The tags to be assigned to AD Connector.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Syntax
<a name="API_ConnectDirectory_ResponseSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Response Elements
<a name="API_ConnectDirectory_ResponseElements"></a>

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

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

 ** [DirectoryId](#API_ConnectDirectory_ResponseSyntax) **   <a name="DirectoryService-ConnectDirectory-response-DirectoryId"></a>
The identifier of the new directory.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$` 

## Errors
<a name="API_ConnectDirectory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryLimitExceededException **   
The maximum number of directories in the region has been reached. You can use the [GetDirectoryLimits](API_GetDirectoryLimits.md) operation to determine your directory limits in the region.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_ConnectDirectory_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_ConnectDirectory_Example_1"></a>

This example illustrates one usage of ConnectDirectory.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 295
X-Amz-Target: DirectoryService_20150416.ConnectDirectory
X-Amz-Date: 20161212T233740Z
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=60ddfa4a90d91327ef8cb510563d6f031eab1b092d5b1034fab7b157733bf86b

 {
   "Name":"corp.example.com",
   "ConnectSettings":{
      "CustomerUserName":"Administrator",
      "VpcId":"vpc-45025421",
      "SubnetIds":[
         "subnet-ba0146de",
         "subnet-bef46bc8"
      ],
      "CustomerDnsIps":[
         "172.30.21.228"
      ]
   },
   "Description":"Connector to corp",
   "ShortName":"corp",
   "Password":"Str0ngP@ssw0rd",
   "Size":"Small"
 }
```

### Example Response
<a name="API_ConnectDirectory_Example_2"></a>

This example illustrates one usage of ConnectDirectory.

```
HTTP/1.1 200 OK
x-amzn-RequestId: fa22d0f1-c0c3-11e6-9ed0-172b3469d361
Content-Type: application/x-amz-json-1.1
Content-Length: 30
Date: Mon, 12 Dec 2016 23:37:43 GMT

{
   "DirectoryId":"d-926example"
}
```

## See Also
<a name="API_ConnectDirectory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/ConnectDirectory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/ConnectDirectory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/ConnectDirectory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/ConnectDirectory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/ConnectDirectory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/ConnectDirectory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/ConnectDirectory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/ConnectDirectory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/ConnectDirectory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/ConnectDirectory) 

# CreateAlias
<a name="API_CreateAlias"></a>

Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as `http://<alias>.awsapps.com`.

**Important**  
After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

## Request Syntax
<a name="API_CreateAlias_RequestSyntax"></a>

```
{
   "Alias": "string",
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_CreateAlias_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [Alias](#API_CreateAlias_RequestSyntax) **   <a name="DirectoryService-CreateAlias-request-Alias"></a>
The requested alias.  
The alias must be unique amongst all aliases in AWS. This operation throws an `EntityAlreadyExistsException` error if the alias already exists.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 62.  
Pattern: `^(?!D-|d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*`   
Required: Yes

 ** [DirectoryId](#API_CreateAlias_RequestSyntax) **   <a name="DirectoryService-CreateAlias-request-DirectoryId"></a>
The identifier of the directory for which to create the alias.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Syntax
<a name="API_CreateAlias_ResponseSyntax"></a>

```
{
   "Alias": "string",
   "DirectoryId": "string"
}
```

## Response Elements
<a name="API_CreateAlias_ResponseElements"></a>

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

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

 ** [Alias](#API_CreateAlias_ResponseSyntax) **   <a name="DirectoryService-CreateAlias-response-Alias"></a>
The alias for the directory.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 62.  
Pattern: `^(?!D-|d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*` 

 ** [DirectoryId](#API_CreateAlias_ResponseSyntax) **   <a name="DirectoryService-CreateAlias-response-DirectoryId"></a>
The identifier of the directory.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$` 

## Errors
<a name="API_CreateAlias_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityAlreadyExistsException **   
The specified entity already exists.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_CreateAlias_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_CreateAlias_Example_1"></a>

This example illustrates one usage of CreateAlias.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 52X-Amz-Target:DirectoryService_20150416.CreateAlias
X-Amz-Date: 20161209T175951Z
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/20161209/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=673029721752b71c1ff4752d0e42e6a05283c305238538d746c2b42d7864ec11
 
 {
   "DirectoryId": "d-926example",
   "Alias": "myaccess"
 }
```

### Example Response
<a name="API_CreateAlias_Example_2"></a>

This example illustrates one usage of CreateAlias.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 49abfbf6-be39-11e6-9458-41d91ee57463
Content-Type: application/x-amz-json-1.1
Content-Length: 49
Date: Fri, 09 Dec 2016 17:59:57 GMT

{
  "Alias": "myaccess",
  "DirectoryId": "d-926example"
}
```

## See Also
<a name="API_CreateAlias_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/CreateAlias) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/CreateAlias) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/CreateAlias) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/CreateAlias) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/CreateAlias) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/CreateAlias) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/CreateAlias) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/CreateAlias) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/CreateAlias) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/CreateAlias) 

# CreateComputer
<a name="API_CreateComputer"></a>

Creates an Active Directory computer object in the specified directory.

## Request Syntax
<a name="API_CreateComputer_RequestSyntax"></a>

```
{
   "ComputerAttributes": [ 
      { 
         "Name": "string",
         "Value": "string"
      }
   ],
   "ComputerName": "string",
   "DirectoryId": "string",
   "OrganizationalUnitDistinguishedName": "string",
   "Password": "string"
}
```

## Request Parameters
<a name="API_CreateComputer_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ComputerAttributes](#API_CreateComputer_RequestSyntax) **   <a name="DirectoryService-CreateComputer-request-ComputerAttributes"></a>
An array of [Attribute](API_Attribute.md) objects that contain any LDAP attributes to apply to the computer account.  
Type: Array of [Attribute](API_Attribute.md) objects  
Required: No

 ** [ComputerName](#API_CreateComputer_RequestSyntax) **   <a name="DirectoryService-CreateComputer-request-ComputerName"></a>
The name of the computer account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 15.  
Required: Yes

 ** [DirectoryId](#API_CreateComputer_RequestSyntax) **   <a name="DirectoryService-CreateComputer-request-DirectoryId"></a>
The identifier of the directory in which to create the computer account.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [OrganizationalUnitDistinguishedName](#API_CreateComputer_RequestSyntax) **   <a name="DirectoryService-CreateComputer-request-OrganizationalUnitDistinguishedName"></a>
The fully-qualified distinguished name of the organizational unit to place the computer account in.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

 ** [Password](#API_CreateComputer_RequestSyntax) **   <a name="DirectoryService-CreateComputer-request-Password"></a>
A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 64.  
Pattern: `[\u0020-\u00FF]+`   
Required: Yes

## Response Syntax
<a name="API_CreateComputer_ResponseSyntax"></a>

```
{
   "Computer": { 
      "ComputerAttributes": [ 
         { 
            "Name": "string",
            "Value": "string"
         }
      ],
      "ComputerId": "string",
      "ComputerName": "string"
   }
}
```

## Response Elements
<a name="API_CreateComputer_ResponseElements"></a>

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

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

 ** [Computer](#API_CreateComputer_ResponseSyntax) **   <a name="DirectoryService-CreateComputer-response-Computer"></a>
A [Computer](API_Computer.md) object that represents the computer account.  
Type: [Computer](API_Computer.md) object

## Errors
<a name="API_CreateComputer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthenticationFailedException **   
An authentication error occurred.    
 ** Message **   
The textual message for the exception.  
 ** RequestId **   
The identifier of the request that caused the exception.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityAlreadyExistsException **   
The specified entity already exists.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_CreateComputer_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_CreateComputer_Example_1"></a>

This example illustrates one usage of CreateComputer.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 245
X-Amz-Target: DirectoryService_20150416.CreateComputer
X-Amz-Date: 20161213T163452Z
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/20161213/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=5fa12f147bce3620568504361b860de07868da3b1c27d5f0bde6e5ffa51bf6ef

 {
   "DirectoryId":"d-926example",
   "ComputerName":"labcomputer",
   "Password":"Str0ngP@ssw0rd",
   "ComputerAttributes":[
      {
         "Name":"ip",
         "Value":"192.168.101.100"
      }
   ],
   "OrganizationalUnitDistinguishedName":"OU=Computers,OU=example,DC=corp,DC=example,DC=com"
 }
```

### Example Response
<a name="API_CreateComputer_Example_2"></a>

This example illustrates one usage of CreateComputer.

```
HTTP/1.1 200 OK
x-amzn-RequestId: afcea813-c196-11e6-a6a8-5110402a26c3
Content-Type: application/x-amz-json-1.1
Content-Length: 286
Date: Wed, 14 Dec 2016 00:46:03 GMT

{
   "Computer":{
      "ComputerAttributes":[
         {
            "Name":"DistinguishedName",
            "Value":"CN=labcomputer,OU=Computers,OU=example,DC=corp,DC=example,DC=com"
         },
         {
            "Name":"WindowsSamName",
            "Value":"labcomputer$"
         }
      ],
      "ComputerId":"S-1-5-21-1932691875-1648176379-1176097576-1124",
      "ComputerName":"labcomputer"
   }
}
```

## See Also
<a name="API_CreateComputer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/CreateComputer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/CreateComputer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/CreateComputer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/CreateComputer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/CreateComputer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/CreateComputer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/CreateComputer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/CreateComputer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/CreateComputer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/CreateComputer) 

# CreateConditionalForwarder
<a name="API_CreateConditionalForwarder"></a>

Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.

## Request Syntax
<a name="API_CreateConditionalForwarder_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "DnsIpAddrs": [ "string" ],
   "DnsIpv6Addrs": [ "string" ],
   "RemoteDomainName": "string"
}
```

## Request Parameters
<a name="API_CreateConditionalForwarder_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_CreateConditionalForwarder_RequestSyntax) **   <a name="DirectoryService-CreateConditionalForwarder-request-DirectoryId"></a>
The directory ID of the AWS directory for which you are creating the conditional forwarder.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [DnsIpAddrs](#API_CreateConditionalForwarder_RequestSyntax) **   <a name="DirectoryService-CreateConditionalForwarder-request-DnsIpAddrs"></a>
The IP addresses of the remote DNS server associated with RemoteDomainName.  
Type: Array of strings  
Pattern: `^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$`   
Required: No

 ** [DnsIpv6Addrs](#API_CreateConditionalForwarder_RequestSyntax) **   <a name="DirectoryService-CreateConditionalForwarder-request-DnsIpv6Addrs"></a>
The IPv6 addresses of the remote DNS server associated with RemoteDomainName.  
Type: Array of strings  
Pattern: `^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$`   
Required: No

 ** [RemoteDomainName](#API_CreateConditionalForwarder_RequestSyntax) **   <a name="DirectoryService-CreateConditionalForwarder-request-RemoteDomainName"></a>
The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+[.]?$`   
Required: Yes

## Response Elements
<a name="API_CreateConditionalForwarder_ResponseElements"></a>

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

## Errors
<a name="API_CreateConditionalForwarder_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityAlreadyExistsException **   
The specified entity already exists.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_CreateConditionalForwarder_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_CreateConditionalForwarder_Example_1"></a>

This example illustrates one usage of CreateConditionalForwarder.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 105
X-Amz-Target: DirectoryService_20150416.CreateConditionalForwarder
X-Amz-Date: 20161213T215543Z
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/20161213/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=717e381f0258731fe0197c68d1f5d2a0e96825119c15a6e0dcfa2d07063c6af6

 {
   "DirectoryId":"d-926example",
   "RemoteDomainName":"sales.example.com",
   "DnsIpAddrs":[
      "172.30.21.228"
   ]
 }
```

### Example Response
<a name="API_CreateConditionalForwarder_Example_2"></a>

This example illustrates one usage of CreateConditionalForwarder.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 68e74443-c180-11e6-91f4-6dbff6648f8a
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Tue, 13 Dec 2016 22:06:34 GMT

 {

 }
```

## See Also
<a name="API_CreateConditionalForwarder_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/CreateConditionalForwarder) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/CreateConditionalForwarder) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/CreateConditionalForwarder) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/CreateConditionalForwarder) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/CreateConditionalForwarder) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/CreateConditionalForwarder) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/CreateConditionalForwarder) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/CreateConditionalForwarder) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/CreateConditionalForwarder) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/CreateConditionalForwarder) 

# CreateDirectory
<a name="API_CreateDirectory"></a>

Creates a Simple AD directory. For more information, see [Simple Active Directory](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html) in the * AWS Directory Service Admin Guide*.

Before you call `CreateDirectory`, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the `CreateDirectory` operation, see [AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference](http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

## Request Syntax
<a name="API_CreateDirectory_RequestSyntax"></a>

```
{
   "Description": "string",
   "Name": "string",
   "NetworkType": "string",
   "Password": "string",
   "ShortName": "string",
   "Size": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VpcSettings": { 
      "SubnetIds": [ "string" ],
      "VpcId": "string"
   }
}
```

## Request Parameters
<a name="API_CreateDirectory_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_CreateDirectory_RequestSyntax) **   <a name="DirectoryService-CreateDirectory-request-Description"></a>
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](#API_CreateDirectory_RequestSyntax) **   <a name="DirectoryService-CreateDirectory-request-Name"></a>
The fully qualified name for the directory, such as `corp.example.com`.  
Type: String  
Pattern: `^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$`   
Required: Yes

 ** [NetworkType](#API_CreateDirectory_RequestSyntax) **   <a name="DirectoryService-CreateDirectory-request-NetworkType"></a>
The network type for your directory. Simple AD supports IPv4 and Dual-stack only.  
Type: String  
Valid Values: `Dual-stack | IPv4 | IPv6`   
Required: No

 ** [Password](#API_CreateDirectory_RequestSyntax) **   <a name="DirectoryService-CreateDirectory-request-Password"></a>
The password for the directory administrator. The directory creation process creates a directory administrator account with the user name `Administrator` and this password.  
If you need to change the password for the administrator account, you can use the [ResetUserPassword](API_ResetUserPassword.md) API call.  
The regex pattern for this string is made up of the following conditions:  
+ Length (?=^.\$18,64\$1\$1) – Must be between 8 and 64 characters
AND any 3 of the following password complexity rules required by Active Directory:  
+ Numbers and upper case and lowercase (?=.\$1\$1d)(?=.\$1[A-Z])(?=.\$1[a-z])
+ Numbers and special characters and lower case (?=.\$1\$1d)(?=.\$1[^A-Za-z0-9\$1s])(?=.\$1[a-z])
+ Special characters and upper case and lower case (?=.\$1[^A-Za-z0-9\$1s])(?=.\$1[A-Z])(?=.\$1[a-z])
+ Numbers and upper case and special characters (?=.\$1\$1d)(?=.\$1[A-Z])(?=.\$1[^A-Za-z0-9\$1s])
For additional information about how Active Directory passwords are enforced, see [Password must meet complexity requirements](https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/password-must-meet-complexity-requirements) on the Microsoft website.  
Type: String  
Pattern: `(?=^.{8,64}$)((?=.*\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s]))^.*`   
Required: Yes

 ** [ShortName](#API_CreateDirectory_RequestSyntax) **   <a name="DirectoryService-CreateDirectory-request-ShortName"></a>
The NetBIOS name of the directory, such as `CORP`.  
Type: String  
Pattern: `^[^\\/:*?"<>|.]+[^\\/:*?"<>|]*$`   
Required: No

 ** [Size](#API_CreateDirectory_RequestSyntax) **   <a name="DirectoryService-CreateDirectory-request-Size"></a>
The size of the directory.  
Type: String  
Valid Values: `Small | Large`   
Required: Yes

 ** [Tags](#API_CreateDirectory_RequestSyntax) **   <a name="DirectoryService-CreateDirectory-request-Tags"></a>
The tags to be assigned to the Simple AD directory.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [VpcSettings](#API_CreateDirectory_RequestSyntax) **   <a name="DirectoryService-CreateDirectory-request-VpcSettings"></a>
A [DirectoryVpcSettings](API_DirectoryVpcSettings.md) object that contains additional information for the operation.  
Type: [DirectoryVpcSettings](API_DirectoryVpcSettings.md) object  
Required: No

## Response Syntax
<a name="API_CreateDirectory_ResponseSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Response Elements
<a name="API_CreateDirectory_ResponseElements"></a>

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

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

 ** [DirectoryId](#API_CreateDirectory_ResponseSyntax) **   <a name="DirectoryService-CreateDirectory-response-DirectoryId"></a>
The identifier of the directory that was created.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$` 

## Errors
<a name="API_CreateDirectory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryLimitExceededException **   
The maximum number of directories in the region has been reached. You can use the [GetDirectoryLimits](API_GetDirectoryLimits.md) operation to determine your directory limits in the region.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_CreateDirectory_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_CreateDirectory_Example_1"></a>

This example illustrates one usage of CreateDirectory.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 245
X-Amz-Target: DirectoryService_20150416.CreateDirectory
X-Amz-Date: 20161213T222613Z
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/20161213/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=e0bf599277231d294b0ebb1c7ad7a68aafdfc49db016adbee32a167954c53d54

 {
   "Description":"Regional directory for example.com",
   "VpcSettings":{
      "SubnetIds":[
         "subnet-ba0146de",
         "subnet-bef46bc8"
      ],
      "VpcId":"vpc-45025421"
   },
   "Name":"seattle.example.com",
   "ShortName":"seattle",
   "Password":"Str0ngP@ssw0rd",
   "Size":"Small"
 }
```

### Example Response
<a name="API_CreateDirectory_Example_2"></a>

This example illustrates one usage of CreateDirectory.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 298112b6-c183-11e6-9b49-eff49203d13b
Content-Type: application/x-amz-json-1.1
Content-Length: 30
Date: Tue, 13 Dec 2016 22:26:17 GMT

{
   "DirectoryId":"d-926example"
}
```

## See Also
<a name="API_CreateDirectory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/CreateDirectory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/CreateDirectory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/CreateDirectory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/CreateDirectory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/CreateDirectory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/CreateDirectory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/CreateDirectory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/CreateDirectory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/CreateDirectory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/CreateDirectory) 

# CreateHybridAD
<a name="API_CreateHybridAD"></a>

Creates a hybrid directory that connects your self-managed Active Directory (AD) infrastructure and AWS.

You must have a successful directory assessment using [StartADAssessment](API_StartADAssessment.md) to validate your environment compatibility before you use this operation.

Updates are applied asynchronously. Use [DescribeDirectories](API_DescribeDirectories.md) to monitor the progress of directory creation.

## Request Syntax
<a name="API_CreateHybridAD_RequestSyntax"></a>

```
{
   "AssessmentId": "string",
   "SecretArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateHybridAD_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AssessmentId](#API_CreateHybridAD_RequestSyntax) **   <a name="DirectoryService-CreateHybridAD-request-AssessmentId"></a>
The unique identifier of the successful directory assessment that validates your self-managed AD environment. You must have a successful directory assessment before you create a hybrid directory.  
Type: String  
Pattern: `^da-[0-9a-f]{18}$`   
Required: Yes

 ** [SecretArn](#API_CreateHybridAD_RequestSyntax) **   <a name="DirectoryService-CreateHybridAD-request-SecretArn"></a>
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials for the service account used to join hybrid domain controllers to your self-managed AD domain. This secret is used once and not stored.  
The secret must contain key-value pairs with keys matching `customerAdAdminDomainUsername` and `customerAdAdminDomainPassword`. For example: `{"customerAdAdminDomainUsername":"carlos_salazar","customerAdAdminDomainPassword":"ExamplePassword123!"}`.  
Type: String  
Pattern: `^arn:aws:secretsmanager:[a-z0-9-]+:\d{12}:secret:[a-zA-Z0-9/_+=.@-]+-[a-zA-Z0-9]{6}$`   
Required: Yes

 ** [Tags](#API_CreateHybridAD_RequestSyntax) **   <a name="DirectoryService-CreateHybridAD-request-Tags"></a>
The tags to be assigned to the directory. Each tag consists of a key and value pair. You can specify multiple tags as a list.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Syntax
<a name="API_CreateHybridAD_ResponseSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Response Elements
<a name="API_CreateHybridAD_ResponseElements"></a>

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

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

 ** [DirectoryId](#API_CreateHybridAD_ResponseSyntax) **   <a name="DirectoryService-CreateHybridAD-response-DirectoryId"></a>
The unique identifier of the newly created hybrid directory.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$` 

## Errors
<a name="API_CreateHybridAD_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ADAssessmentLimitExceededException **   
A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: `CUSTOMER` and `SYSTEM`. Your AWS account has a limit of 100 `CUSTOMER` directory assessments.  
If you attempt to create a hybrid directory; and you already have 100 `CUSTOMER` directory assessments;, you will encounter an error. Delete assessments to free up capacity before trying again.  
You can request an increase to your `CUSTOMER` directory assessment quota by contacting customer support or delete existing CUSTOMER directory assessments; to free up capacity.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryLimitExceededException **   
The maximum number of directories in the region has been reached. You can use the [GetDirectoryLimits](API_GetDirectoryLimits.md) operation to determine your directory limits in the region.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_CreateHybridAD_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_CreateHybridAD_Example_1"></a>

This example illustrates one usage of CreateHybridAD.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 298
X-Amz-Target: DirectoryService_20150416.CreateHybridAD
X-Amz-Date: 20231212T212029Z
User-Agent: aws-cli/2.0.0 Python/3.8.0 Linux/5.4.0 botocore/2.0.0
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
 Credential=AKIAIOSFODNN7EXAMPLE/20231212/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

{
    "SecretArn": "arn:aws:secretsmanager:eu-west-1:111122223333:secret:CredExample-DZESji",
    "AssessmentId": "da-1234567890example1",
    "Tags": [{
        "Key": "Environment",
        "Value": "Production"
    }]
}
```

### Example Response
<a name="API_CreateHybridAD_Example_2"></a>

This example illustrates one usage of CreateHybridAD.

```
HTTP/1.1 200 OK
x-amzn-RequestId: cfc1cbc8-c0b0-11e6-aa44-41d91ee57463
Content-Type: application/x-amz-json-1.1
Content-Length: 30
Date: Mon, 12 Dec 2023 21:20:31 GMT

{
    "DirectoryId": "d-926example"
}}
```

## See Also
<a name="API_CreateHybridAD_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/CreateHybridAD) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/CreateHybridAD) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/CreateHybridAD) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/CreateHybridAD) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/CreateHybridAD) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/CreateHybridAD) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/CreateHybridAD) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/CreateHybridAD) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/CreateHybridAD) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/CreateHybridAD) 

# CreateLogSubscription
<a name="API_CreateLogSubscription"></a>

Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your AWS account.

## Request Syntax
<a name="API_CreateLogSubscription_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "LogGroupName": "string"
}
```

## Request Parameters
<a name="API_CreateLogSubscription_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_CreateLogSubscription_RequestSyntax) **   <a name="DirectoryService-CreateLogSubscription-request-DirectoryId"></a>
Identifier of the directory to which you want to subscribe and receive real-time logs to your specified CloudWatch log group.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [LogGroupName](#API_CreateLogSubscription_RequestSyntax) **   <a name="DirectoryService-CreateLogSubscription-request-LogGroupName"></a>
The name of the CloudWatch log group where the real-time domain controller logs are forwarded.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `[-._/#A-Za-z0-9]+`   
Required: Yes

## Response Elements
<a name="API_CreateLogSubscription_ResponseElements"></a>

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

## Errors
<a name="API_CreateLogSubscription_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityAlreadyExistsException **   
The specified entity already exists.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InsufficientPermissionsException **   
The account does not have sufficient permission to perform the operation.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_CreateLogSubscription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/CreateLogSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/CreateLogSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/CreateLogSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/CreateLogSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/CreateLogSubscription) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/CreateLogSubscription) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/CreateLogSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/CreateLogSubscription) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/CreateLogSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/CreateLogSubscription) 

# CreateMicrosoftAD
<a name="API_CreateMicrosoftAD"></a>

Creates a Microsoft AD directory in the AWS Cloud. For more information, see [AWS Managed Microsoft AD](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html) in the * AWS Directory Service Admin Guide*.

Before you call *CreateMicrosoftAD*, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the *CreateMicrosoftAD* operation, see [AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference](http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

## Request Syntax
<a name="API_CreateMicrosoftAD_RequestSyntax"></a>

```
{
   "Description": "string",
   "Edition": "string",
   "Name": "string",
   "NetworkType": "string",
   "Password": "string",
   "ShortName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VpcSettings": { 
      "SubnetIds": [ "string" ],
      "VpcId": "string"
   }
}
```

## Request Parameters
<a name="API_CreateMicrosoftAD_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_CreateMicrosoftAD_RequestSyntax) **   <a name="DirectoryService-CreateMicrosoftAD-request-Description"></a>
A description for the directory. This label will appear on the AWS console `Directory Details` page after the directory is created.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$`   
Required: No

 ** [Edition](#API_CreateMicrosoftAD_RequestSyntax) **   <a name="DirectoryService-CreateMicrosoftAD-request-Edition"></a>
 AWS Managed Microsoft AD is available in two editions: `Standard` and `Enterprise`. `Enterprise` is the default.  
Type: String  
Valid Values: `Enterprise | Standard | Hybrid`   
Required: No

 ** [Name](#API_CreateMicrosoftAD_RequestSyntax) **   <a name="DirectoryService-CreateMicrosoftAD-request-Name"></a>
The fully qualified domain name for the AWS Managed Microsoft AD directory, such as `corp.example.com`. This name will resolve inside your VPC only. It does not need to be publicly resolvable.  
Type: String  
Pattern: `^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$`   
Required: Yes

 ** [NetworkType](#API_CreateMicrosoftAD_RequestSyntax) **   <a name="DirectoryService-CreateMicrosoftAD-request-NetworkType"></a>
 The network type for your domain. The default value is `IPv4` or `IPv6` based on the provided subnet capabilities.  
Type: String  
Valid Values: `Dual-stack | IPv4 | IPv6`   
Required: No

 ** [Password](#API_CreateMicrosoftAD_RequestSyntax) **   <a name="DirectoryService-CreateMicrosoftAD-request-Password"></a>
The password for the default administrative user named `Admin`.  
If you need to change the password for the administrator account, you can use the [ResetUserPassword](API_ResetUserPassword.md) API call.  
Type: String  
Pattern: `(?=^.{8,64}$)((?=.*\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s]))^.*`   
Required: Yes

 ** [ShortName](#API_CreateMicrosoftAD_RequestSyntax) **   <a name="DirectoryService-CreateMicrosoftAD-request-ShortName"></a>
The NetBIOS name for your domain, such as `CORP`. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, `CORP` for the directory DNS `corp.example.com`.   
Type: String  
Pattern: `^[^\\/:*?"<>|.]+[^\\/:*?"<>|]*$`   
Required: No

 ** [Tags](#API_CreateMicrosoftAD_RequestSyntax) **   <a name="DirectoryService-CreateMicrosoftAD-request-Tags"></a>
The tags to be assigned to the AWS Managed Microsoft AD directory.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [VpcSettings](#API_CreateMicrosoftAD_RequestSyntax) **   <a name="DirectoryService-CreateMicrosoftAD-request-VpcSettings"></a>
Contains VPC information for the [CreateDirectory](API_CreateDirectory.md) or [CreateMicrosoftAD](#API_CreateMicrosoftAD) operation.  
Type: [DirectoryVpcSettings](API_DirectoryVpcSettings.md) object  
Required: Yes

## Response Syntax
<a name="API_CreateMicrosoftAD_ResponseSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Response Elements
<a name="API_CreateMicrosoftAD_ResponseElements"></a>

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

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

 ** [DirectoryId](#API_CreateMicrosoftAD_ResponseSyntax) **   <a name="DirectoryService-CreateMicrosoftAD-response-DirectoryId"></a>
The identifier of the directory that was created.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$` 

## Errors
<a name="API_CreateMicrosoftAD_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryLimitExceededException **   
The maximum number of directories in the region has been reached. You can use the [GetDirectoryLimits](API_GetDirectoryLimits.md) operation to determine your directory limits in the region.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_CreateMicrosoftAD_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_CreateMicrosoftAD_Example_1"></a>

This example illustrates one usage of CreateMicrosoftAD.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 207
X-Amz-Target: DirectoryService_20150416.CreateMicrosoftAD
X-Amz-Date: 20161213T231510Z
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/20161213/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=5a73aaebf6dd7db4a17ffa5a0a5af7f8e134ad03034cb0b3e05e4f1a999d9e0a

 {
   "ShortName":"ad",
   "Password":"Str0ngP@ssw0rd",
   "Name":"ad.example.com",
   "Description":"Corporate AD directory",
   "VpcSettings":{
      "SubnetIds":[
         "subnet-ba0146de",
         "subnet-bef46bc8"
      ],
      "VpcId":"vpc-45025421"
   }
 }
```

### Example Response
<a name="API_CreateMicrosoftAD_Example_2"></a>

This example illustrates one usage of CreateMicrosoftAD.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 00019586-c18a-11e6-870b-c3330207df37
Content-Type: application/x-amz-json-1.1
Content-Length: 30
Date: Tue, 13 Dec 2016 23:15:12 GMT

{
   "DirectoryId":"d-926example"
}
```

## See Also
<a name="API_CreateMicrosoftAD_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/CreateMicrosoftAD) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/CreateMicrosoftAD) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/CreateMicrosoftAD) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/CreateMicrosoftAD) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/CreateMicrosoftAD) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/CreateMicrosoftAD) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/CreateMicrosoftAD) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/CreateMicrosoftAD) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/CreateMicrosoftAD) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/CreateMicrosoftAD) 

# CreateSnapshot
<a name="API_CreateSnapshot"></a>

Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.

**Note**  
You cannot take snapshots of AD Connector directories.

## Request Syntax
<a name="API_CreateSnapshot_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_CreateSnapshot_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_CreateSnapshot_RequestSyntax) **   <a name="DirectoryService-CreateSnapshot-request-DirectoryId"></a>
The identifier of the directory of which to take a snapshot.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [Name](#API_CreateSnapshot_RequestSyntax) **   <a name="DirectoryService-CreateSnapshot-request-Name"></a>
The descriptive name to apply to the snapshot.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$`   
Required: No

## Response Syntax
<a name="API_CreateSnapshot_ResponseSyntax"></a>

```
{
   "SnapshotId": "string"
}
```

## Response Elements
<a name="API_CreateSnapshot_ResponseElements"></a>

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

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

 ** [SnapshotId](#API_CreateSnapshot_ResponseSyntax) **   <a name="DirectoryService-CreateSnapshot-response-SnapshotId"></a>
The identifier of the snapshot that was created.  
Type: String  
Pattern: `^s-[0-9a-f]{10}$` 

## Errors
<a name="API_CreateSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** SnapshotLimitExceededException **   
The maximum number of manual snapshots for the directory has been reached. You can use the [GetSnapshotLimits](API_GetSnapshotLimits.md) operation to determine the snapshot limits for a directory.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_CreateSnapshot_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_CreateSnapshot_Example_1"></a>

This example illustrates one usage of CreateSnapshot.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 58
X-Amz-Target: DirectoryService_20150416.CreateSnapshot
X-Amz-Date: 20161213T233356Z
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/20161213/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=8789d87320d00e26fec4d745a34b3c5d898e4e89bf96b5f9c744ca612bed3d6d

 {
   "DirectoryId":"d-926example",
   "Name":"ad.example.com"
 }
```

### Example Response
<a name="API_CreateSnapshot_Example_2"></a>

This example illustrates one usage of CreateSnapshot.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 9eedb7ba-c18c-11e6-a099-03078e35561b
Content-Type: application/x-amz-json-1.1
Content-Length: 29
Date: Tue, 13 Dec 2016 23:33:58 GMT

{  
   "SnapshotId":"s-9267f8d3f0"
}
```

## See Also
<a name="API_CreateSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/CreateSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/CreateSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/CreateSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/CreateSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/CreateSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/CreateSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/CreateSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/CreateSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/CreateSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/CreateSnapshot) 

# CreateTrust
<a name="API_CreateTrust"></a>

 AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the AWS side of a trust relationship between an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.

## Request Syntax
<a name="API_CreateTrust_RequestSyntax"></a>

```
{
   "ConditionalForwarderIpAddrs": [ "string" ],
   "ConditionalForwarderIpv6Addrs": [ "string" ],
   "DirectoryId": "string",
   "RemoteDomainName": "string",
   "SelectiveAuth": "string",
   "TrustDirection": "string",
   "TrustPassword": "string",
   "TrustType": "string"
}
```

## Request Parameters
<a name="API_CreateTrust_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ConditionalForwarderIpAddrs](#API_CreateTrust_RequestSyntax) **   <a name="DirectoryService-CreateTrust-request-ConditionalForwarderIpAddrs"></a>
The IP addresses of the remote DNS server associated with RemoteDomainName.  
Type: Array of strings  
Pattern: `^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$`   
Required: No

 ** [ConditionalForwarderIpv6Addrs](#API_CreateTrust_RequestSyntax) **   <a name="DirectoryService-CreateTrust-request-ConditionalForwarderIpv6Addrs"></a>
The IPv6 addresses of the remote DNS server associated with RemoteDomainName.  
Type: Array of strings  
Pattern: `^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$`   
Required: No

 ** [DirectoryId](#API_CreateTrust_RequestSyntax) **   <a name="DirectoryService-CreateTrust-request-DirectoryId"></a>
The Directory ID of the AWS Managed Microsoft AD directory for which to establish the trust relationship.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [RemoteDomainName](#API_CreateTrust_RequestSyntax) **   <a name="DirectoryService-CreateTrust-request-RemoteDomainName"></a>
The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+[.]?$`   
Required: Yes

 ** [SelectiveAuth](#API_CreateTrust_RequestSyntax) **   <a name="DirectoryService-CreateTrust-request-SelectiveAuth"></a>
Optional parameter to enable selective authentication for the trust.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: No

 ** [TrustDirection](#API_CreateTrust_RequestSyntax) **   <a name="DirectoryService-CreateTrust-request-TrustDirection"></a>
The direction of the trust relationship.  
Type: String  
Valid Values: `One-Way: Outgoing | One-Way: Incoming | Two-Way`   
Required: Yes

 ** [TrustPassword](#API_CreateTrust_RequestSyntax) **   <a name="DirectoryService-CreateTrust-request-TrustPassword"></a>
The trust password. The trust password must be the same password that was used when creating the trust relationship on the external domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^(\p{LD}|\p{Punct}| )+$`   
Required: Yes

 ** [TrustType](#API_CreateTrust_RequestSyntax) **   <a name="DirectoryService-CreateTrust-request-TrustType"></a>
The trust relationship type. `Forest` is the default.  
Type: String  
Valid Values: `Forest | External`   
Required: No

## Response Syntax
<a name="API_CreateTrust_ResponseSyntax"></a>

```
{
   "TrustId": "string"
}
```

## Response Elements
<a name="API_CreateTrust_ResponseElements"></a>

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

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

 ** [TrustId](#API_CreateTrust_ResponseSyntax) **   <a name="DirectoryService-CreateTrust-response-TrustId"></a>
A unique identifier for the trust relationship that was created.  
Type: String  
Pattern: `^t-[0-9a-f]{10}$` 

## Errors
<a name="API_CreateTrust_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityAlreadyExistsException **   
The specified entity already exists.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_CreateTrust_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_CreateTrust_Example_1"></a>

This example illustrates one usage of CreateTrust.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 222
X-Amz-Target: DirectoryService_20150416.CreateTrust
X-Amz-Date: 20161213T235223Z
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/20161213/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=1f0cff7825d20bab2a0dab1e0b8bedbed72f0c22175c7d9ed0e63598ae99cae5

 {
   "TrustPassword":"Str0ngP@ssw0rd",
   "DirectoryId":"d-926example",
   "RemoteDomainName":"europe.example.com",
   "ConditionalForwarderIpAddrs":[
      "172.30.21.228"
   ],
   "TrustType":"Forest",
   "TrustDirection":"One-Way: Outgoing"
 }
```

### Example Response
<a name="API_CreateTrust_Example_2"></a>

This example illustrates one usage of CreateTrust.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 3343bc79-c18f-11e6-ba7f-e33ae22bc363
Content-Type: application/x-amz-json-1.1
Content-Length: 26
Date: Tue, 13 Dec 2016 23:52:26 GMT

{
   "TrustId":"t-9267353743"
}
```

## See Also
<a name="API_CreateTrust_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/CreateTrust) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/CreateTrust) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/CreateTrust) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/CreateTrust) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/CreateTrust) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/CreateTrust) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/CreateTrust) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/CreateTrust) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/CreateTrust) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/CreateTrust) 

# DeleteADAssessment
<a name="API_DeleteADAssessment"></a>

Deletes a directory assessment and all associated data. This operation permanently removes the assessment results, validation reports, and configuration information.

You cannot delete system-initiated assessments. You can delete customer-created assessments even if they are in progress.

## Request Syntax
<a name="API_DeleteADAssessment_RequestSyntax"></a>

```
{
   "AssessmentId": "string"
}
```

## Request Parameters
<a name="API_DeleteADAssessment_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AssessmentId](#API_DeleteADAssessment_RequestSyntax) **   <a name="DirectoryService-DeleteADAssessment-request-AssessmentId"></a>
The unique identifier of the directory assessment to delete.  
Type: String  
Pattern: `^da-[0-9a-f]{18}$`   
Required: Yes

## Response Syntax
<a name="API_DeleteADAssessment_ResponseSyntax"></a>

```
{
   "AssessmentId": "string"
}
```

## Response Elements
<a name="API_DeleteADAssessment_ResponseElements"></a>

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

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

 ** [AssessmentId](#API_DeleteADAssessment_ResponseSyntax) **   <a name="DirectoryService-DeleteADAssessment-response-AssessmentId"></a>
The unique identifier of the deleted directory assessment.  
Type: String  
Pattern: `^da-[0-9a-f]{18}$` 

## Errors
<a name="API_DeleteADAssessment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_DeleteADAssessment_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DeleteADAssessment_Example_1"></a>

This example illustrates one usage of DeleteADAssessment.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 45
X-Amz-Target: DirectoryService_20150416.DeleteADAssessment
X-Amz-Date: 20231212T212029Z
User-Agent: aws-cli/2.0.0 Python/3.8.0 Linux/5.4.0 botocore/2.0.0
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
 Credential=AKIAIOSFODNN7EXAMPLE/20231212/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

{
   "AssessmentId": "da-1234567890example1"
}
```

### Example Response
<a name="API_DeleteADAssessment_Example_2"></a>

This example illustrates one usage of DeleteADAssessment.

```
HTTP/1.1 200 OK
x-amzn-RequestId: cfc1cbc8-c0b0-11e6-aa44-41d91ee57463
Content-Type: application/x-amz-json-1.1
Content-Length: 45
Date: Mon, 12 Dec 2023 21:20:31 GMT

{
   "AssessmentId": "da-1234567890example1"
}
```

## See Also
<a name="API_DeleteADAssessment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DeleteADAssessment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DeleteADAssessment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DeleteADAssessment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DeleteADAssessment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DeleteADAssessment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DeleteADAssessment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DeleteADAssessment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DeleteADAssessment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DeleteADAssessment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DeleteADAssessment) 

# DeleteConditionalForwarder
<a name="API_DeleteConditionalForwarder"></a>

Deletes a conditional forwarder that has been set up for your AWS directory.

## Request Syntax
<a name="API_DeleteConditionalForwarder_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "RemoteDomainName": "string"
}
```

## Request Parameters
<a name="API_DeleteConditionalForwarder_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DeleteConditionalForwarder_RequestSyntax) **   <a name="DirectoryService-DeleteConditionalForwarder-request-DirectoryId"></a>
The directory ID for which you are deleting the conditional forwarder.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [RemoteDomainName](#API_DeleteConditionalForwarder_RequestSyntax) **   <a name="DirectoryService-DeleteConditionalForwarder-request-RemoteDomainName"></a>
The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+[.]?$`   
Required: Yes

## Response Elements
<a name="API_DeleteConditionalForwarder_ResponseElements"></a>

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

## Errors
<a name="API_DeleteConditionalForwarder_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_DeleteConditionalForwarder_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DeleteConditionalForwarder_Example_1"></a>

This example illustrates one usage of DeleteConditionalForwarder.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 76
X-Amz-Target: DirectoryService_20150416.DeleteConditionalForwarder
X-Amz-Date: 20161214T001055Z
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/20161214/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=ffc3c3d6feac461a9b093cab94dd8957b252f2936b51f14a1ad8499a8b401d4a

 {
   "DirectoryId":"d-926example",
   "RemoteDomainName":"sales.example.com"
 }
```

### Example Response
<a name="API_DeleteConditionalForwarder_Example_2"></a>

This example illustrates one usage of DeleteConditionalForwarder.

```
HTTP/1.1 200 OK
x-amzn-RequestId: ca119fd0-c191-11e6-8f8e-ed61d076c15a
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Wed, 14 Dec 2016 00:11:00 GMT

 {

 }
```

## See Also
<a name="API_DeleteConditionalForwarder_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DeleteConditionalForwarder) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DeleteConditionalForwarder) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DeleteConditionalForwarder) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DeleteConditionalForwarder) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DeleteConditionalForwarder) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DeleteConditionalForwarder) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DeleteConditionalForwarder) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DeleteConditionalForwarder) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DeleteConditionalForwarder) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DeleteConditionalForwarder) 

# DeleteDirectory
<a name="API_DeleteDirectory"></a>

Deletes an AWS Directory Service directory.

Before you call `DeleteDirectory`, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the `DeleteDirectory` operation, see [AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference](http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

## Request Syntax
<a name="API_DeleteDirectory_RequestSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_DeleteDirectory_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DeleteDirectory_RequestSyntax) **   <a name="DirectoryService-DeleteDirectory-request-DirectoryId"></a>
The identifier of the directory to delete.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Syntax
<a name="API_DeleteDirectory_ResponseSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Response Elements
<a name="API_DeleteDirectory_ResponseElements"></a>

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

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

 ** [DirectoryId](#API_DeleteDirectory_ResponseSyntax) **   <a name="DirectoryService-DeleteDirectory-response-DirectoryId"></a>
The directory identifier.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$` 

## Errors
<a name="API_DeleteDirectory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_DeleteDirectory_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DeleteDirectory_Example_1"></a>

This example illustrates one usage of DeleteDirectory.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 31
X-Amz-Target: DirectoryService_20150416.DeleteDirectory
X-Amz-Date: 20161214T002424Z
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/20161214/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=b542aa77381528e27afcf08b229252606fa79723695fb2d19b81b51d66d7f92d

 {
   "DirectoryId": "d-926example"
 }
```

### Example Response
<a name="API_DeleteDirectory_Example_2"></a>

This example illustrates one usage of DeleteDirectory.

```
HTTP/1.1 200 OK
x-amzn-RequestId: abcbeb82-c193-11e6-bf9e-272b6602bf9f
Content-Type: application/x-amz-json-1.1
Content-Length: 30
Date: Wed, 14 Dec 2016 00:24:26 GMT

{
   "DirectoryId":"d-926example"
}
```

## See Also
<a name="API_DeleteDirectory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DeleteDirectory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DeleteDirectory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DeleteDirectory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DeleteDirectory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DeleteDirectory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DeleteDirectory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DeleteDirectory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DeleteDirectory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DeleteDirectory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DeleteDirectory) 

# DeleteLogSubscription
<a name="API_DeleteLogSubscription"></a>

Deletes the specified log subscription.

## Request Syntax
<a name="API_DeleteLogSubscription_RequestSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_DeleteLogSubscription_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DeleteLogSubscription_RequestSyntax) **   <a name="DirectoryService-DeleteLogSubscription-request-DirectoryId"></a>
Identifier of the directory whose log subscription you want to delete.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Elements
<a name="API_DeleteLogSubscription_ResponseElements"></a>

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

## Errors
<a name="API_DeleteLogSubscription_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_DeleteLogSubscription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DeleteLogSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DeleteLogSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DeleteLogSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DeleteLogSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DeleteLogSubscription) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DeleteLogSubscription) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DeleteLogSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DeleteLogSubscription) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DeleteLogSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DeleteLogSubscription) 

# DeleteSnapshot
<a name="API_DeleteSnapshot"></a>

Deletes a directory snapshot.

## Request Syntax
<a name="API_DeleteSnapshot_RequestSyntax"></a>

```
{
   "SnapshotId": "string"
}
```

## Request Parameters
<a name="API_DeleteSnapshot_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [SnapshotId](#API_DeleteSnapshot_RequestSyntax) **   <a name="DirectoryService-DeleteSnapshot-request-SnapshotId"></a>
The identifier of the directory snapshot to be deleted.  
Type: String  
Pattern: `^s-[0-9a-f]{10}$`   
Required: Yes

## Response Syntax
<a name="API_DeleteSnapshot_ResponseSyntax"></a>

```
{
   "SnapshotId": "string"
}
```

## Response Elements
<a name="API_DeleteSnapshot_ResponseElements"></a>

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

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

 ** [SnapshotId](#API_DeleteSnapshot_ResponseSyntax) **   <a name="DirectoryService-DeleteSnapshot-response-SnapshotId"></a>
The identifier of the directory snapshot that was deleted.  
Type: String  
Pattern: `^s-[0-9a-f]{10}$` 

## Errors
<a name="API_DeleteSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_DeleteSnapshot_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DeleteSnapshot_Example_1"></a>

This example illustrates one usage of DeleteSnapshot.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 30
X-Amz-Target: DirectoryService_20150416.DeleteSnapshot
X-Amz-Date: 20161214T012131Z
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/20161214/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=685c5716e7e11b8d5b2ed5f413d6ff47fe179a1f215b83aa89d00d3b28827c1c

 {
   "SnapshotId": "s-9267f8d3f0"
 }
```

### Example Response
<a name="API_DeleteSnapshot_Example_2"></a>

This example illustrates one usage of DeleteSnapshot.

```
HTTP/1.1 200 OK
x-amzn-RequestId: a68a1e79-c19b-11e6-870b-c3330207df37
Content-Type: application/x-amz-json-1.1
Content-Length: 29
Date: Wed, 14 Dec 2016 01:21:34 GMT

{  
   "SnapshotId":"s-9267f8d3f0"
}
```

## See Also
<a name="API_DeleteSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DeleteSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DeleteSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DeleteSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DeleteSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DeleteSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DeleteSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DeleteSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DeleteSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DeleteSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DeleteSnapshot) 

# DeleteTrust
<a name="API_DeleteTrust"></a>

Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.

## Request Syntax
<a name="API_DeleteTrust_RequestSyntax"></a>

```
{
   "DeleteAssociatedConditionalForwarder": boolean,
   "TrustId": "string"
}
```

## Request Parameters
<a name="API_DeleteTrust_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DeleteAssociatedConditionalForwarder](#API_DeleteTrust_RequestSyntax) **   <a name="DirectoryService-DeleteTrust-request-DeleteAssociatedConditionalForwarder"></a>
Delete a conditional forwarder as part of a DeleteTrustRequest.  
Type: Boolean  
Required: No

 ** [TrustId](#API_DeleteTrust_RequestSyntax) **   <a name="DirectoryService-DeleteTrust-request-TrustId"></a>
The Trust ID of the trust relationship to be deleted.  
Type: String  
Pattern: `^t-[0-9a-f]{10}$`   
Required: Yes

## Response Syntax
<a name="API_DeleteTrust_ResponseSyntax"></a>

```
{
   "TrustId": "string"
}
```

## Response Elements
<a name="API_DeleteTrust_ResponseElements"></a>

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

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

 ** [TrustId](#API_DeleteTrust_ResponseSyntax) **   <a name="DirectoryService-DeleteTrust-response-TrustId"></a>
The Trust ID of the trust relationship that was deleted.  
Type: String  
Pattern: `^t-[0-9a-f]{10}$` 

## Errors
<a name="API_DeleteTrust_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_DeleteTrust_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DeleteTrust_Example_1"></a>

This example illustrates one usage of DeleteTrust.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 73
X-Amz-Target: DirectoryService_20150416.DeleteTrust
X-Amz-Date: 20161214T013332Z
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/20161214/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=ced49ef4329d015ebde09b7bc586eee4455b0b1e6608ade2fd6cd123440bbd6d

 {
   "TrustId": "t-9267353743",
   "DeleteAssociatedConditionalForwarder": true
 }
```

### Example Response
<a name="API_DeleteTrust_Example_2"></a>

This example illustrates one usage of DeleteTrust.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 54425c2e-c19d-11e6-b0d6-83af322c90cd
Content-Type: application/x-amz-json-1.1
Content-Length: 26
Date: Wed, 14 Dec 2016 01:33:37 GMT

{
   "TrustId":"t-9267353743"
}
```

## See Also
<a name="API_DeleteTrust_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DeleteTrust) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DeleteTrust) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DeleteTrust) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DeleteTrust) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DeleteTrust) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DeleteTrust) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DeleteTrust) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DeleteTrust) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DeleteTrust) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DeleteTrust) 

# DeregisterCertificate
<a name="API_DeregisterCertificate"></a>

Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.

## Request Syntax
<a name="API_DeregisterCertificate_RequestSyntax"></a>

```
{
   "CertificateId": "string",
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_DeregisterCertificate_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [CertificateId](#API_DeregisterCertificate_RequestSyntax) **   <a name="DirectoryService-DeregisterCertificate-request-CertificateId"></a>
The identifier of the certificate.  
Type: String  
Pattern: `^c-[0-9a-f]{10}$`   
Required: Yes

 ** [DirectoryId](#API_DeregisterCertificate_RequestSyntax) **   <a name="DirectoryService-DeregisterCertificate-request-DirectoryId"></a>
The identifier of the directory.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Elements
<a name="API_DeregisterCertificate_ResponseElements"></a>

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

## Errors
<a name="API_DeregisterCertificate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CertificateDoesNotExistException **   
The certificate is not present in the system for describe or deregister activities.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** CertificateInUseException **   
The certificate is being used for the LDAP security connection and cannot be removed without disabling LDAP security.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_DeregisterCertificate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DeregisterCertificate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DeregisterCertificate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DeregisterCertificate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DeregisterCertificate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DeregisterCertificate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DeregisterCertificate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DeregisterCertificate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DeregisterCertificate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DeregisterCertificate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DeregisterCertificate) 

# DeregisterEventTopic
<a name="API_DeregisterEventTopic"></a>

Removes the specified directory as a publisher to the specified Amazon SNS topic.

## Request Syntax
<a name="API_DeregisterEventTopic_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "TopicName": "string"
}
```

## Request Parameters
<a name="API_DeregisterEventTopic_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DeregisterEventTopic_RequestSyntax) **   <a name="DirectoryService-DeregisterEventTopic-request-DirectoryId"></a>
The Directory ID to remove as a publisher. This directory will no longer send messages to the specified Amazon SNS topic.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [TopicName](#API_DeregisterEventTopic_RequestSyntax) **   <a name="DirectoryService-DeregisterEventTopic-request-TopicName"></a>
The name of the Amazon SNS topic from which to remove the directory as a publisher.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

## Response Elements
<a name="API_DeregisterEventTopic_ResponseElements"></a>

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

## Errors
<a name="API_DeregisterEventTopic_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_DeregisterEventTopic_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DeregisterEventTopic_Example_1"></a>

This example illustrates one usage of DeregisterEventTopic.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 52
X-Amz-Target: DirectoryService_20150416.DeregisterEventTopic
X-Amz-Date: 20161214T014408Z
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/20161214/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=e3b8ad858165a3dd7d4fb35b0adf17bee8d71aed26b0f49e6db792ed8b10f8b1

 {
   "DirectoryId": "d-926example",
   "TopicName": "snstopicexample"
 }
```

### Example Response
<a name="API_DeregisterEventTopic_Example_2"></a>

This example illustrates one usage of DeregisterEventTopic.

```
HTTP/1.1 200 OK
x-amzn-RequestId: a68a1e79-c19b-11e6-870b-c3330207df37
Content-Type: application/x-amz-json-1.1
Content-Length: 29
Date: Wed, 14 Dec 2016 01:44:10 GMT

{  
  
}
```

## See Also
<a name="API_DeregisterEventTopic_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DeregisterEventTopic) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DeregisterEventTopic) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DeregisterEventTopic) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DeregisterEventTopic) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DeregisterEventTopic) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DeregisterEventTopic) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DeregisterEventTopic) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DeregisterEventTopic) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DeregisterEventTopic) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DeregisterEventTopic) 

# DescribeADAssessment
<a name="API_DescribeADAssessment"></a>

Retrieves detailed information about a directory assessment, including its current status, validation results, and configuration details. Use this operation to monitor assessment progress and review results.

## Request Syntax
<a name="API_DescribeADAssessment_RequestSyntax"></a>

```
{
   "AssessmentId": "string"
}
```

## Request Parameters
<a name="API_DescribeADAssessment_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AssessmentId](#API_DescribeADAssessment_RequestSyntax) **   <a name="DirectoryService-DescribeADAssessment-request-AssessmentId"></a>
The identifier of the directory assessment to describe.  
Type: String  
Pattern: `^da-[0-9a-f]{18}$`   
Required: Yes

## Response Syntax
<a name="API_DescribeADAssessment_ResponseSyntax"></a>

```
{
   "Assessment": { 
      "AssessmentId": "string",
      "CustomerDnsIps": [ "string" ],
      "DirectoryId": "string",
      "DnsName": "string",
      "LastUpdateDateTime": number,
      "ReportType": "string",
      "SecurityGroupIds": [ "string" ],
      "SelfManagedInstanceIds": [ "string" ],
      "StartTime": number,
      "Status": "string",
      "StatusCode": "string",
      "StatusReason": "string",
      "SubnetIds": [ "string" ],
      "Version": "string",
      "VpcId": "string"
   },
   "AssessmentReports": [ 
      { 
         "DomainControllerIp": "string",
         "Validations": [ 
            { 
               "Category": "string",
               "LastUpdateDateTime": number,
               "Name": "string",
               "StartTime": number,
               "Status": "string",
               "StatusCode": "string",
               "StatusReason": "string"
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_DescribeADAssessment_ResponseElements"></a>

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

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

 ** [Assessment](#API_DescribeADAssessment_ResponseSyntax) **   <a name="DirectoryService-DescribeADAssessment-response-Assessment"></a>
Detailed information about the self-managed instance settings (IDs and DNS IPs).  
Type: [Assessment](API_Assessment.md) object

 ** [AssessmentReports](#API_DescribeADAssessment_ResponseSyntax) **   <a name="DirectoryService-DescribeADAssessment-response-AssessmentReports"></a>
A list of assessment reports containing validation results for each domain controller and test category. Each report includes specific validation details and outcomes.  
Type: Array of [AssessmentReport](API_AssessmentReport.md) objects

## Errors
<a name="API_DescribeADAssessment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_DescribeADAssessment_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DescribeADAssessment_Example_1"></a>

This example illustrates one usage of DescribeADAssessment.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 45
X-Amz-Target: DirectoryService_20150416.DescribeADAssessment
X-Amz-Date: 20231212T212029Z
User-Agent: aws-cli/2.0.0 Python/3.8.0 Linux/5.4.0 botocore/2.0.0
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
 Credential=AKIAIOSFODNN7EXAMPLE/20231212/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

{
    "AssessmentId": "da-1234567890example1"
}
```

### Example Response
<a name="API_DescribeADAssessment_Example_2"></a>

This example illustrates one usage of DescribeADAssessment.

```
HTTP/1.1 200 OK
x-amzn-RequestId: cfc1cbc8-c0b0-11e6-aa44-41d91ee57463
Content-Type: application/x-amz-json-1.1
Content-Length: 892
Date: Mon, 12 Dec 2023 21:20:31 GMT

{
    "Assessment": {
        "AssessmentId": "da-1234567890example1",
        "DnsName": "ad.example.com",
        "StartTime": "2025-06-10T14:28:54.934000-04:00",
        "LastUpdateDateTime": "2025-06-10T14:55:52.197000-04:00",
        "Status": "SUCCESS",
        "CustomerDnsIps": [
            "10.24.34.100",
            "10.24.34.200"
        ]
        "VpcId": "vpc-0e1051example5f2a",
        "SubnetIds": [
            "subnet-0fee0examplee9604",
            "subnet-076dbexample5ed88"
        ],
        "SelfManagedInstanceIds": [
            "i-10243410",
            "i-10243420"
        ],
        "ReportType": "CUSTOMER",
        "Version": "v1"
    },
    "AssessmentReports": [
        {
            "DomainControllerIp": "10.24.34.100",
            "Validations": [
                {
                    "Category": "preValidationTests",
                    "Name": "testDnsIpMatch",
                    "Status": "SUCCESS",
                    "StartTime": "2025-06-10T14:30:00.374000-04:00",
                    "LastUpdateDateTime": "2025-06-10T14:30:35.400000-04:00"
                },
                    . . .
            ]
        },
        {
            "DomainControllerIp": "10.24.34.200",
            "Validations": [
                {
                    "Category": "preValidationTests",
                    "Name": "testDnsIpMatch",
                    "Status": "SUCCESS",
                    "StartTime": "2025-06-10T14:30:00.374000-04:00",
                    "LastUpdateDateTime": "2025-06-10T14:30:35.446000-04:00"
                },
                    . . .
            ]
        }
    ]
}
```

## See Also
<a name="API_DescribeADAssessment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeADAssessment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeADAssessment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeADAssessment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeADAssessment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeADAssessment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeADAssessment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeADAssessment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeADAssessment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeADAssessment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeADAssessment) 

# DescribeCAEnrollmentPolicy
<a name="API_DescribeCAEnrollmentPolicy"></a>

Retrieves detailed information about the certificate authority (CA) enrollment policy for the specified directory. This policy determines how client certificates are automatically enrolled and managed through AWS Private Certificate Authority. 

## Request Syntax
<a name="API_DescribeCAEnrollmentPolicy_RequestSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_DescribeCAEnrollmentPolicy_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DescribeCAEnrollmentPolicy_RequestSyntax) **   <a name="DirectoryService-DescribeCAEnrollmentPolicy-request-DirectoryId"></a>
The identifier of the directory for which to retrieve the CA enrollment policy information.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Syntax
<a name="API_DescribeCAEnrollmentPolicy_ResponseSyntax"></a>

```
{
   "CaEnrollmentPolicyStatus": "string",
   "CaEnrollmentPolicyStatusReason": "string",
   "DirectoryId": "string",
   "LastUpdatedDateTime": number,
   "PcaConnectorArn": "string"
}
```

## Response Elements
<a name="API_DescribeCAEnrollmentPolicy_ResponseElements"></a>

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

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

 ** [CaEnrollmentPolicyStatus](#API_DescribeCAEnrollmentPolicy_ResponseSyntax) **   <a name="DirectoryService-DescribeCAEnrollmentPolicy-response-CaEnrollmentPolicyStatus"></a>
The current status of the CA enrollment policy. This indicates if automatic certificate enrollment is currently active, inactive, or in a transitional state.  
Valid values:  
+  `IN_PROGRESS` - The policy is being activated T
+  `SUCCESS` - The policy is active and automatic certificate enrollment is operational
+  `FAILED` - The policy activation or deactivation failed
+  `DISABLING` - The policy is being deactivated
+  `DISABLED` - The policy is inactive and automatic certificate enrollment is not available
+  `IMPAIRED` - Network connectivity is impaired.
Type: String  
Valid Values: `InProgress | Success | Failed | Disabling | Disabled | Impaired` 

 ** [CaEnrollmentPolicyStatusReason](#API_DescribeCAEnrollmentPolicy_ResponseSyntax) **   <a name="DirectoryService-DescribeCAEnrollmentPolicy-response-CaEnrollmentPolicyStatusReason"></a>
Additional information explaining the current status of the CA enrollment policy, particularly useful when the policy is in an error or transitional state.  
Type: String

 ** [DirectoryId](#API_DescribeCAEnrollmentPolicy_ResponseSyntax) **   <a name="DirectoryService-DescribeCAEnrollmentPolicy-response-DirectoryId"></a>
The identifier of the directory associated with this CA enrollment policy.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$` 

 ** [LastUpdatedDateTime](#API_DescribeCAEnrollmentPolicy_ResponseSyntax) **   <a name="DirectoryService-DescribeCAEnrollmentPolicy-response-LastUpdatedDateTime"></a>
The date and time when the CA enrollment policy was last modified or updated.  
Type: Timestamp

 ** [PcaConnectorArn](#API_DescribeCAEnrollmentPolicy_ResponseSyntax) **   <a name="DirectoryService-DescribeCAEnrollmentPolicy-response-PcaConnectorArn"></a>
The Amazon Resource Name (ARN) of the AWS Private Certificate Authority (PCA) connector that is configured for automatic certificate enrollment in this directory.  
Type: String  
Pattern: `^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:connector\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$` 

## Errors
<a name="API_DescribeCAEnrollmentPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_DescribeCAEnrollmentPolicy_Examples"></a>

The following examples are formatted for legibility.

### Describe CA enrollment policy
<a name="API_DescribeCAEnrollmentPolicy_Example_1"></a>

The following example describes the CA enrollment policy for a directory.

#### Sample Request
<a name="API_DescribeCAEnrollmentPolicy_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 45
X-Amz-Target: DirectoryService_20150416.DescribeCAEnrollmentPolicy
X-Amz-Date: 20230815T143000Z
User-Agent: aws-cli/2.0.0 Python/3.8.0 Linux/5.4.0 botocore/2.0.0
Authorization: AWS4-HMAC-SHA256
  Credential=AKIAIOSFODNN7EXAMPLE/20230815/us-west-2/ds/aws4_request,
  SignedHeaders=host;x-amz-date;x-amz-target,
  Signature=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

{
  "DirectoryId": "d-926example"
}
```

#### Sample Response
<a name="API_DescribeCAEnrollmentPolicy_Example_1_Response"></a>

```
HTTP/1.1 200 OK
Date: Tue, 15 Aug 2023 14:30:00 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 245
x-amzn-RequestId: 12345678-1234-1234-1234-123456789012

{
  "DirectoryId": "d-926example",
  "PcaConnectorArn": "arn:aws:pca-connector-ad:us-east-1:123456789012:connector/c-123456789abcdef01",
  "CaEnrollmentPolicyStatus": "SUCCESS",
  "LastUpdatedDateTime": "2023-08-15T14:30:00.000Z",
  "CaEnrollmentPolicyStatusReason": "Policy successfully activated and operational"
}
```

### Response when CA enrollment is disabled
<a name="API_DescribeCAEnrollmentPolicy_Example_2"></a>

If CA enrollment is disabled, this returns an empty response. 

#### Sample Request
<a name="API_DescribeCAEnrollmentPolicy_Example_2_Request"></a>

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 45
X-Amz-Target: DirectoryService_20150416.DescribeCAEnrollmentPolicy
X-Amz-Date: 20230815T143000Z
User-Agent: aws-cli/2.0.0 Python/3.8.0 Linux/5.4.0 botocore/2.0.0
Authorization: AWS4-HMAC-SHA256
  Credential=AKIAIOSFODNN7EXAMPLE/20230815/us-west-2/ds/aws4_request,
  SignedHeaders=host;x-amz-date;x-amz-target,
  Signature=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

{
  "DirectoryId": "d-926example"
}
```

#### Sample Response
<a name="API_DescribeCAEnrollmentPolicy_Example_2_Response"></a>

```
HTTP/1.1 200 OK
Date: Thu, 10 Aug 2023 09:15:00 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 156
x-amzn-RequestId: 87654321-4321-4321-4321-210987654321

{}
```

## See Also
<a name="API_DescribeCAEnrollmentPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeCAEnrollmentPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeCAEnrollmentPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeCAEnrollmentPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeCAEnrollmentPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeCAEnrollmentPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeCAEnrollmentPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeCAEnrollmentPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeCAEnrollmentPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeCAEnrollmentPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeCAEnrollmentPolicy) 

# DescribeCertificate
<a name="API_DescribeCertificate"></a>

Displays information about the certificate registered for secure LDAP or client certificate authentication.

## Request Syntax
<a name="API_DescribeCertificate_RequestSyntax"></a>

```
{
   "CertificateId": "string",
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_DescribeCertificate_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [CertificateId](#API_DescribeCertificate_RequestSyntax) **   <a name="DirectoryService-DescribeCertificate-request-CertificateId"></a>
The identifier of the certificate.  
Type: String  
Pattern: `^c-[0-9a-f]{10}$`   
Required: Yes

 ** [DirectoryId](#API_DescribeCertificate_RequestSyntax) **   <a name="DirectoryService-DescribeCertificate-request-DirectoryId"></a>
The identifier of the directory.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Syntax
<a name="API_DescribeCertificate_ResponseSyntax"></a>

```
{
   "Certificate": { 
      "CertificateId": "string",
      "ClientCertAuthSettings": { 
         "OCSPUrl": "string"
      },
      "CommonName": "string",
      "ExpiryDateTime": number,
      "RegisteredDateTime": number,
      "State": "string",
      "StateReason": "string",
      "Type": "string"
   }
}
```

## Response Elements
<a name="API_DescribeCertificate_ResponseElements"></a>

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

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

 ** [Certificate](#API_DescribeCertificate_ResponseSyntax) **   <a name="DirectoryService-DescribeCertificate-response-Certificate"></a>
Information about the certificate, including registered date time, certificate state, the reason for the state, expiration date time, and certificate common name.  
Type: [Certificate](API_Certificate.md) object

## Errors
<a name="API_DescribeCertificate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CertificateDoesNotExistException **   
The certificate is not present in the system for describe or deregister activities.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_DescribeCertificate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeCertificate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeCertificate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeCertificate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeCertificate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeCertificate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeCertificate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeCertificate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeCertificate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeCertificate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeCertificate) 

# DescribeClientAuthenticationSettings
<a name="API_DescribeClientAuthenticationSettings"></a>

Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only `SmartCard` is supported. 

## Request Syntax
<a name="API_DescribeClientAuthenticationSettings_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Limit": number,
   "NextToken": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_DescribeClientAuthenticationSettings_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DescribeClientAuthenticationSettings_RequestSyntax) **   <a name="DirectoryService-DescribeClientAuthenticationSettings-request-DirectoryId"></a>
The identifier of the directory for which to retrieve information.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [Limit](#API_DescribeClientAuthenticationSettings_RequestSyntax) **   <a name="DirectoryService-DescribeClientAuthenticationSettings-request-Limit"></a>
The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_DescribeClientAuthenticationSettings_RequestSyntax) **   <a name="DirectoryService-DescribeClientAuthenticationSettings-request-NextToken"></a>
The *DescribeClientAuthenticationSettingsResult.NextToken* value from a previous call to [DescribeClientAuthenticationSettings](#API_DescribeClientAuthenticationSettings). Pass null if this is the first call.  
Type: String  
Required: No

 ** [Type](#API_DescribeClientAuthenticationSettings_RequestSyntax) **   <a name="DirectoryService-DescribeClientAuthenticationSettings-request-Type"></a>
The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.  
Type: String  
Valid Values: `SmartCard | SmartCardOrPassword`   
Required: No

## Response Syntax
<a name="API_DescribeClientAuthenticationSettings_ResponseSyntax"></a>

```
{
   "ClientAuthenticationSettingsInfo": [ 
      { 
         "LastUpdatedDateTime": number,
         "Status": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeClientAuthenticationSettings_ResponseElements"></a>

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

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

 ** [ClientAuthenticationSettingsInfo](#API_DescribeClientAuthenticationSettings_ResponseSyntax) **   <a name="DirectoryService-DescribeClientAuthenticationSettings-response-ClientAuthenticationSettingsInfo"></a>
Information about the type of client authentication for the specified directory. The following information is retrieved: The date and time when the status of the client authentication type was last updated, whether the client authentication type is enabled or disabled, and the type of client authentication.  
Type: Array of [ClientAuthenticationSettingInfo](API_ClientAuthenticationSettingInfo.md) objects

 ** [NextToken](#API_DescribeClientAuthenticationSettings_ResponseSyntax) **   <a name="DirectoryService-DescribeClientAuthenticationSettings-response-NextToken"></a>
The next token used to retrieve the client authentication settings if the number of setting types exceeds page limit and there is another page.  
Type: String

## Errors
<a name="API_DescribeClientAuthenticationSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_DescribeClientAuthenticationSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeClientAuthenticationSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeClientAuthenticationSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeClientAuthenticationSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeClientAuthenticationSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeClientAuthenticationSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeClientAuthenticationSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeClientAuthenticationSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeClientAuthenticationSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeClientAuthenticationSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeClientAuthenticationSettings) 

# DescribeConditionalForwarders
<a name="API_DescribeConditionalForwarders"></a>

Obtains information about the conditional forwarders for this account.

If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.

## Request Syntax
<a name="API_DescribeConditionalForwarders_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "RemoteDomainNames": [ "string" ]
}
```

## Request Parameters
<a name="API_DescribeConditionalForwarders_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DescribeConditionalForwarders_RequestSyntax) **   <a name="DirectoryService-DescribeConditionalForwarders-request-DirectoryId"></a>
The directory ID for which to get the list of associated conditional forwarders.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [RemoteDomainNames](#API_DescribeConditionalForwarders_RequestSyntax) **   <a name="DirectoryService-DescribeConditionalForwarders-request-RemoteDomainNames"></a>
The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned.  
Type: Array of strings  
Length Constraints: Maximum length of 1024.  
Pattern: `^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+[.]?$`   
Required: No

## Response Syntax
<a name="API_DescribeConditionalForwarders_ResponseSyntax"></a>

```
{
   "ConditionalForwarders": [ 
      { 
         "DnsIpAddrs": [ "string" ],
         "DnsIpv6Addrs": [ "string" ],
         "RemoteDomainName": "string",
         "ReplicationScope": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeConditionalForwarders_ResponseElements"></a>

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

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

 ** [ConditionalForwarders](#API_DescribeConditionalForwarders_ResponseSyntax) **   <a name="DirectoryService-DescribeConditionalForwarders-response-ConditionalForwarders"></a>
The list of conditional forwarders that have been created.  
Type: Array of [ConditionalForwarder](API_ConditionalForwarder.md) objects

## Errors
<a name="API_DescribeConditionalForwarders_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_DescribeConditionalForwarders_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DescribeConditionalForwarders_Example_1"></a>

This example illustrates one usage of DescribeConditionalForwarders.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 79
X-Amz-Target: DirectoryService_20150416.DescribeConditionalForwarders
X-Amz-Date: 20161214T020215Z
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/20161214/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=d8f7ff4237b393b4734bbf5d96713dff3deff651b4ab348f64bd776606147f9d

 {
   "DirectoryId": "d-926example",
   "RemoteDomainNames": ["sales.example.com"]
 }
```

### Example Response
<a name="API_DescribeConditionalForwarders_Example_2"></a>

This example illustrates one usage of DescribeConditionalForwarders.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 56d08425-c1a1-11e6-a132-e5016ac609f4
Content-Type: application/x-amz-json-1.1
Content-Length: 28
Date: Wed, 14 Dec 2016 02:02:18 GMT

{
    "ConditionalForwarders": [
        {
            "RemoteDomainName": "sales.example.com",
            "DnsIpAddrs": [
                "172.30.21.228"
            ],
            "ReplicationScope": "Domain"
        }
    ]
}
```

## See Also
<a name="API_DescribeConditionalForwarders_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeConditionalForwarders) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeConditionalForwarders) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeConditionalForwarders) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeConditionalForwarders) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeConditionalForwarders) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeConditionalForwarders) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeConditionalForwarders) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeConditionalForwarders) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeConditionalForwarders) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeConditionalForwarders) 

# DescribeDirectories
<a name="API_DescribeDirectories"></a>

Obtains information about the directories that belong to this account.

You can retrieve information about specific directories by passing the directory identifiers in the `DirectoryIds` parameter. Otherwise, all directories that belong to the current account are returned.

This operation supports pagination with the use of the `NextToken` request and response parameters. If more results are available, the `DescribeDirectoriesResult.NextToken` member contains a token that you pass in the next call to [DescribeDirectories](#API_DescribeDirectories) to retrieve the next set of items.

You can also specify a maximum number of return results with the `Limit` parameter.

## Request Syntax
<a name="API_DescribeDirectories_RequestSyntax"></a>

```
{
   "DirectoryIds": [ "string" ],
   "Limit": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeDirectories_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryIds](#API_DescribeDirectories_RequestSyntax) **   <a name="DirectoryService-DescribeDirectories-request-DirectoryIds"></a>
A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.  
An empty list results in an `InvalidParameterException` being thrown.  
Type: Array of strings  
Pattern: `^d-[0-9a-f]{10}$`   
Required: No

 ** [Limit](#API_DescribeDirectories_RequestSyntax) **   <a name="DirectoryService-DescribeDirectories-request-Limit"></a>
The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [NextToken](#API_DescribeDirectories_RequestSyntax) **   <a name="DirectoryService-DescribeDirectories-request-NextToken"></a>
The `DescribeDirectoriesResult.NextToken` value from a previous call to [DescribeDirectories](#API_DescribeDirectories). Pass null if this is the first call.  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeDirectories_ResponseSyntax"></a>

```
{
   "DirectoryDescriptions": [ 
      { 
         "AccessUrl": "string",
         "Alias": "string",
         "ConnectSettings": { 
            "AvailabilityZones": [ "string" ],
            "ConnectIps": [ "string" ],
            "ConnectIpsV6": [ "string" ],
            "CustomerUserName": "string",
            "SecurityGroupId": "string",
            "SubnetIds": [ "string" ],
            "VpcId": "string"
         },
         "Description": "string",
         "DesiredNumberOfDomainControllers": number,
         "DirectoryId": "string",
         "DnsIpAddrs": [ "string" ],
         "DnsIpv6Addrs": [ "string" ],
         "Edition": "string",
         "HybridSettings": { 
            "SelfManagedDnsIpAddrs": [ "string" ],
            "SelfManagedInstanceIds": [ "string" ]
         },
         "LaunchTime": number,
         "Name": "string",
         "NetworkType": "string",
         "OsVersion": "string",
         "OwnerDirectoryDescription": { 
            "AccountId": "string",
            "DirectoryId": "string",
            "DnsIpAddrs": [ "string" ],
            "DnsIpv6Addrs": [ "string" ],
            "NetworkType": "string",
            "RadiusSettings": { 
               "AuthenticationProtocol": "string",
               "DisplayLabel": "string",
               "RadiusPort": number,
               "RadiusRetries": number,
               "RadiusServers": [ "string" ],
               "RadiusServersIpv6": [ "string" ],
               "RadiusTimeout": number,
               "SharedSecret": "string",
               "UseSameUsername": boolean
            },
            "RadiusStatus": "string",
            "VpcSettings": { 
               "AvailabilityZones": [ "string" ],
               "SecurityGroupId": "string",
               "SubnetIds": [ "string" ],
               "VpcId": "string"
            }
         },
         "RadiusSettings": { 
            "AuthenticationProtocol": "string",
            "DisplayLabel": "string",
            "RadiusPort": number,
            "RadiusRetries": number,
            "RadiusServers": [ "string" ],
            "RadiusServersIpv6": [ "string" ],
            "RadiusTimeout": number,
            "SharedSecret": "string",
            "UseSameUsername": boolean
         },
         "RadiusStatus": "string",
         "RegionsInfo": { 
            "AdditionalRegions": [ "string" ],
            "PrimaryRegion": "string"
         },
         "ShareMethod": "string",
         "ShareNotes": "string",
         "ShareStatus": "string",
         "ShortName": "string",
         "Size": "string",
         "SsoEnabled": boolean,
         "Stage": "string",
         "StageLastUpdatedDateTime": number,
         "StageReason": "string",
         "Type": "string",
         "VpcSettings": { 
            "AvailabilityZones": [ "string" ],
            "SecurityGroupId": "string",
            "SubnetIds": [ "string" ],
            "VpcId": "string"
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeDirectories_ResponseElements"></a>

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

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

 ** [DirectoryDescriptions](#API_DescribeDirectories_ResponseSyntax) **   <a name="DirectoryService-DescribeDirectories-response-DirectoryDescriptions"></a>
The list of available [DirectoryDescription](API_DirectoryDescription.md) objects that were retrieved.  
It is possible that this list contains less than the number of items specified in the `Limit` member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.  
Type: Array of [DirectoryDescription](API_DirectoryDescription.md) objects

 ** [NextToken](#API_DescribeDirectories_ResponseSyntax) **   <a name="DirectoryService-DescribeDirectories-response-NextToken"></a>
If not null, more results are available. Pass this value for the `NextToken` parameter in a subsequent call to [DescribeDirectories](#API_DescribeDirectories) to retrieve the next set of items.  
Type: String

## Errors
<a name="API_DescribeDirectories_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_DescribeDirectories_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DescribeDirectories_Example_1"></a>

This example illustrates one usage of DescribeDirectories.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 46
X-Amz-Target: DirectoryService_20150416.DescribeDirectories
X-Amz-Date: 20161214T022424Z
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/20161214/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=4e138f2c34fe61b203c621e69264a9347db842b944df2eb88fce7e2c337eab8c

 {
   "DirectoryIds": "d-926example",
   "Limit": 0
 }
```

### Example Response
<a name="API_DescribeDirectories_Example_2"></a>

This example illustrates one usage of DescribeDirectories.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 6f884e4a-c1a4-11e6-a099-03078e35561b
Content-Type: application/x-amz-json-1.1
Content-Length: 470
Date: Wed, 14 Dec 2016 02:24:27 GMT

{
   "DirectoryDescriptions":[
      {
         "AccessUrl":"myaccess.awsapps.com",
         "Alias":"myaccess",
         "DirectoryId":"d-926example",
         "DnsIpAddrs":[
            "172.30.21.228",
            "172.30.9.82"
         ],
         "LaunchTime":1.469737584772E9,
         "Name":"corp.example.com",
         "ShortName":"example",
         "SsoEnabled":true,
         "Stage":"Active",
         "StageLastUpdatedDateTime":1.46973913171E9,
         "Type":"MicrosoftAD",
         "VpcSettings":{
            "AvailabilityZones":[
               "us-west-2a",
               "us-west-2b"
            ],
            "SubnetIds":[
               "subnet-ba0146de",
               "subnet-bef46bc8"
            ],
            "VpcId":"vpc-45025421"
         }
      }
   ]
}
```

## See Also
<a name="API_DescribeDirectories_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeDirectories) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeDirectories) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeDirectories) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeDirectories) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeDirectories) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeDirectories) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeDirectories) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeDirectories) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeDirectories) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeDirectories) 

# DescribeDirectoryDataAccess
<a name="API_DescribeDirectoryDataAccess"></a>

Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.

## Request Syntax
<a name="API_DescribeDirectoryDataAccess_RequestSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_DescribeDirectoryDataAccess_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DescribeDirectoryDataAccess_RequestSyntax) **   <a name="DirectoryService-DescribeDirectoryDataAccess-request-DirectoryId"></a>
The directory identifier.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Syntax
<a name="API_DescribeDirectoryDataAccess_ResponseSyntax"></a>

```
{
   "DataAccessStatus": "string"
}
```

## Response Elements
<a name="API_DescribeDirectoryDataAccess_ResponseElements"></a>

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

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

 ** [DataAccessStatus](#API_DescribeDirectoryDataAccess_ResponseSyntax) **   <a name="DirectoryService-DescribeDirectoryDataAccess-response-DataAccessStatus"></a>
The current status of data access through the Directory Service Data API.  
Type: String  
Valid Values: `Disabled | Disabling | Enabled | Enabling | Failed` 

## Errors
<a name="API_DescribeDirectoryDataAccess_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_DescribeDirectoryDataAccess_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DescribeDirectoryDataAccess_Example_1"></a>

This example illustrates one usage of DescribeDirectoryDataAccess.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 98
X-Amz-Target: DirectoryService_20150416.DescribeDirectoryDataAccess
X-Amz-Date: 20161212T212029Z
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=477f3a2802dcc303f69499723eb2e29a455fe3d1b646df0dacfd7c005a3a9509

 {
   "DirectoryId":"d-926example"
 }
```

### Example Response
<a name="API_DescribeDirectoryDataAccess_Example_2"></a>

This example illustrates one usage of DescribeDirectoryDataAccess.

```
HTTP/1.1 200 OK
x-amzn-RequestId: cfc1cbc8-c0b0-11e6-aa44-41d91ee57463
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Mon, 12 Dec 2016 21:20:31 GMT

  {
    "DataAccessStatus": "Enabled"
  }
```

## See Also
<a name="API_DescribeDirectoryDataAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeDirectoryDataAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeDirectoryDataAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeDirectoryDataAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeDirectoryDataAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeDirectoryDataAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeDirectoryDataAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeDirectoryDataAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeDirectoryDataAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeDirectoryDataAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeDirectoryDataAccess) 

# DescribeDomainControllers
<a name="API_DescribeDomainControllers"></a>

Provides information about any domain controllers in your directory.

## Request Syntax
<a name="API_DescribeDomainControllers_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "DomainControllerIds": [ "string" ],
   "Limit": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeDomainControllers_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DescribeDomainControllers_RequestSyntax) **   <a name="DirectoryService-DescribeDomainControllers-request-DirectoryId"></a>
Identifier of the directory for which to retrieve the domain controller information.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [DomainControllerIds](#API_DescribeDomainControllers_RequestSyntax) **   <a name="DirectoryService-DescribeDomainControllers-request-DomainControllerIds"></a>
A list of identifiers for the domain controllers whose information will be provided.  
Type: Array of strings  
Pattern: `^dc-[0-9a-f]{10}$`   
Required: No

 ** [Limit](#API_DescribeDomainControllers_RequestSyntax) **   <a name="DirectoryService-DescribeDomainControllers-request-Limit"></a>
The maximum number of items to return.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [NextToken](#API_DescribeDomainControllers_RequestSyntax) **   <a name="DirectoryService-DescribeDomainControllers-request-NextToken"></a>
The *DescribeDomainControllers.NextToken* value from a previous call to [DescribeDomainControllers](#API_DescribeDomainControllers). Pass null if this is the first call.   
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeDomainControllers_ResponseSyntax"></a>

```
{
   "DomainControllers": [ 
      { 
         "AvailabilityZone": "string",
         "DirectoryId": "string",
         "DnsIpAddr": "string",
         "DnsIpv6Addr": "string",
         "DomainControllerId": "string",
         "LaunchTime": number,
         "Status": "string",
         "StatusLastUpdatedDateTime": number,
         "StatusReason": "string",
         "SubnetId": "string",
         "VpcId": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeDomainControllers_ResponseElements"></a>

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

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

 ** [DomainControllers](#API_DescribeDomainControllers_ResponseSyntax) **   <a name="DirectoryService-DescribeDomainControllers-response-DomainControllers"></a>
List of the [DomainController](API_DomainController.md) objects that were retrieved.  
Type: Array of [DomainController](API_DomainController.md) objects

 ** [NextToken](#API_DescribeDomainControllers_ResponseSyntax) **   <a name="DirectoryService-DescribeDomainControllers-response-NextToken"></a>
If not null, more results are available. Pass this value for the `NextToken` parameter in a subsequent call to [DescribeDomainControllers](#API_DescribeDomainControllers) retrieve the next set of items.  
Type: String

## Errors
<a name="API_DescribeDomainControllers_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_DescribeDomainControllers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeDomainControllers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeDomainControllers) 

# DescribeEventTopics
<a name="API_DescribeEventTopics"></a>

Obtains information about which Amazon SNS topics receive status messages from the specified directory.

If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.

## Request Syntax
<a name="API_DescribeEventTopics_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "TopicNames": [ "string" ]
}
```

## Request Parameters
<a name="API_DescribeEventTopics_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DescribeEventTopics_RequestSyntax) **   <a name="DirectoryService-DescribeEventTopics-request-DirectoryId"></a>
The Directory ID for which to get the list of associated Amazon SNS topics. If this member is null, associations for all Directory IDs are returned.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: No

 ** [TopicNames](#API_DescribeEventTopics_RequestSyntax) **   <a name="DirectoryService-DescribeEventTopics-request-TopicNames"></a>
A list of Amazon SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.  
An empty list results in an `InvalidParameterException` being thrown.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: No

## Response Syntax
<a name="API_DescribeEventTopics_ResponseSyntax"></a>

```
{
   "EventTopics": [ 
      { 
         "CreatedDateTime": number,
         "DirectoryId": "string",
         "Status": "string",
         "TopicArn": "string",
         "TopicName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeEventTopics_ResponseElements"></a>

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

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

 ** [EventTopics](#API_DescribeEventTopics_ResponseSyntax) **   <a name="DirectoryService-DescribeEventTopics-response-EventTopics"></a>
A list of Amazon SNS topic names that receive status messages from the specified Directory ID.  
Type: Array of [EventTopic](API_EventTopic.md) objects

## Errors
<a name="API_DescribeEventTopics_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_DescribeEventTopics_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DescribeEventTopics_Example_1"></a>

This example illustrates one usage of DescribeEventTopics.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 66
X-Amz-Target: DirectoryService_20150416.DescribeEventTopics
X-Amz-Date: 20161214T025225Z
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/20161214/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=d04fcf5cf8439dd8d0503933cab61c2bad6d6b29b9e1e5dca25f6d6de1704e17

 {
   "DirectoryId": "d-926example",
   "TopicNames": "snstopicexample"
 }
```

### Example Response
<a name="API_DescribeEventTopics_Example_2"></a>

This example illustrates one usage of DescribeEventTopics.

```
HTTP/1.1 200 OK
x-amzn-RequestId: a68a1e79-c19b-11e6-870b-c3330207df37
Content-Type: application/x-amz-json-1.1
Content-Length: 29
Date: Wed, 14 Dec 2016 02:52:27 GMT

{  
  "EventTopics": ["eventtopicexample"]
}
```

## See Also
<a name="API_DescribeEventTopics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeEventTopics) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeEventTopics) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeEventTopics) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeEventTopics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeEventTopics) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeEventTopics) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeEventTopics) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeEventTopics) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeEventTopics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeEventTopics) 

# DescribeHybridADUpdate
<a name="API_DescribeHybridADUpdate"></a>

Retrieves information about update activities for a hybrid directory. This operation provides details about configuration changes, administrator account updates, and self-managed instance settings (IDs and DNS IPs).

## Request Syntax
<a name="API_DescribeHybridADUpdate_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "NextToken": "string",
   "UpdateType": "string"
}
```

## Request Parameters
<a name="API_DescribeHybridADUpdate_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DescribeHybridADUpdate_RequestSyntax) **   <a name="DirectoryService-DescribeHybridADUpdate-request-DirectoryId"></a>
The identifier of the hybrid directory for which to retrieve update information.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [NextToken](#API_DescribeHybridADUpdate_RequestSyntax) **   <a name="DirectoryService-DescribeHybridADUpdate-request-NextToken"></a>
The pagination token from a previous request to [DescribeHybridADUpdate](#API_DescribeHybridADUpdate). Pass null if this is the first request.  
Type: String  
Required: No

 ** [UpdateType](#API_DescribeHybridADUpdate_RequestSyntax) **   <a name="DirectoryService-DescribeHybridADUpdate-request-UpdateType"></a>
The type of update activities to retrieve. Valid values include `SelfManagedInstances` and `HybridAdministratorAccount`.  
Type: String  
Valid Values: `SelfManagedInstances | HybridAdministratorAccount`   
Required: No

## Response Syntax
<a name="API_DescribeHybridADUpdate_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "UpdateActivities": { 
      "HybridAdministratorAccount": [ 
         { 
            "AssessmentId": "string",
            "InitiatedBy": "string",
            "LastUpdatedDateTime": number,
            "NewValue": { 
               "DnsIps": [ "string" ],
               "InstanceIds": [ "string" ]
            },
            "PreviousValue": { 
               "DnsIps": [ "string" ],
               "InstanceIds": [ "string" ]
            },
            "StartTime": number,
            "Status": "string",
            "StatusReason": "string"
         }
      ],
      "SelfManagedInstances": [ 
         { 
            "AssessmentId": "string",
            "InitiatedBy": "string",
            "LastUpdatedDateTime": number,
            "NewValue": { 
               "DnsIps": [ "string" ],
               "InstanceIds": [ "string" ]
            },
            "PreviousValue": { 
               "DnsIps": [ "string" ],
               "InstanceIds": [ "string" ]
            },
            "StartTime": number,
            "Status": "string",
            "StatusReason": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_DescribeHybridADUpdate_ResponseElements"></a>

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

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

 ** [NextToken](#API_DescribeHybridADUpdate_ResponseSyntax) **   <a name="DirectoryService-DescribeHybridADUpdate-response-NextToken"></a>
If not null, more results are available. Pass this value for the `NextToken` parameter in a subsequent request to retrieve the next set of items.  
Type: String

 ** [UpdateActivities](#API_DescribeHybridADUpdate_ResponseSyntax) **   <a name="DirectoryService-DescribeHybridADUpdate-response-UpdateActivities"></a>
Information about update activities for the hybrid directory, organized by update type.  
Type: [HybridUpdateActivities](API_HybridUpdateActivities.md) object

## Errors
<a name="API_DescribeHybridADUpdate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_DescribeHybridADUpdate_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DescribeHybridADUpdate_Example_1"></a>

This example illustrates one usage of DescribeHybridADUpdate.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 95
X-Amz-Target: DirectoryService_20150416.DescribeHybridADUpdate
X-Amz-Date: 20231212T212029Z
User-Agent: aws-cli/2.0.0 Python/3.8.0 Linux/5.4.0 botocore/2.0.0
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
 Credential=AKIAIOSFODNN7EXAMPLE/20231212/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

{
    "DirectoryId": "d-926example",
    "UpdateType": "HybridAdministratorAccount"
}
```

### Example Response
<a name="API_DescribeHybridADUpdate_Example_2"></a>

This example illustrates one usage of DescribeHybridADUpdate.

```
HTTP/1.1 200 OK
x-amzn-RequestId: cfc1cbc8-c0b0-11e6-aa44-41d91ee57463
Content-Type: application/x-amz-json-1.1
Content-Length: 456
Date: Mon, 12 Dec 2023 21:20:31 GMT

{
    "HybridActivities": {
        "HybridAdministratorAccount": [
            {
                "Status": "UPDATE_REQUESTED",
                "InitiatedBy": "061086805150",
                "StartTime": "2025-07-14T20:27:59.002000-04:00",
                "LastUpdatedDateTime": "2025-07-14T20:27:59.002000-04:00",
                "AssessmentId": "da-1234567890example1"
            }
        ]
    }
}
```

## See Also
<a name="API_DescribeHybridADUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeHybridADUpdate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeHybridADUpdate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeHybridADUpdate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeHybridADUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeHybridADUpdate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeHybridADUpdate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeHybridADUpdate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeHybridADUpdate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeHybridADUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeHybridADUpdate) 

# DescribeLDAPSSettings
<a name="API_DescribeLDAPSSettings"></a>

Describes the status of LDAP security for the specified directory.

## Request Syntax
<a name="API_DescribeLDAPSSettings_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Limit": number,
   "NextToken": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_DescribeLDAPSSettings_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DescribeLDAPSSettings_RequestSyntax) **   <a name="DirectoryService-DescribeLDAPSSettings-request-DirectoryId"></a>
The identifier of the directory.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [Limit](#API_DescribeLDAPSSettings_RequestSyntax) **   <a name="DirectoryService-DescribeLDAPSSettings-request-Limit"></a>
Specifies the number of items that should be displayed on one page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_DescribeLDAPSSettings_RequestSyntax) **   <a name="DirectoryService-DescribeLDAPSSettings-request-NextToken"></a>
The type of next token used for pagination.  
Type: String  
Required: No

 ** [Type](#API_DescribeLDAPSSettings_RequestSyntax) **   <a name="DirectoryService-DescribeLDAPSSettings-request-Type"></a>
The type of LDAP security to enable. Currently only the value `Client` is supported.  
Type: String  
Valid Values: `Client`   
Required: No

## Response Syntax
<a name="API_DescribeLDAPSSettings_ResponseSyntax"></a>

```
{
   "LDAPSSettingsInfo": [ 
      { 
         "LastUpdatedDateTime": number,
         "LDAPSStatus": "string",
         "LDAPSStatusReason": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_DescribeLDAPSSettings_ResponseElements"></a>

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

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

 ** [LDAPSSettingsInfo](#API_DescribeLDAPSSettings_ResponseSyntax) **   <a name="DirectoryService-DescribeLDAPSSettings-response-LDAPSSettingsInfo"></a>
Information about LDAP security for the specified directory, including status of enablement, state last updated date time, and the reason for the state.  
Type: Array of [LDAPSSettingInfo](API_LDAPSSettingInfo.md) objects

 ** [NextToken](#API_DescribeLDAPSSettings_ResponseSyntax) **   <a name="DirectoryService-DescribeLDAPSSettings-response-NextToken"></a>
The next token used to retrieve the LDAPS settings if the number of setting types exceeds page limit and there is another page.  
Type: String

## Errors
<a name="API_DescribeLDAPSSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_DescribeLDAPSSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeLDAPSSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeLDAPSSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeLDAPSSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeLDAPSSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeLDAPSSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeLDAPSSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeLDAPSSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeLDAPSSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeLDAPSSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeLDAPSSettings) 

# DescribeRegions
<a name="API_DescribeRegions"></a>

Provides information about the Regions that are configured for multi-Region replication.

## Request Syntax
<a name="API_DescribeRegions_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "NextToken": "string",
   "RegionName": "string"
}
```

## Request Parameters
<a name="API_DescribeRegions_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DescribeRegions_RequestSyntax) **   <a name="DirectoryService-DescribeRegions-request-DirectoryId"></a>
The identifier of the directory.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [NextToken](#API_DescribeRegions_RequestSyntax) **   <a name="DirectoryService-DescribeRegions-request-NextToken"></a>
The `DescribeRegionsResult.NextToken` value from a previous call to [DescribeRegions](#API_DescribeRegions). Pass null if this is the first call.  
Type: String  
Required: No

 ** [RegionName](#API_DescribeRegions_RequestSyntax) **   <a name="DirectoryService-DescribeRegions-request-RegionName"></a>
The name of the Region. For example, `us-east-1`.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 32.  
Required: No

## Response Syntax
<a name="API_DescribeRegions_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "RegionsDescription": [ 
      { 
         "DesiredNumberOfDomainControllers": number,
         "DirectoryId": "string",
         "LastUpdatedDateTime": number,
         "LaunchTime": number,
         "RegionName": "string",
         "RegionType": "string",
         "Status": "string",
         "StatusLastUpdatedDateTime": number,
         "VpcSettings": { 
            "SubnetIds": [ "string" ],
            "VpcId": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_DescribeRegions_ResponseElements"></a>

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

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

 ** [NextToken](#API_DescribeRegions_ResponseSyntax) **   <a name="DirectoryService-DescribeRegions-response-NextToken"></a>
If not null, more results are available. Pass this value for the `NextToken` parameter in a subsequent call to [DescribeRegions](#API_DescribeRegions) to retrieve the next set of items.  
Type: String

 ** [RegionsDescription](#API_DescribeRegions_ResponseSyntax) **   <a name="DirectoryService-DescribeRegions-response-RegionsDescription"></a>
List of Region information related to the directory for each replicated Region.  
Type: Array of [RegionDescription](API_RegionDescription.md) objects

## Errors
<a name="API_DescribeRegions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_DescribeRegions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeRegions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeRegions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeRegions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeRegions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeRegions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeRegions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeRegions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeRegions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeRegions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeRegions) 

# DescribeSettings
<a name="API_DescribeSettings"></a>

Retrieves information about the configurable settings for the specified directory.

## Request Syntax
<a name="API_DescribeSettings_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "NextToken": "string",
   "Status": "string"
}
```

## Request Parameters
<a name="API_DescribeSettings_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DescribeSettings_RequestSyntax) **   <a name="DirectoryService-DescribeSettings-request-DirectoryId"></a>
The identifier of the directory for which to retrieve information.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [NextToken](#API_DescribeSettings_RequestSyntax) **   <a name="DirectoryService-DescribeSettings-request-NextToken"></a>
The `DescribeSettingsResult.NextToken` value from a previous call to [DescribeSettings](#API_DescribeSettings). Pass null if this is the first call.  
Type: String  
Required: No

 ** [Status](#API_DescribeSettings_RequestSyntax) **   <a name="DirectoryService-DescribeSettings-request-Status"></a>
The status of the directory settings for which to retrieve information.  
Type: String  
Valid Values: `Requested | Updating | Updated | Failed | Default`   
Required: No

## Response Syntax
<a name="API_DescribeSettings_ResponseSyntax"></a>

```
{
   "DirectoryId": "string",
   "NextToken": "string",
   "SettingEntries": [ 
      { 
         "AllowedValues": "string",
         "AppliedValue": "string",
         "DataType": "string",
         "LastRequestedDateTime": number,
         "LastUpdatedDateTime": number,
         "Name": "string",
         "RequestDetailedStatus": { 
            "string" : "string" 
         },
         "RequestedValue": "string",
         "RequestStatus": "string",
         "RequestStatusMessage": "string",
         "Type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeSettings_ResponseElements"></a>

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

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

 ** [DirectoryId](#API_DescribeSettings_ResponseSyntax) **   <a name="DirectoryService-DescribeSettings-response-DirectoryId"></a>
The identifier of the directory.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$` 

 ** [NextToken](#API_DescribeSettings_ResponseSyntax) **   <a name="DirectoryService-DescribeSettings-response-NextToken"></a>
If not null, token that indicates that more results are available. Pass this value for the `NextToken` parameter in a subsequent call to `DescribeSettings` to retrieve the next set of items.   
Type: String

 ** [SettingEntries](#API_DescribeSettings_ResponseSyntax) **   <a name="DirectoryService-DescribeSettings-response-SettingEntries"></a>
The list of [SettingEntry](API_SettingEntry.md) objects that were retrieved.  
It is possible that this list contains less than the number of items specified in the `Limit` member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.  
Type: Array of [SettingEntry](API_SettingEntry.md) objects

## Errors
<a name="API_DescribeSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_DescribeSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeSettings) 

# DescribeSharedDirectories
<a name="API_DescribeSharedDirectories"></a>

Returns the shared directories in your account. 

## Request Syntax
<a name="API_DescribeSharedDirectories_RequestSyntax"></a>

```
{
   "Limit": number,
   "NextToken": "string",
   "OwnerDirectoryId": "string",
   "SharedDirectoryIds": [ "string" ]
}
```

## Request Parameters
<a name="API_DescribeSharedDirectories_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [Limit](#API_DescribeSharedDirectories_RequestSyntax) **   <a name="DirectoryService-DescribeSharedDirectories-request-Limit"></a>
The number of shared directories to return in the response object.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [NextToken](#API_DescribeSharedDirectories_RequestSyntax) **   <a name="DirectoryService-DescribeSharedDirectories-request-NextToken"></a>
The `DescribeSharedDirectoriesResult.NextToken` value from a previous call to [DescribeSharedDirectories](#API_DescribeSharedDirectories). Pass null if this is the first call.   
Type: String  
Required: No

 ** [OwnerDirectoryId](#API_DescribeSharedDirectories_RequestSyntax) **   <a name="DirectoryService-DescribeSharedDirectories-request-OwnerDirectoryId"></a>
Returns the identifier of the directory in the directory owner account.   
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [SharedDirectoryIds](#API_DescribeSharedDirectories_RequestSyntax) **   <a name="DirectoryService-DescribeSharedDirectories-request-SharedDirectoryIds"></a>
A list of identifiers of all shared directories in your account.   
Type: Array of strings  
Pattern: `^d-[0-9a-f]{10}$`   
Required: No

## Response Syntax
<a name="API_DescribeSharedDirectories_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "SharedDirectories": [ 
      { 
         "CreatedDateTime": number,
         "LastUpdatedDateTime": number,
         "OwnerAccountId": "string",
         "OwnerDirectoryId": "string",
         "SharedAccountId": "string",
         "SharedDirectoryId": "string",
         "ShareMethod": "string",
         "ShareNotes": "string",
         "ShareStatus": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeSharedDirectories_ResponseElements"></a>

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

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

 ** [NextToken](#API_DescribeSharedDirectories_ResponseSyntax) **   <a name="DirectoryService-DescribeSharedDirectories-response-NextToken"></a>
If not null, token that indicates that more results are available. Pass this value for the `NextToken` parameter in a subsequent call to [DescribeSharedDirectories](#API_DescribeSharedDirectories) to retrieve the next set of items.  
Type: String

 ** [SharedDirectories](#API_DescribeSharedDirectories_ResponseSyntax) **   <a name="DirectoryService-DescribeSharedDirectories-response-SharedDirectories"></a>
A list of all shared directories in your account.  
Type: Array of [SharedDirectory](API_SharedDirectory.md) objects

## Errors
<a name="API_DescribeSharedDirectories_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_DescribeSharedDirectories_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeSharedDirectories) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeSharedDirectories) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeSharedDirectories) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeSharedDirectories) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeSharedDirectories) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeSharedDirectories) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeSharedDirectories) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeSharedDirectories) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeSharedDirectories) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeSharedDirectories) 

# DescribeSnapshots
<a name="API_DescribeSnapshots"></a>

Obtains information about the directory snapshots that belong to this account.

This operation supports pagination with the use of the *NextToken* request and response parameters. If more results are available, the *DescribeSnapshots.NextToken* member contains a token that you pass in the next call to [DescribeSnapshots](#API_DescribeSnapshots) to retrieve the next set of items.

You can also specify a maximum number of return results with the *Limit* parameter.

## Request Syntax
<a name="API_DescribeSnapshots_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Limit": number,
   "NextToken": "string",
   "SnapshotIds": [ "string" ]
}
```

## Request Parameters
<a name="API_DescribeSnapshots_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DescribeSnapshots_RequestSyntax) **   <a name="DirectoryService-DescribeSnapshots-request-DirectoryId"></a>
The identifier of the directory for which to retrieve snapshot information.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: No

 ** [Limit](#API_DescribeSnapshots_RequestSyntax) **   <a name="DirectoryService-DescribeSnapshots-request-Limit"></a>
The maximum number of objects to return.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [NextToken](#API_DescribeSnapshots_RequestSyntax) **   <a name="DirectoryService-DescribeSnapshots-request-NextToken"></a>
The *DescribeSnapshotsResult.NextToken* value from a previous call to [DescribeSnapshots](#API_DescribeSnapshots). Pass null if this is the first call.  
Type: String  
Required: No

 ** [SnapshotIds](#API_DescribeSnapshots_RequestSyntax) **   <a name="DirectoryService-DescribeSnapshots-request-SnapshotIds"></a>
A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the *Limit* and *NextToken* members.  
Type: Array of strings  
Pattern: `^s-[0-9a-f]{10}$`   
Required: No

## Response Syntax
<a name="API_DescribeSnapshots_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Snapshots": [ 
      { 
         "DirectoryId": "string",
         "Name": "string",
         "SnapshotId": "string",
         "StartTime": number,
         "Status": "string",
         "Type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeSnapshots_ResponseElements"></a>

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

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

 ** [NextToken](#API_DescribeSnapshots_ResponseSyntax) **   <a name="DirectoryService-DescribeSnapshots-response-NextToken"></a>
If not null, more results are available. Pass this value in the *NextToken* member of a subsequent call to [DescribeSnapshots](#API_DescribeSnapshots).  
Type: String

 ** [Snapshots](#API_DescribeSnapshots_ResponseSyntax) **   <a name="DirectoryService-DescribeSnapshots-response-Snapshots"></a>
The list of [Snapshot](API_Snapshot.md) objects that were retrieved.  
It is possible that this list contains less than the number of items specified in the *Limit* member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.  
Type: Array of [Snapshot](API_Snapshot.md) objects

## Errors
<a name="API_DescribeSnapshots_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_DescribeSnapshots_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DescribeSnapshots_Example_1"></a>

This example illustrates one usage of DescribeSnapshots.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 76
X-Amz-Target: DirectoryService_20150416.DescribeSnapshots
X-Amz-Date: 20161214T164618Z
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/20161214/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=602552c456c471537cbafaec3b7712674bdc20574c076dace469f3848fa8ab7a

 {
   "DirectoryId": "d-926example", 
   "Limit": 0, 
   "SnapshotIds": ["s-9267f6da4e"]
 }
```

### Example Response
<a name="API_DescribeSnapshots_Example_2"></a>

This example illustrates one usage of DescribeSnapshots.

```
HTTP/1.1 200 OK
x-amzn-RequestId: d7b33e7e-c21c-11e6-91f4-6dbff6648f8a
Content-Type: application/x-amz-json-1.1
Content-Length: 138
Date: Wed, 14 Dec 2016 16:46:21 GMT

{
   "Snapshots":[
      {
         "DirectoryId":"d-926example",
         "SnapshotId":"s-9267f6da4e",
         "StartTime":1.481289211615E9,
         "Status":"Completed",
         "Type":"Auto"
      }
   ]
}
```

## See Also
<a name="API_DescribeSnapshots_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeSnapshots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeSnapshots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeSnapshots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeSnapshots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeSnapshots) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeSnapshots) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeSnapshots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeSnapshots) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeSnapshots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeSnapshots) 

# DescribeTrusts
<a name="API_DescribeTrusts"></a>

Obtains information about the trust relationships for this account.

If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.

## Request Syntax
<a name="API_DescribeTrusts_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Limit": number,
   "NextToken": "string",
   "TrustIds": [ "string" ]
}
```

## Request Parameters
<a name="API_DescribeTrusts_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DescribeTrusts_RequestSyntax) **   <a name="DirectoryService-DescribeTrusts-request-DirectoryId"></a>
The Directory ID of the AWS directory that is a part of the requested trust relationship.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: No

 ** [Limit](#API_DescribeTrusts_RequestSyntax) **   <a name="DirectoryService-DescribeTrusts-request-Limit"></a>
The maximum number of objects to return.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [NextToken](#API_DescribeTrusts_RequestSyntax) **   <a name="DirectoryService-DescribeTrusts-request-NextToken"></a>
The *DescribeTrustsResult.NextToken* value from a previous call to [DescribeTrusts](#API_DescribeTrusts). Pass null if this is the first call.  
Type: String  
Required: No

 ** [TrustIds](#API_DescribeTrusts_RequestSyntax) **   <a name="DirectoryService-DescribeTrusts-request-TrustIds"></a>
A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned.  
An empty list results in an `InvalidParameterException` being thrown.  
Type: Array of strings  
Pattern: `^t-[0-9a-f]{10}$`   
Required: No

## Response Syntax
<a name="API_DescribeTrusts_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Trusts": [ 
      { 
         "CreatedDateTime": number,
         "DirectoryId": "string",
         "LastUpdatedDateTime": number,
         "RemoteDomainName": "string",
         "SelectiveAuth": "string",
         "StateLastUpdatedDateTime": number,
         "TrustDirection": "string",
         "TrustId": "string",
         "TrustState": "string",
         "TrustStateReason": "string",
         "TrustType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeTrusts_ResponseElements"></a>

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

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

 ** [NextToken](#API_DescribeTrusts_ResponseSyntax) **   <a name="DirectoryService-DescribeTrusts-response-NextToken"></a>
If not null, more results are available. Pass this value for the *NextToken* parameter in a subsequent call to [DescribeTrusts](#API_DescribeTrusts) to retrieve the next set of items.  
Type: String

 ** [Trusts](#API_DescribeTrusts_ResponseSyntax) **   <a name="DirectoryService-DescribeTrusts-response-Trusts"></a>
The list of Trust objects that were retrieved.  
It is possible that this list contains less than the number of items specified in the *Limit* member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.  
Type: Array of [Trust](API_Trust.md) objects

## Errors
<a name="API_DescribeTrusts_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_DescribeTrusts_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DescribeTrusts_Example_1"></a>

This example illustrates one usage of DescribeTrusts.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 61
X-Amz-Target: DirectoryService_20150416.DescribeTrusts
X-Amz-Date: 20161214T210907Z
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/20161214/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=fc201f050b631958cf6c5e186c5c897e82a974dad41b0e3c141a811003fa3c9b

 {
   "DirectoryId":"d-926example",
   "TrustIds": ["t-9267353df0"]
 }
```

### Example Response
<a name="API_DescribeTrusts_Example_2"></a>

This example illustrates one usage of DescribeTrusts.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 8e6560bd-c241-11e6-a4dc-e5519684970a
Content-Type: application/x-amz-json-1.1
Content-Length: 406
Date: Wed, 14 Dec 2016 21:09:09 GMT

 {
   "Trusts": [
     {
       "CreatedDateTime": 1481749250.657,
       "DirectoryId": "d-926example",
       "LastUpdatedDateTime": 1481749260.156,
       "RemoteDomainName": "sales.example.com",
       "StateLastUpdatedDateTime": 1481749260.156,
       "TrustDirection": "One-Way: Outgoing",
       "TrustId": "t-9267353df0",
       "TrustState": "Failed",
       "TrustStateReason": "The specified domain either does not exist or could not be contacted. Name: sales.example.com",
       "TrustType": "Forest"
     }
   ]
 }
```

## See Also
<a name="API_DescribeTrusts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeTrusts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeTrusts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeTrusts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeTrusts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeTrusts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeTrusts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeTrusts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeTrusts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeTrusts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeTrusts) 

# DescribeUpdateDirectory
<a name="API_DescribeUpdateDirectory"></a>

 Describes the updates of a directory for a particular update type. 

## Request Syntax
<a name="API_DescribeUpdateDirectory_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "NextToken": "string",
   "RegionName": "string",
   "UpdateType": "string"
}
```

## Request Parameters
<a name="API_DescribeUpdateDirectory_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DescribeUpdateDirectory_RequestSyntax) **   <a name="DirectoryService-DescribeUpdateDirectory-request-DirectoryId"></a>
 The unique identifier of the directory.   
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [NextToken](#API_DescribeUpdateDirectory_RequestSyntax) **   <a name="DirectoryService-DescribeUpdateDirectory-request-NextToken"></a>
 The `DescribeUpdateDirectoryResult`. NextToken value from a previous call to [DescribeUpdateDirectory](#API_DescribeUpdateDirectory). Pass null if this is the first call.   
Type: String  
Required: No

 ** [RegionName](#API_DescribeUpdateDirectory_RequestSyntax) **   <a name="DirectoryService-DescribeUpdateDirectory-request-RegionName"></a>
 The name of the Region.   
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 32.  
Required: No

 ** [UpdateType](#API_DescribeUpdateDirectory_RequestSyntax) **   <a name="DirectoryService-DescribeUpdateDirectory-request-UpdateType"></a>
 The type of updates you want to describe for the directory.   
Type: String  
Valid Values: `OS | NETWORK | SIZE`   
Required: Yes

## Response Syntax
<a name="API_DescribeUpdateDirectory_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "UpdateActivities": [ 
      { 
         "InitiatedBy": "string",
         "LastUpdatedDateTime": number,
         "NewValue": { 
            "OSUpdateSettings": { 
               "OSVersion": "string"
            }
         },
         "PreviousValue": { 
            "OSUpdateSettings": { 
               "OSVersion": "string"
            }
         },
         "Region": "string",
         "StartTime": number,
         "Status": "string",
         "StatusReason": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeUpdateDirectory_ResponseElements"></a>

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

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

 ** [NextToken](#API_DescribeUpdateDirectory_ResponseSyntax) **   <a name="DirectoryService-DescribeUpdateDirectory-response-NextToken"></a>
 If not null, more results are available. Pass this value for the `NextToken` parameter.   
Type: String

 ** [UpdateActivities](#API_DescribeUpdateDirectory_ResponseSyntax) **   <a name="DirectoryService-DescribeUpdateDirectory-response-UpdateActivities"></a>
 The list of update activities on a directory for the requested update type.   
Type: Array of [UpdateInfoEntry](API_UpdateInfoEntry.md) objects

## Errors
<a name="API_DescribeUpdateDirectory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## See Also
<a name="API_DescribeUpdateDirectory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DescribeUpdateDirectory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DescribeUpdateDirectory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DescribeUpdateDirectory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DescribeUpdateDirectory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DescribeUpdateDirectory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DescribeUpdateDirectory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DescribeUpdateDirectory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DescribeUpdateDirectory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DescribeUpdateDirectory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DescribeUpdateDirectory) 

# DisableCAEnrollmentPolicy
<a name="API_DisableCAEnrollmentPolicy"></a>

Disables the certificate authority (CA) enrollment policy for the specified directory. This stops automatic certificate enrollment and management for domain-joined clients, but does not affect existing certificates.

**Important**  
Disabling the CA enrollment policy prevents new certificates from being automatically enrolled, but existing certificates remain valid and functional until they expire.

## Request Syntax
<a name="API_DisableCAEnrollmentPolicy_RequestSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_DisableCAEnrollmentPolicy_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DisableCAEnrollmentPolicy_RequestSyntax) **   <a name="DirectoryService-DisableCAEnrollmentPolicy-request-DirectoryId"></a>
The identifier of the directory for which to disable the CA enrollment policy.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Elements
<a name="API_DisableCAEnrollmentPolicy_ResponseElements"></a>

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

## Errors
<a name="API_DisableCAEnrollmentPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DisableAlreadyInProgressException **   
A disable operation for CA enrollment policy is already in progress for this directory.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_DisableCAEnrollmentPolicy_Examples"></a>

The following examples are formatted for legibility.

### Disable CA enrollment policy
<a name="API_DisableCAEnrollmentPolicy_Example_1"></a>

The following example disables the CA enrollment policy for a directory.

#### Sample Request
<a name="API_DisableCAEnrollmentPolicy_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 45
X-Amz-Target: DirectoryService_20150416.DisableCAEnrollmentPolicy
X-Amz-Date: 20230815T143000Z
User-Agent: aws-cli/2.0.0 Python/3.8.0 Linux/5.4.0 botocore/2.0.0
Authorization: AWS4-HMAC-SHA256
  Credential=AKIAIOSFODNN7EXAMPLE/20230815/us-west-2/ds/aws4_request,
  SignedHeaders=host;x-amz-date;x-amz-target,
  Signature=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

{
  "DirectoryId": "d-926example"
}
```

#### Sample Response
<a name="API_DisableCAEnrollmentPolicy_Example_1_Response"></a>

```
HTTP/1.1 200 OK
Date: Tue, 15 Aug 2023 14:30:00 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 2
x-amzn-RequestId: 12345678-1234-1234-1234-123456789012

{}
```

## See Also
<a name="API_DisableCAEnrollmentPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DisableCAEnrollmentPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DisableCAEnrollmentPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DisableCAEnrollmentPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DisableCAEnrollmentPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DisableCAEnrollmentPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DisableCAEnrollmentPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DisableCAEnrollmentPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DisableCAEnrollmentPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DisableCAEnrollmentPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DisableCAEnrollmentPolicy) 

# DisableClientAuthentication
<a name="API_DisableClientAuthentication"></a>

Disables alternative client authentication methods for the specified directory. 

## Request Syntax
<a name="API_DisableClientAuthentication_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_DisableClientAuthentication_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DisableClientAuthentication_RequestSyntax) **   <a name="DirectoryService-DisableClientAuthentication-request-DirectoryId"></a>
The identifier of the directory   
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [Type](#API_DisableClientAuthentication_RequestSyntax) **   <a name="DirectoryService-DisableClientAuthentication-request-Type"></a>
The type of client authentication to disable. Currently the only parameter `"SmartCard"` is supported.  
Type: String  
Valid Values: `SmartCard | SmartCardOrPassword`   
Required: Yes

## Response Elements
<a name="API_DisableClientAuthentication_ResponseElements"></a>

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

## Errors
<a name="API_DisableClientAuthentication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidClientAuthStatusException **   
Client authentication is already enabled.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_DisableClientAuthentication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DisableClientAuthentication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DisableClientAuthentication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DisableClientAuthentication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DisableClientAuthentication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DisableClientAuthentication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DisableClientAuthentication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DisableClientAuthentication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DisableClientAuthentication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DisableClientAuthentication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DisableClientAuthentication) 

# DisableDirectoryDataAccess
<a name="API_DisableDirectoryDataAccess"></a>

Deactivates access to directory data via the Directory Service Data API for the specified directory. For more information, see [Directory Service Data API Reference](https://docs.aws.amazon.com/directoryservicedata/latest/DirectoryServiceDataAPIReference/Welcome.html).

## Request Syntax
<a name="API_DisableDirectoryDataAccess_RequestSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_DisableDirectoryDataAccess_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DisableDirectoryDataAccess_RequestSyntax) **   <a name="DirectoryService-DisableDirectoryDataAccess-request-DirectoryId"></a>
The directory identifier.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Elements
<a name="API_DisableDirectoryDataAccess_ResponseElements"></a>

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

## Errors
<a name="API_DisableDirectoryDataAccess_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryInDesiredStateException **   
 The directory is already updated to desired update type settings.     
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_DisableDirectoryDataAccess_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DisableDirectoryDataAccess_Example_1"></a>

This example illustrates one usage of DisableDirectoryDataAccess.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 98
X-Amz-Target: DirectoryService_20150416.DisableDirectoryDataAccess
X-Amz-Date: 20161212T212029Z
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=477f3a2802dcc303f69499723eb2e29a455fe3d1b646df0dacfd7c005a3a9509

 {
   "DirectoryId":"d-926example"
 }
```

### Example Response
<a name="API_DisableDirectoryDataAccess_Example_2"></a>

This example illustrates one usage of DisableDirectoryDataAccess.

```
HTTP/1.1 200 OK
x-amzn-RequestId: cfc1cbc8-c0b0-11e6-aa44-41d91ee57463
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Mon, 12 Dec 2016 21:20:31 GMT

 {
 }
```

## See Also
<a name="API_DisableDirectoryDataAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DisableDirectoryDataAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DisableDirectoryDataAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DisableDirectoryDataAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DisableDirectoryDataAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DisableDirectoryDataAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DisableDirectoryDataAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DisableDirectoryDataAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DisableDirectoryDataAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DisableDirectoryDataAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DisableDirectoryDataAccess) 

# DisableLDAPS
<a name="API_DisableLDAPS"></a>

Deactivates LDAP secure calls for the specified directory.

## Request Syntax
<a name="API_DisableLDAPS_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_DisableLDAPS_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DisableLDAPS_RequestSyntax) **   <a name="DirectoryService-DisableLDAPS-request-DirectoryId"></a>
The identifier of the directory.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [Type](#API_DisableLDAPS_RequestSyntax) **   <a name="DirectoryService-DisableLDAPS-request-Type"></a>
The type of LDAP security to enable. Currently only the value `Client` is supported.  
Type: String  
Valid Values: `Client`   
Required: Yes

## Response Elements
<a name="API_DisableLDAPS_ResponseElements"></a>

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

## Errors
<a name="API_DisableLDAPS_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidLDAPSStatusException **   
The LDAP activities could not be performed because they are limited by the LDAPS status.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_DisableLDAPS_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DisableLDAPS) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DisableLDAPS) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DisableLDAPS) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DisableLDAPS) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DisableLDAPS) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DisableLDAPS) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DisableLDAPS) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DisableLDAPS) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DisableLDAPS) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DisableLDAPS) 

# DisableRadius
<a name="API_DisableRadius"></a>

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

## Request Syntax
<a name="API_DisableRadius_RequestSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_DisableRadius_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DisableRadius_RequestSyntax) **   <a name="DirectoryService-DisableRadius-request-DirectoryId"></a>
The identifier of the directory for which to disable MFA.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Elements
<a name="API_DisableRadius_ResponseElements"></a>

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

## Errors
<a name="API_DisableRadius_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_DisableRadius_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DisableRadius_Example_1"></a>

This example illustrates one usage of DisableRadius.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 31
X-Amz-Target: DirectoryService_20150416.DisableRadius
X-Amz-Date: 20161214T215510Z
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/20161214/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=c7ae53fed950cedb5cc393489a79a60b9c548ee85c9c2339f8a75108a2d18525

 {
   "DirectoryId": "d-926example"
 }
```

### Example Response
<a name="API_DisableRadius_Example_2"></a>

This example illustrates one usage of DisableRadius.

```
HTTP/1.1 200 OK
x-amzn-RequestId: fcd40ac9-c247-11e6-a7ca-f9a52a6a0390
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Wed, 14 Dec 2016 21:55:12 GMT

{

}
```

## See Also
<a name="API_DisableRadius_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DisableRadius) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DisableRadius) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DisableRadius) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DisableRadius) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DisableRadius) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DisableRadius) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DisableRadius) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DisableRadius) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DisableRadius) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DisableRadius) 

# DisableSso
<a name="API_DisableSso"></a>

Disables single-sign on for a directory.

## Request Syntax
<a name="API_DisableSso_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Password": "string",
   "UserName": "string"
}
```

## Request Parameters
<a name="API_DisableSso_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_DisableSso_RequestSyntax) **   <a name="DirectoryService-DisableSso-request-DirectoryId"></a>
The identifier of the directory for which to disable single-sign on.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [Password](#API_DisableSso_RequestSyntax) **   <a name="DirectoryService-DisableSso-request-Password"></a>
The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. For more information, see the *UserName* parameter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [UserName](#API_DisableSso_RequestSyntax) **   <a name="DirectoryService-DisableSso-request-UserName"></a>
The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name.  
If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the *UserName* and *Password* parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z0-9._-]+`   
Required: No

## Response Elements
<a name="API_DisableSso_ResponseElements"></a>

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

## Errors
<a name="API_DisableSso_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthenticationFailedException **   
An authentication error occurred.    
 ** Message **   
The textual message for the exception.  
 ** RequestId **   
The identifier of the request that caused the exception.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InsufficientPermissionsException **   
The account does not have sufficient permission to perform the operation.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_DisableSso_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_DisableSso_Example_1"></a>

This example illustrates one usage of DisableSso.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 80
X-Amz-Target: DirectoryService_20150416.DisableSso
X-Amz-Date: 20161214T221722Z
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/20161214/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=b68ee7e88af7fc741471e9098dbc1636979ae461f0b9cd2f187124abbf762455

 {
   "UserName": "Admin",
   "DirectoryId": "d-926example",
   "Password": "Str0ngP@ssw0rd"
 }
```

### Example Response
<a name="API_DisableSso_Example_2"></a>

This example illustrates one usage of DisableSso.

```
HTTP/1.1 200 OK
x-amzn-RequestId: fcd40ac9-c247-11e6-a7ca-f9a52a6a0390
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Wed, 14 Dec 2016 22:17:12 GMT

{  
  
}
```

## See Also
<a name="API_DisableSso_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/DisableSso) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/DisableSso) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DisableSso) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DisableSso) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DisableSso) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DisableSso) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DisableSso) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DisableSso) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DisableSso) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DisableSso) 

# EnableCAEnrollmentPolicy
<a name="API_EnableCAEnrollmentPolicy"></a>

Enables certificate authority (CA) enrollment policy for the specified directory. This allows domain-joined clients to automatically request and receive certificates from the specified AWS Private Certificate Authority.

**Note**  
Before enabling CA enrollment, ensure that the PCA connector is properly configured and accessible from the directory. The connector must be in an active state and have the necessary permissions.

## Request Syntax
<a name="API_EnableCAEnrollmentPolicy_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "PcaConnectorArn": "string"
}
```

## Request Parameters
<a name="API_EnableCAEnrollmentPolicy_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_EnableCAEnrollmentPolicy_RequestSyntax) **   <a name="DirectoryService-EnableCAEnrollmentPolicy-request-DirectoryId"></a>
The identifier of the directory for which to enable the CA enrollment policy.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [PcaConnectorArn](#API_EnableCAEnrollmentPolicy_RequestSyntax) **   <a name="DirectoryService-EnableCAEnrollmentPolicy-request-PcaConnectorArn"></a>
The Amazon Resource Name (ARN) of the Private Certificate Authority (PCA) connector to use for automatic certificate enrollment. This connector must be properly configured and accessible from the directory.  
The ARN format is: `arn:aws:pca-connector-ad:region:account-id:connector/connector-id `   
Type: String  
Pattern: `^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:connector\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$`   
Required: Yes

## Response Elements
<a name="API_EnableCAEnrollmentPolicy_ResponseElements"></a>

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

## Errors
<a name="API_EnableCAEnrollmentPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EnableAlreadyInProgressException **   
An enable operation for CA enrollment policy is already in progress for this directory.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityAlreadyExistsException **   
The specified entity already exists.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_EnableCAEnrollmentPolicy_Examples"></a>

The following examples are formatted for legibility.

### Enable CA enrollment policy
<a name="API_EnableCAEnrollmentPolicy_Example_1"></a>

The following example enables the CA enrollment policy for a directory with a specified PCA connector.

#### Sample Request
<a name="API_EnableCAEnrollmentPolicy_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 156
X-Amz-Target: DirectoryService_20150416.EnableCAEnrollmentPolicy
X-Amz-Date: 20230815T143000Z
User-Agent: aws-cli/2.0.0 Python/3.8.0 Linux/5.4.0 botocore/2.0.0
Authorization: AWS4-HMAC-SHA256
  Credential=AKIAIOSFODNN7EXAMPLE/20230815/us-west-2/ds/aws4_request,
  SignedHeaders=host;x-amz-date;x-amz-target,
  Signature=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

{
  "DirectoryId": "d-926example",
  "PcaConnectorArn": "arn:aws:pca-connector-ad:us-east-1:123456789012:connector/c-123456789abcdef01"
}
```

#### Sample Response
<a name="API_EnableCAEnrollmentPolicy_Example_1_Response"></a>

```
HTTP/1.1 200 OK
Date: Tue, 15 Aug 2023 14:30:00 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 2
x-amzn-RequestId: 12345678-1234-1234-1234-123456789012

{}
```

## See Also
<a name="API_EnableCAEnrollmentPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/EnableCAEnrollmentPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/EnableCAEnrollmentPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/EnableCAEnrollmentPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/EnableCAEnrollmentPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/EnableCAEnrollmentPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/EnableCAEnrollmentPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/EnableCAEnrollmentPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/EnableCAEnrollmentPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/EnableCAEnrollmentPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/EnableCAEnrollmentPolicy) 

# EnableClientAuthentication
<a name="API_EnableClientAuthentication"></a>

Enables alternative client authentication methods for the specified directory.

## Request Syntax
<a name="API_EnableClientAuthentication_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_EnableClientAuthentication_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_EnableClientAuthentication_RequestSyntax) **   <a name="DirectoryService-EnableClientAuthentication-request-DirectoryId"></a>
The identifier of the specified directory.   
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [Type](#API_EnableClientAuthentication_RequestSyntax) **   <a name="DirectoryService-EnableClientAuthentication-request-Type"></a>
The type of client authentication to enable. Currently only the value `SmartCard` is supported. Smart card authentication in AD Connector requires that you enable Kerberos Constrained Delegation for the Service User to the LDAP service in your self-managed AD.   
Type: String  
Valid Values: `SmartCard | SmartCardOrPassword`   
Required: Yes

## Response Elements
<a name="API_EnableClientAuthentication_ResponseElements"></a>

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

## Errors
<a name="API_EnableClientAuthentication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidClientAuthStatusException **   
Client authentication is already enabled.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** NoAvailableCertificateException **   
Client authentication setup could not be completed because at least one valid certificate must be registered in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_EnableClientAuthentication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/EnableClientAuthentication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/EnableClientAuthentication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/EnableClientAuthentication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/EnableClientAuthentication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/EnableClientAuthentication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/EnableClientAuthentication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/EnableClientAuthentication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/EnableClientAuthentication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/EnableClientAuthentication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/EnableClientAuthentication) 

# EnableDirectoryDataAccess
<a name="API_EnableDirectoryDataAccess"></a>

Enables access to directory data via the Directory Service Data API for the specified directory. For more information, see [Directory Service Data API Reference](https://docs.aws.amazon.com/directoryservicedata/latest/DirectoryServiceDataAPIReference/Welcome.html).

## Request Syntax
<a name="API_EnableDirectoryDataAccess_RequestSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_EnableDirectoryDataAccess_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_EnableDirectoryDataAccess_RequestSyntax) **   <a name="DirectoryService-EnableDirectoryDataAccess-request-DirectoryId"></a>
The directory identifier.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Elements
<a name="API_EnableDirectoryDataAccess_ResponseElements"></a>

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

## Errors
<a name="API_EnableDirectoryDataAccess_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryInDesiredStateException **   
 The directory is already updated to desired update type settings.     
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_EnableDirectoryDataAccess_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_EnableDirectoryDataAccess_Example_1"></a>

This example illustrates one usage of EnableDirectoryDataAccess.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 98
X-Amz-Target: DirectoryService_20150416.EnableDirectoryDataAccess
X-Amz-Date: 20161212T212029Z
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=477f3a2802dcc303f69499723eb2e29a455fe3d1b646df0dacfd7c005a3a9509

 {
   "DirectoryId":"d-926example"
 }
```

### Example Response
<a name="API_EnableDirectoryDataAccess_Example_2"></a>

This example illustrates one usage of EnableDirectoryDataAccess.

```
HTTP/1.1 200 OK
x-amzn-RequestId: cfc1cbc8-c0b0-11e6-aa44-41d91ee57463
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Mon, 12 Dec 2016 21:20:31 GMT

 {
 }
```

## See Also
<a name="API_EnableDirectoryDataAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/EnableDirectoryDataAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/EnableDirectoryDataAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/EnableDirectoryDataAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/EnableDirectoryDataAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/EnableDirectoryDataAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/EnableDirectoryDataAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/EnableDirectoryDataAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/EnableDirectoryDataAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/EnableDirectoryDataAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/EnableDirectoryDataAccess) 

# EnableLDAPS
<a name="API_EnableLDAPS"></a>

Activates the switch for the specific directory to always use LDAP secure calls.

## Request Syntax
<a name="API_EnableLDAPS_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_EnableLDAPS_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_EnableLDAPS_RequestSyntax) **   <a name="DirectoryService-EnableLDAPS-request-DirectoryId"></a>
The identifier of the directory.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [Type](#API_EnableLDAPS_RequestSyntax) **   <a name="DirectoryService-EnableLDAPS-request-Type"></a>
The type of LDAP security to enable. Currently only the value `Client` is supported.  
Type: String  
Valid Values: `Client`   
Required: Yes

## Response Elements
<a name="API_EnableLDAPS_ResponseElements"></a>

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

## Errors
<a name="API_EnableLDAPS_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidLDAPSStatusException **   
The LDAP activities could not be performed because they are limited by the LDAPS status.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** NoAvailableCertificateException **   
Client authentication setup could not be completed because at least one valid certificate must be registered in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_EnableLDAPS_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/EnableLDAPS) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/EnableLDAPS) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/EnableLDAPS) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/EnableLDAPS) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/EnableLDAPS) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/EnableLDAPS) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/EnableLDAPS) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/EnableLDAPS) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/EnableLDAPS) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/EnableLDAPS) 

# EnableRadius
<a name="API_EnableRadius"></a>

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

## Request Syntax
<a name="API_EnableRadius_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "RadiusSettings": { 
      "AuthenticationProtocol": "string",
      "DisplayLabel": "string",
      "RadiusPort": number,
      "RadiusRetries": number,
      "RadiusServers": [ "string" ],
      "RadiusServersIpv6": [ "string" ],
      "RadiusTimeout": number,
      "SharedSecret": "string",
      "UseSameUsername": boolean
   }
}
```

## Request Parameters
<a name="API_EnableRadius_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_EnableRadius_RequestSyntax) **   <a name="DirectoryService-EnableRadius-request-DirectoryId"></a>
The identifier of the directory for which to enable MFA.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [RadiusSettings](#API_EnableRadius_RequestSyntax) **   <a name="DirectoryService-EnableRadius-request-RadiusSettings"></a>
A [RadiusSettings](API_RadiusSettings.md) object that contains information about the RADIUS server.  
Type: [RadiusSettings](API_RadiusSettings.md) object  
Required: Yes

## Response Elements
<a name="API_EnableRadius_ResponseElements"></a>

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

## Errors
<a name="API_EnableRadius_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityAlreadyExistsException **   
The specified entity already exists.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_EnableRadius_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_EnableRadius_Example_1"></a>

This example illustrates one usage of EnableRadius.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 259
X-Amz-Target: DirectoryService_20150416.EnableRadius
X-Amz-Date: 20161214T214103Z
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/20161214/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=4ba918cf440a45fddd5fcd1bd65207f94e760cebbd7de404d0096c6b1e652d4e

{
   "DirectoryId":"d-926example",
   "RadiusSettings":{
      "DisplayLabel":"MyRadius",
      "UseSameUsername":true,
      "RadiusTimeout":1,
      "AuthenticationProtocol":"PAP",
      "RadiusPort":1200,
      "RadiusRetries":2,
      "SharedSecret":"12345678",
      "RadiusServers":[
         "172.168.111.12"
      ]
   }
}
```

### Example Response
<a name="API_EnableRadius_Example_2"></a>

This example illustrates one usage of EnableRadius.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 045cabd8-c246-11e6-ad7a-a9557d30f017
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Wed, 14 Dec 2016 21:41:05 GMT

{

}
```

## See Also
<a name="API_EnableRadius_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/EnableRadius) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/EnableRadius) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/EnableRadius) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/EnableRadius) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/EnableRadius) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/EnableRadius) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/EnableRadius) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/EnableRadius) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/EnableRadius) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/EnableRadius) 

# EnableSso
<a name="API_EnableSso"></a>

Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately.

## Request Syntax
<a name="API_EnableSso_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Password": "string",
   "UserName": "string"
}
```

## Request Parameters
<a name="API_EnableSso_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_EnableSso_RequestSyntax) **   <a name="DirectoryService-EnableSso-request-DirectoryId"></a>
The identifier of the directory for which to enable single-sign on.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [Password](#API_EnableSso_RequestSyntax) **   <a name="DirectoryService-EnableSso-request-Password"></a>
The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the *UserName* parameter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [UserName](#API_EnableSso_RequestSyntax) **   <a name="DirectoryService-EnableSso-request-UserName"></a>
The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.  
If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the *UserName* and *Password* parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z0-9._-]+`   
Required: No

## Response Elements
<a name="API_EnableSso_ResponseElements"></a>

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

## Errors
<a name="API_EnableSso_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthenticationFailedException **   
An authentication error occurred.    
 ** Message **   
The textual message for the exception.  
 ** RequestId **   
The identifier of the request that caused the exception.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InsufficientPermissionsException **   
The account does not have sufficient permission to perform the operation.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_EnableSso_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_EnableSso_Example_1"></a>

This example illustrates one usage of EnableSso.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 80
X-Amz-Target: DirectoryService_20150416.EnableSso
X-Amz-Date: 20161214T220301Z
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/20161214/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=88acc99818605aa438eb86b5be59daecce370c7db16e5e84311508e575ea0515

 {
   "UserName": "Admin",
   "DirectoryId": "d-926example",
   "Password": "Str0ngP@ssw0rd"
 }
```

### Example Response
<a name="API_EnableSso_Example_2"></a>

This example illustrates one usage of EnableSso.

```
HTTP/1.1 200 OK
x-amzn-RequestId: fcd40ac9-c247-11e6-a7ca-f9a52a6a0390
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Wed, 14 Dec 2016 22:03:03 GMT

{  
  
}
```

## See Also
<a name="API_EnableSso_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/EnableSso) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/EnableSso) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/EnableSso) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/EnableSso) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/EnableSso) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/EnableSso) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/EnableSso) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/EnableSso) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/EnableSso) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/EnableSso) 

# GetDirectoryLimits
<a name="API_GetDirectoryLimits"></a>

Obtains directory limit information for the current Region.

## Response Syntax
<a name="API_GetDirectoryLimits_ResponseSyntax"></a>

```
{
   "DirectoryLimits": { 
      "CloudOnlyDirectoriesCurrentCount": number,
      "CloudOnlyDirectoriesLimit": number,
      "CloudOnlyDirectoriesLimitReached": boolean,
      "CloudOnlyMicrosoftADCurrentCount": number,
      "CloudOnlyMicrosoftADLimit": number,
      "CloudOnlyMicrosoftADLimitReached": boolean,
      "ConnectedDirectoriesCurrentCount": number,
      "ConnectedDirectoriesLimit": number,
      "ConnectedDirectoriesLimitReached": boolean
   }
}
```

## Response Elements
<a name="API_GetDirectoryLimits_ResponseElements"></a>

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

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

 ** [DirectoryLimits](#API_GetDirectoryLimits_ResponseSyntax) **   <a name="DirectoryService-GetDirectoryLimits-response-DirectoryLimits"></a>
A [DirectoryLimits](API_DirectoryLimits.md) object that contains the directory limits for the current Region.  
Type: [DirectoryLimits](API_DirectoryLimits.md) object

## Errors
<a name="API_GetDirectoryLimits_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_GetDirectoryLimits_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_GetDirectoryLimits_Example_1"></a>

This example illustrates one usage of GetDirectoryLimits.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: DirectoryService_20150416.GetDirectoryLimits
X-Amz-Date: 20161214T223512Z
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/20161214/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=550da3fb7986c02e54cb35d644fd6601bfe823c3956e9471308682df2c1977ac

 {

 }
```

### Example Response
<a name="API_GetDirectoryLimits_Example_2"></a>

This example illustrates one usage of GetDirectoryLimits.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 9526b149-c24d-11e6-bc3e-5ffd5f600cd8
Content-Type: application/x-amz-json-1.1
Content-Length: 348
Date: Wed, 14 Dec 2016 22:35:14 GMT

{
   "DirectoryLimits":{
      "CloudOnlyDirectoriesCurrentCount":2,
      "CloudOnlyDirectoriesLimit":10,
      "CloudOnlyDirectoriesLimitReached":false,
      "CloudOnlyMicrosoftADCurrentCount":2,
      "CloudOnlyMicrosoftADLimit":10,
      "CloudOnlyMicrosoftADLimitReached":false,
      "ConnectedDirectoriesCurrentCount":1,
      "ConnectedDirectoriesLimit":10,
      "ConnectedDirectoriesLimitReached":false
   }
}
```

## See Also
<a name="API_GetDirectoryLimits_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/GetDirectoryLimits) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/GetDirectoryLimits) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/GetDirectoryLimits) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/GetDirectoryLimits) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/GetDirectoryLimits) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/GetDirectoryLimits) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/GetDirectoryLimits) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/GetDirectoryLimits) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/GetDirectoryLimits) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/GetDirectoryLimits) 

# GetSnapshotLimits
<a name="API_GetSnapshotLimits"></a>

Obtains the manual snapshot limits for a directory.

## Request Syntax
<a name="API_GetSnapshotLimits_RequestSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_GetSnapshotLimits_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_GetSnapshotLimits_RequestSyntax) **   <a name="DirectoryService-GetSnapshotLimits-request-DirectoryId"></a>
Contains the identifier of the directory to obtain the limits for.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Syntax
<a name="API_GetSnapshotLimits_ResponseSyntax"></a>

```
{
   "SnapshotLimits": { 
      "ManualSnapshotsCurrentCount": number,
      "ManualSnapshotsLimit": number,
      "ManualSnapshotsLimitReached": boolean
   }
}
```

## Response Elements
<a name="API_GetSnapshotLimits_ResponseElements"></a>

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

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

 ** [SnapshotLimits](#API_GetSnapshotLimits_ResponseSyntax) **   <a name="DirectoryService-GetSnapshotLimits-response-SnapshotLimits"></a>
A [SnapshotLimits](API_SnapshotLimits.md) object that contains the manual snapshot limits for the specified directory.  
Type: [SnapshotLimits](API_SnapshotLimits.md) object

## Errors
<a name="API_GetSnapshotLimits_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_GetSnapshotLimits_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_GetSnapshotLimits_Example_1"></a>

This example illustrates one usage of GetSnapshotLimits.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 31
X-Amz-Target: DirectoryService_20150416.GetSnapshotLimits
X-Amz-Date: 20161214T224507Z
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/20161214/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=f9ba790cf905e14fa97fd1ed6a961c72d83a23f3e54ab126d8e4a30ec14d3cdb

 {
   "DirectoryId": "d-926example"
 }
```

### Example Response
<a name="API_GetSnapshotLimits_Example_2"></a>

This example illustrates one usage of GetSnapshotLimits.

```
HTTP/1.1 200 OK
x-amzn-RequestId: f7895979-c24e-11e6-a0ba-6bb2a89ebc49
Content-Type: application/x-amz-json-1.1
Content-Length: 113
Date: Wed, 14 Dec 2016 22:45:09 GMT

{
   "SnapshotLimits":{
      "ManualSnapshotsCurrentCount":1,
      "ManualSnapshotsLimit":5,
      "ManualSnapshotsLimitReached":false
   }
}
```

## See Also
<a name="API_GetSnapshotLimits_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/GetSnapshotLimits) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/GetSnapshotLimits) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/GetSnapshotLimits) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/GetSnapshotLimits) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/GetSnapshotLimits) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/GetSnapshotLimits) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/GetSnapshotLimits) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/GetSnapshotLimits) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/GetSnapshotLimits) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/GetSnapshotLimits) 

# ListADAssessments
<a name="API_ListADAssessments"></a>

Retrieves a list of directory assessments for the specified directory or all assessments in your account. Use this operation to monitor assessment status and manage multiple assessments.

## Request Syntax
<a name="API_ListADAssessments_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Limit": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListADAssessments_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_ListADAssessments_RequestSyntax) **   <a name="DirectoryService-ListADAssessments-request-DirectoryId"></a>
The identifier of the directory for which to list assessments. If not specified, all assessments in your account are returned.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: No

 ** [Limit](#API_ListADAssessments_RequestSyntax) **   <a name="DirectoryService-ListADAssessments-request-Limit"></a>
The maximum number of assessment summaries to return.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListADAssessments_RequestSyntax) **   <a name="DirectoryService-ListADAssessments-request-NextToken"></a>
The pagination token from a previous request to [ListADAssessments](#API_ListADAssessments). Pass null if this is the first request.  
Type: String  
Required: No

## Response Syntax
<a name="API_ListADAssessments_ResponseSyntax"></a>

```
{
   "Assessments": [ 
      { 
         "AssessmentId": "string",
         "CustomerDnsIps": [ "string" ],
         "DirectoryId": "string",
         "DnsName": "string",
         "LastUpdateDateTime": number,
         "ReportType": "string",
         "StartTime": number,
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListADAssessments_ResponseElements"></a>

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

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

 ** [Assessments](#API_ListADAssessments_ResponseSyntax) **   <a name="DirectoryService-ListADAssessments-response-Assessments"></a>
A list of assessment summaries containing basic information about each directory assessment.  
Type: Array of [AssessmentSummary](API_AssessmentSummary.md) objects

 ** [NextToken](#API_ListADAssessments_ResponseSyntax) **   <a name="DirectoryService-ListADAssessments-response-NextToken"></a>
If not null, more results are available. Pass this value for the `NextToken` parameter in a subsequent request to retrieve the next set of items.  
Type: String

## Errors
<a name="API_ListADAssessments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_ListADAssessments_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_ListADAssessments_Example_1"></a>

This example illustrates one usage of ListADAssessments.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 75
X-Amz-Target: DirectoryService_20150416.ListADAssessments
X-Amz-Date: 20231212T212029Z
User-Agent: aws-cli/2.0.0 Python/3.8.0 Linux/5.4.0 botocore/2.0.0
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
 Credential=AKIAI7E3BYXS3example/20231212/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

{
    "DirectoryId": "d-926example"
}
```

### Example Response
<a name="API_ListADAssessments_Example_2"></a>

This example illustrates one usage of ListADAssessments.

```
HTTP/1.1 200 OK
x-amzn-RequestId: cfc1cbc8-c0b0-11e6-aa44-41d91ee57463
Content-Type: application/x-amz-json-1.1
Content-Length: 524
Date: Mon, 12 Dec 2023 21:20:31 GMT

{
    "Assessments": [{
            "AssessmentId": "da-1234567890example1",
            "DirectoryId": "d-926example",
            "DnsName": "ad.example.com",
            "StartTime": "2025-06-15T23:21:49.074000-04:00",
            "LastUpdateDateTime": "2025-06-16T16:42:54.861000-04:00",
            "Status": "SUCCESS",
            "CustomerDnsIps": [
                "10.24.34.100",
                "10.24.34.200"
            ],
            "ReportType": "SYSTEM"
        },
        {
            "AssessmentId": "da-09876543210example2",
            "DirectoryId": "d-926example",
            "DnsName": "ad.example.com",
            "StartTime": "2025-06-10T14:28:54.934000-04:00",
            "LastUpdateDateTime": "2025-06-10T14:55:52.197000-04:00",
            "Status": "FAILED",
            "CustomerDnsIps": [
                "10.24.34.100",
                "10.24.34.200"
            ],
            "ReportType": "CUSTOMER"
        }
    ]
}
```

## See Also
<a name="API_ListADAssessments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/ListADAssessments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/ListADAssessments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/ListADAssessments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/ListADAssessments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/ListADAssessments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/ListADAssessments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/ListADAssessments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/ListADAssessments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/ListADAssessments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/ListADAssessments) 

# ListCertificates
<a name="API_ListCertificates"></a>

For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.

## Request Syntax
<a name="API_ListCertificates_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Limit": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListCertificates_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_ListCertificates_RequestSyntax) **   <a name="DirectoryService-ListCertificates-request-DirectoryId"></a>
The identifier of the directory.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [Limit](#API_ListCertificates_RequestSyntax) **   <a name="DirectoryService-ListCertificates-request-Limit"></a>
The number of items that should show up on one page  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListCertificates_RequestSyntax) **   <a name="DirectoryService-ListCertificates-request-NextToken"></a>
A token for requesting another page of certificates if the `NextToken` response element indicates that more certificates are available. Use the value of the returned `NextToken` element in your request until the token comes back as `null`. Pass `null` if this is the first call.  
Type: String  
Required: No

## Response Syntax
<a name="API_ListCertificates_ResponseSyntax"></a>

```
{
   "CertificatesInfo": [ 
      { 
         "CertificateId": "string",
         "CommonName": "string",
         "ExpiryDateTime": number,
         "State": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListCertificates_ResponseElements"></a>

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

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

 ** [CertificatesInfo](#API_ListCertificates_ResponseSyntax) **   <a name="DirectoryService-ListCertificates-response-CertificatesInfo"></a>
A list of certificates with basic details including certificate ID, certificate common name, certificate state.  
Type: Array of [CertificateInfo](API_CertificateInfo.md) objects

 ** [NextToken](#API_ListCertificates_ResponseSyntax) **   <a name="DirectoryService-ListCertificates-response-NextToken"></a>
Indicates whether another page of certificates is available when the number of available certificates exceeds the page limit.  
Type: String

## Errors
<a name="API_ListCertificates_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_ListCertificates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/ListCertificates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/ListCertificates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/ListCertificates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/ListCertificates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/ListCertificates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/ListCertificates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/ListCertificates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/ListCertificates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/ListCertificates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/ListCertificates) 

# ListIpRoutes
<a name="API_ListIpRoutes"></a>

Lists the address blocks that you have added to a directory.

## Request Syntax
<a name="API_ListIpRoutes_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Limit": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListIpRoutes_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_ListIpRoutes_RequestSyntax) **   <a name="DirectoryService-ListIpRoutes-request-DirectoryId"></a>
Identifier (ID) of the directory for which you want to retrieve the IP addresses.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [Limit](#API_ListIpRoutes_RequestSyntax) **   <a name="DirectoryService-ListIpRoutes-request-Limit"></a>
Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [NextToken](#API_ListIpRoutes_RequestSyntax) **   <a name="DirectoryService-ListIpRoutes-request-NextToken"></a>
The *ListIpRoutes.NextToken* value from a previous call to [ListIpRoutes](#API_ListIpRoutes). Pass null if this is the first call.  
Type: String  
Required: No

## Response Syntax
<a name="API_ListIpRoutes_ResponseSyntax"></a>

```
{
   "IpRoutesInfo": [ 
      { 
         "AddedDateTime": number,
         "CidrIp": "string",
         "CidrIpv6": "string",
         "Description": "string",
         "DirectoryId": "string",
         "IpRouteStatusMsg": "string",
         "IpRouteStatusReason": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListIpRoutes_ResponseElements"></a>

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

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

 ** [IpRoutesInfo](#API_ListIpRoutes_ResponseSyntax) **   <a name="DirectoryService-ListIpRoutes-response-IpRoutesInfo"></a>
A list of [IpRoute](API_IpRoute.md)s.  
Type: Array of [IpRouteInfo](API_IpRouteInfo.md) objects

 ** [NextToken](#API_ListIpRoutes_ResponseSyntax) **   <a name="DirectoryService-ListIpRoutes-response-NextToken"></a>
If not null, more results are available. Pass this value for the *NextToken* parameter in a subsequent call to [ListIpRoutes](#API_ListIpRoutes) to retrieve the next set of items.  
Type: String

## Errors
<a name="API_ListIpRoutes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_ListIpRoutes_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_ListIpRoutes_Example_1"></a>

This example illustrates one usage of ListIpRoutes.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 43
X-Amz-Target: DirectoryService_20150416.ListIpRoutes
X-Amz-Date: 20161214T225328Z
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/20161214/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=4dcb72aae179937790f5b061ceb1c697ac434b27891014b609671e49e52be1dd

 {
   "DirectoryId":"d-926example",
   "Limit": 0
 }
```

### Example Response
<a name="API_ListIpRoutes_Example_2"></a>

This example illustrates one usage of ListIpRoutes.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 2214ceaa-c250-11e6-a7ca-f9a52a6a0390
Content-Type: application/x-amz-json-1.1
Content-Length: 155
Date: Wed, 14 Dec 2016 22:53:30 GMT

{
   "IpRoutesInfo":[
      {
         "AddedDateTime":1.48157763163E9,
         "CidrIp":"12.12.12.12/32",
         "Description":"example",
         "DirectoryId":"d-926example",
         "IpRouteStatusMsg":"Added"
      }
   ]
}
```

## See Also
<a name="API_ListIpRoutes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/ListIpRoutes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/ListIpRoutes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/ListIpRoutes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/ListIpRoutes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/ListIpRoutes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/ListIpRoutes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/ListIpRoutes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/ListIpRoutes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/ListIpRoutes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/ListIpRoutes) 

# ListLogSubscriptions
<a name="API_ListLogSubscriptions"></a>

Lists the active log subscriptions for the AWS account.

## Request Syntax
<a name="API_ListLogSubscriptions_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Limit": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListLogSubscriptions_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_ListLogSubscriptions_RequestSyntax) **   <a name="DirectoryService-ListLogSubscriptions-request-DirectoryId"></a>
If a *DirectoryID* is provided, lists only the log subscription associated with that directory. If no *DirectoryId* is provided, lists all log subscriptions associated with your AWS account. If there are no log subscriptions for the AWS account or the directory, an empty list will be returned.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: No

 ** [Limit](#API_ListLogSubscriptions_RequestSyntax) **   <a name="DirectoryService-ListLogSubscriptions-request-Limit"></a>
The maximum number of items returned.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [NextToken](#API_ListLogSubscriptions_RequestSyntax) **   <a name="DirectoryService-ListLogSubscriptions-request-NextToken"></a>
The token for the next set of items to return.  
Type: String  
Required: No

## Response Syntax
<a name="API_ListLogSubscriptions_ResponseSyntax"></a>

```
{
   "LogSubscriptions": [ 
      { 
         "DirectoryId": "string",
         "LogGroupName": "string",
         "SubscriptionCreatedDateTime": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListLogSubscriptions_ResponseElements"></a>

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

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

 ** [LogSubscriptions](#API_ListLogSubscriptions_ResponseSyntax) **   <a name="DirectoryService-ListLogSubscriptions-response-LogSubscriptions"></a>
A list of active [LogSubscription](API_LogSubscription.md) objects for calling the AWS account.  
Type: Array of [LogSubscription](API_LogSubscription.md) objects

 ** [NextToken](#API_ListLogSubscriptions_ResponseSyntax) **   <a name="DirectoryService-ListLogSubscriptions-response-NextToken"></a>
The token for the next set of items to return.  
Type: String

## Errors
<a name="API_ListLogSubscriptions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## See Also
<a name="API_ListLogSubscriptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/ListLogSubscriptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/ListLogSubscriptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/ListLogSubscriptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/ListLogSubscriptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/ListLogSubscriptions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/ListLogSubscriptions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/ListLogSubscriptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/ListLogSubscriptions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/ListLogSubscriptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/ListLogSubscriptions) 

# ListSchemaExtensions
<a name="API_ListSchemaExtensions"></a>

Lists all schema extensions applied to a Microsoft AD Directory.

## Request Syntax
<a name="API_ListSchemaExtensions_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Limit": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListSchemaExtensions_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_ListSchemaExtensions_RequestSyntax) **   <a name="DirectoryService-ListSchemaExtensions-request-DirectoryId"></a>
The identifier of the directory from which to retrieve the schema extension information.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [Limit](#API_ListSchemaExtensions_RequestSyntax) **   <a name="DirectoryService-ListSchemaExtensions-request-Limit"></a>
The maximum number of items to return.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [NextToken](#API_ListSchemaExtensions_RequestSyntax) **   <a name="DirectoryService-ListSchemaExtensions-request-NextToken"></a>
The `ListSchemaExtensions.NextToken` value from a previous call to `ListSchemaExtensions`. Pass null if this is the first call.  
Type: String  
Required: No

## Response Syntax
<a name="API_ListSchemaExtensions_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "SchemaExtensionsInfo": [ 
      { 
         "Description": "string",
         "DirectoryId": "string",
         "EndDateTime": number,
         "SchemaExtensionId": "string",
         "SchemaExtensionStatus": "string",
         "SchemaExtensionStatusReason": "string",
         "StartDateTime": number
      }
   ]
}
```

## Response Elements
<a name="API_ListSchemaExtensions_ResponseElements"></a>

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

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

 ** [NextToken](#API_ListSchemaExtensions_ResponseSyntax) **   <a name="DirectoryService-ListSchemaExtensions-response-NextToken"></a>
If not null, more results are available. Pass this value for the `NextToken` parameter in a subsequent call to `ListSchemaExtensions` to retrieve the next set of items.  
Type: String

 ** [SchemaExtensionsInfo](#API_ListSchemaExtensions_ResponseSyntax) **   <a name="DirectoryService-ListSchemaExtensions-response-SchemaExtensionsInfo"></a>
Information about the schema extensions applied to the directory.  
Type: Array of [SchemaExtensionInfo](API_SchemaExtensionInfo.md) objects

## Errors
<a name="API_ListSchemaExtensions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_ListSchemaExtensions_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_ListSchemaExtensions_Example_1"></a>

This example illustrates one usage of ListSchemaExtensions.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 43
X-Amz-Target: DirectoryService_20150416.ListSchemaExtensions
X-Amz-Date: 20161214T230332Z
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/20161214/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=39aa3aec95444a9bf6dff7fc57d3178c9364b5d2fd560380e8fbc6eee13b3cf1

 {
   "DirectoryId": "d-926example", 
   "Limit": 0
 }
```

### Example Response
<a name="API_ListSchemaExtensions_Example_2"></a>

This example illustrates one usage of ListSchemaExtensions.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 89f9aea0-c251-11e6-b0d6-83af322c90cd
Content-Type: application/x-amz-json-1.1
Content-Length: 333
Date: Wed, 14 Dec 2016 23:03:34 GMT

{
   "SchemaExtensionsInfo":[
      {
         "Description":"example text",
         "DirectoryId":"d-926example",
         "EndDateTime":1.481586088301E9,
         "SchemaExtensionId":"e-926731d2a0",
         "SchemaExtensionStatus":"Cancelled",
         "SchemaExtensionStatusReason":"Cancellation is complete. No schema updates were applied to your directory.",
         "StartDateTime":1.481584463548E9
      }
   ]
}
```

## See Also
<a name="API_ListSchemaExtensions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/ListSchemaExtensions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/ListSchemaExtensions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/ListSchemaExtensions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/ListSchemaExtensions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/ListSchemaExtensions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/ListSchemaExtensions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/ListSchemaExtensions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/ListSchemaExtensions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/ListSchemaExtensions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/ListSchemaExtensions) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Lists all tags on a directory.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "Limit": number,
   "NextToken": "string",
   "ResourceId": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [Limit](#API_ListTagsForResource_RequestSyntax) **   <a name="DirectoryService-ListTagsForResource-request-Limit"></a>
Reserved for future use.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [NextToken](#API_ListTagsForResource_RequestSyntax) **   <a name="DirectoryService-ListTagsForResource-request-NextToken"></a>
Reserved for future use.  
Type: String  
Required: No

 ** [ResourceId](#API_ListTagsForResource_RequestSyntax) **   <a name="DirectoryService-ListTagsForResource-request-ResourceId"></a>
Identifier (ID) of the directory for which you want to retrieve tags.  
Type: String  
Pattern: `^[d]-[0-9a-f]{10}$`   
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

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

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

 ** [NextToken](#API_ListTagsForResource_ResponseSyntax) **   <a name="DirectoryService-ListTagsForResource-response-NextToken"></a>
Reserved for future use.  
Type: String

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="DirectoryService-ListTagsForResource-response-Tags"></a>
List of tags returned by the ListTagsForResource operation.  
Type: Array of [Tag](API_Tag.md) objects

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The `NextToken` value is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_ListTagsForResource_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_ListTagsForResource_Example_1"></a>

This example illustrates one usage of ListTagsForResource.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 42
X-Amz-Target: DirectoryService_20150416.ListTagsForResource
X-Amz-Date: 20161214T231352Z
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/20161214/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=72d8e8988d5a206b4e218f406544b06cb4f6fd9d8927a270317509c9861b0826

 {  
   "ResourceId":"d-926example",
   "Limit": 0
 }
```

### Example Response
<a name="API_ListTagsForResource_Example_2"></a>

This example illustrates one usage of ListTagsForResource.

```
HTTP/1.1 200 OK
x-amzn-RequestId: fb7da12c-c252-11e6-a96d-2b0686697d23
Content-Type: application/x-amz-json-1.1
Content-Length: 53
Date: Wed, 14 Dec 2016 23:13:54 GMT

{
   "Tags":[
      {
         "Key":"environment",
         "Value":"production"
      }
   ]
}
```

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/ListTagsForResource) 

# RegisterCertificate
<a name="API_RegisterCertificate"></a>

Registers a certificate for a secure LDAP or client certificate authentication.

## Request Syntax
<a name="API_RegisterCertificate_RequestSyntax"></a>

```
{
   "CertificateData": "string",
   "ClientCertAuthSettings": { 
      "OCSPUrl": "string"
   },
   "DirectoryId": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_RegisterCertificate_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [CertificateData](#API_RegisterCertificate_RequestSyntax) **   <a name="DirectoryService-RegisterCertificate-request-CertificateData"></a>
The certificate PEM string that needs to be registered.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: Yes

 ** [ClientCertAuthSettings](#API_RegisterCertificate_RequestSyntax) **   <a name="DirectoryService-RegisterCertificate-request-ClientCertAuthSettings"></a>
A `ClientCertAuthSettings` object that contains client certificate authentication settings.  
Type: [ClientCertAuthSettings](API_ClientCertAuthSettings.md) object  
Required: No

 ** [DirectoryId](#API_RegisterCertificate_RequestSyntax) **   <a name="DirectoryService-RegisterCertificate-request-DirectoryId"></a>
The identifier of the directory.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [Type](#API_RegisterCertificate_RequestSyntax) **   <a name="DirectoryService-RegisterCertificate-request-Type"></a>
The function that the registered certificate performs. Valid values include `ClientLDAPS` or `ClientCertAuth`. The default value is `ClientLDAPS`.  
Type: String  
Valid Values: `ClientCertAuth | ClientLDAPS`   
Required: No

## Response Syntax
<a name="API_RegisterCertificate_ResponseSyntax"></a>

```
{
   "CertificateId": "string"
}
```

## Response Elements
<a name="API_RegisterCertificate_ResponseElements"></a>

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

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

 ** [CertificateId](#API_RegisterCertificate_ResponseSyntax) **   <a name="DirectoryService-RegisterCertificate-response-CertificateId"></a>
The identifier of the certificate.  
Type: String  
Pattern: `^c-[0-9a-f]{10}$` 

## Errors
<a name="API_RegisterCertificate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CertificateAlreadyExistsException **   
The certificate has already been registered into the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** CertificateLimitExceededException **   
The certificate could not be added because the certificate limit has been reached.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidCertificateException **   
The certificate PEM that was provided has incorrect encoding.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_RegisterCertificate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/RegisterCertificate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/RegisterCertificate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/RegisterCertificate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/RegisterCertificate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/RegisterCertificate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/RegisterCertificate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/RegisterCertificate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/RegisterCertificate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/RegisterCertificate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/RegisterCertificate) 

# RegisterEventTopic
<a name="API_RegisterEventTopic"></a>

Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.

## Request Syntax
<a name="API_RegisterEventTopic_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "TopicName": "string"
}
```

## Request Parameters
<a name="API_RegisterEventTopic_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_RegisterEventTopic_RequestSyntax) **   <a name="DirectoryService-RegisterEventTopic-request-DirectoryId"></a>
The Directory ID that will publish status messages to the Amazon SNS topic.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [TopicName](#API_RegisterEventTopic_RequestSyntax) **   <a name="DirectoryService-RegisterEventTopic-request-TopicName"></a>
The Amazon SNS topic name to which the directory will publish status messages. This Amazon SNS topic must be in the same region as the specified Directory ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

## Response Elements
<a name="API_RegisterEventTopic_ResponseElements"></a>

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

## Errors
<a name="API_RegisterEventTopic_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_RegisterEventTopic_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_RegisterEventTopic_Example_1"></a>

This example illustrates one usage of RegisterEventTopic.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 63
X-Amz-Target: DirectoryService_20150416.RegisterEventTopic
X-Amz-Date: 20161214T232258Z
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/20161214/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=6e1e2996789f568cf057fa66e70b1ba114d7388510787be6092055ab97a07828

 {
   "DirectoryId": "d-926example",
   "TopicName": "snstopicexample"
 }
```

### Example Response
<a name="API_RegisterEventTopic_Example_2"></a>

This example illustrates one usage of RegisterEventTopic.

```
HTTP/1.1 200 OK
x-amzn-RequestId: a68a1e79-c19b-11e6-870b-c3330207df37
Content-Type: application/x-amz-json-1.1
Content-Length: 29
Date: Wed, 14 Dec 2016 23:23:01 GMT

{  
  
}
```

## See Also
<a name="API_RegisterEventTopic_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/RegisterEventTopic) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/RegisterEventTopic) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/RegisterEventTopic) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/RegisterEventTopic) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/RegisterEventTopic) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/RegisterEventTopic) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/RegisterEventTopic) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/RegisterEventTopic) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/RegisterEventTopic) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/RegisterEventTopic) 

# RejectSharedDirectory
<a name="API_RejectSharedDirectory"></a>

Rejects a directory sharing request that was sent from the directory owner account.

## Request Syntax
<a name="API_RejectSharedDirectory_RequestSyntax"></a>

```
{
   "SharedDirectoryId": "string"
}
```

## Request Parameters
<a name="API_RejectSharedDirectory_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [SharedDirectoryId](#API_RejectSharedDirectory_RequestSyntax) **   <a name="DirectoryService-RejectSharedDirectory-request-SharedDirectoryId"></a>
Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Syntax
<a name="API_RejectSharedDirectory_ResponseSyntax"></a>

```
{
   "SharedDirectoryId": "string"
}
```

## Response Elements
<a name="API_RejectSharedDirectory_ResponseElements"></a>

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

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

 ** [SharedDirectoryId](#API_RejectSharedDirectory_ResponseSyntax) **   <a name="DirectoryService-RejectSharedDirectory-response-SharedDirectoryId"></a>
Identifier of the shared directory in the directory consumer account.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$` 

## Errors
<a name="API_RejectSharedDirectory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryAlreadySharedException **   
The specified directory has already been shared with this AWS account.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## See Also
<a name="API_RejectSharedDirectory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/RejectSharedDirectory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/RejectSharedDirectory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/RejectSharedDirectory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/RejectSharedDirectory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/RejectSharedDirectory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/RejectSharedDirectory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/RejectSharedDirectory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/RejectSharedDirectory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/RejectSharedDirectory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/RejectSharedDirectory) 

# RemoveIpRoutes
<a name="API_RemoveIpRoutes"></a>

Removes IP address blocks from a directory.

## Request Syntax
<a name="API_RemoveIpRoutes_RequestSyntax"></a>

```
{
   "CidrIps": [ "string" ],
   "CidrIpv6s": [ "string" ],
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_RemoveIpRoutes_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [CidrIps](#API_RemoveIpRoutes_RequestSyntax) **   <a name="DirectoryService-RemoveIpRoutes-request-CidrIps"></a>
IP address blocks that you want to remove.  
Type: Array of strings  
Pattern: `^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([1-9]|[1-2][0-9]|3[0-2]))$`   
Required: No

 ** [CidrIpv6s](#API_RemoveIpRoutes_RequestSyntax) **   <a name="DirectoryService-RemoveIpRoutes-request-CidrIpv6s"></a>
IPv6 address blocks that you want to remove.  
Type: Array of strings  
Pattern: `^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){1,7}:)|(([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2})|(([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3})|(([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4})|(([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5})|([0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))|(:((:[0-9a-fA-F]{1,4}){1,7}|:)))\/(12[0-8]|1[01][0-9]|[1-9]?[0-9])$`   
Required: No

 ** [DirectoryId](#API_RemoveIpRoutes_RequestSyntax) **   <a name="DirectoryService-RemoveIpRoutes-request-DirectoryId"></a>
Identifier (ID) of the directory from which you want to remove the IP addresses.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Elements
<a name="API_RemoveIpRoutes_ResponseElements"></a>

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

## Errors
<a name="API_RemoveIpRoutes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_RemoveIpRoutes_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_RemoveIpRoutes_Example_1"></a>

This example illustrates one usage of RemoveIpRoutes.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 62
X-Amz-Target: DirectoryService_20150416.RemoveIpRoutes
X-Amz-Date: 20161214T233152Z
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/20161214/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=b3413802dda807a99b3a5783eef6fc3599eefa200820af9842cc5b24becb1802

 {
   "DirectoryId":"d-926example",
   "CidrIps": ["12.12.12.12/32"]
 }
```

### Example Response
<a name="API_RemoveIpRoutes_Example_2"></a>

This example illustrates one usage of RemoveIpRoutes.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 7f62aa28-c255-11e6-b3d3-bf8f15b8b2ee
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Wed, 14 Dec 2016 23:31:54 GMT

{

}
```

## See Also
<a name="API_RemoveIpRoutes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/RemoveIpRoutes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/RemoveIpRoutes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/RemoveIpRoutes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/RemoveIpRoutes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/RemoveIpRoutes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/RemoveIpRoutes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/RemoveIpRoutes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/RemoveIpRoutes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/RemoveIpRoutes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/RemoveIpRoutes) 

# RemoveRegion
<a name="API_RemoveRegion"></a>

Stops all replication and removes the domain controllers from the specified Region. You cannot remove the primary Region with this operation. Instead, use the `DeleteDirectory` API.

## Request Syntax
<a name="API_RemoveRegion_RequestSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_RemoveRegion_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_RemoveRegion_RequestSyntax) **   <a name="DirectoryService-RemoveRegion-request-DirectoryId"></a>
The identifier of the directory for which you want to remove Region replication.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Elements
<a name="API_RemoveRegion_ResponseElements"></a>

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

## Errors
<a name="API_RemoveRegion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_RemoveRegion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/RemoveRegion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/RemoveRegion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/RemoveRegion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/RemoveRegion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/RemoveRegion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/RemoveRegion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/RemoveRegion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/RemoveRegion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/RemoveRegion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/RemoveRegion) 

# RemoveTagsFromResource
<a name="API_RemoveTagsFromResource"></a>

Removes tags from a directory.

## Request Syntax
<a name="API_RemoveTagsFromResource_RequestSyntax"></a>

```
{
   "ResourceId": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_RemoveTagsFromResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ResourceId](#API_RemoveTagsFromResource_RequestSyntax) **   <a name="DirectoryService-RemoveTagsFromResource-request-ResourceId"></a>
Identifier (ID) of the directory from which to remove the tag.  
Type: String  
Pattern: `^[d]-[0-9a-f]{10}$`   
Required: Yes

 ** [TagKeys](#API_RemoveTagsFromResource_RequestSyntax) **   <a name="DirectoryService-RemoveTagsFromResource-request-TagKeys"></a>
The tag key (name) of the tag to be removed.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## Response Elements
<a name="API_RemoveTagsFromResource_ResponseElements"></a>

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

## Errors
<a name="API_RemoveTagsFromResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_RemoveTagsFromResource_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_RemoveTagsFromResource_Example_1"></a>

This example illustrates one usage of RemoveTagsFromResource.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 58
X-Amz-Target: DirectoryService_20150416.RemoveTagsFromResource
X-Amz-Date: 20161214T234556Z
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/20161214/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=707f9d53696de7adc446b3bd54404571011febc29e9b76c6aed793767639bf47

 {  
   "ResourceId":"d-926example",
   "TagKeys": ["environment"]
 }
```

### Example Response
<a name="API_RemoveTagsFromResource_Example_2"></a>

This example illustrates one usage of RemoveTagsFromResource.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 767374a0-c257-11e6-ad7a-a9557d30f017
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Wed, 14 Dec 2016 23:45:58 GMT

{
   
}
```

## See Also
<a name="API_RemoveTagsFromResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/RemoveTagsFromResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/RemoveTagsFromResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/RemoveTagsFromResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/RemoveTagsFromResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/RemoveTagsFromResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/RemoveTagsFromResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/RemoveTagsFromResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/RemoveTagsFromResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/RemoveTagsFromResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/RemoveTagsFromResource) 

# ResetUserPassword
<a name="API_ResetUserPassword"></a>

Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory. Disabled users will become enabled and can be authenticated following the API call.

You can reset the password for any user in your directory with the following exceptions:
+ For Simple AD, you cannot reset the password for any user that is a member of either the **Domain Admins** or **Enterprise Admins** group except for the administrator user.
+ For AWS Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the ** AWS Reserved** OU. For more information about the OU structure for an AWS Managed Microsoft AD directory, see [What Gets Created](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_getting_started_what_gets_created.html) in the * AWS Directory Service Administration Guide*.

## Request Syntax
<a name="API_ResetUserPassword_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "NewPassword": "string",
   "UserName": "string"
}
```

## Request Parameters
<a name="API_ResetUserPassword_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_ResetUserPassword_RequestSyntax) **   <a name="DirectoryService-ResetUserPassword-request-DirectoryId"></a>
Identifier of the AWS Managed Microsoft AD or Simple AD directory in which the user resides.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [NewPassword](#API_ResetUserPassword_RequestSyntax) **   <a name="DirectoryService-ResetUserPassword-request-NewPassword"></a>
The new password that will be reset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: Yes

 ** [UserName](#API_ResetUserPassword_RequestSyntax) **   <a name="DirectoryService-ResetUserPassword-request-UserName"></a>
The user name of the user whose password will be reset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^(?!.*\\|.*"|.*\/|.*\[|.*\]|.*:|.*;|.*\||.*=|.*,|.*\+|.*\*|.*\?|.*<|.*>|.*@).*$`   
Required: Yes

## Response Elements
<a name="API_ResetUserPassword_ResponseElements"></a>

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

## Errors
<a name="API_ResetUserPassword_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidPasswordException **   
The new password provided by the user does not meet the password complexity requirements defined in your directory.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** UserDoesNotExistException **   
The user provided a username that does not exist in your directory.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_ResetUserPassword_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/ResetUserPassword) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/ResetUserPassword) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/ResetUserPassword) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/ResetUserPassword) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/ResetUserPassword) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/ResetUserPassword) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/ResetUserPassword) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/ResetUserPassword) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/ResetUserPassword) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/ResetUserPassword) 

# RestoreFromSnapshot
<a name="API_RestoreFromSnapshot"></a>

Restores a directory using an existing directory snapshot.

When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.

This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the [DescribeDirectories](API_DescribeDirectories.md) operation with the directory identifier. When the **DirectoryDescription.Stage** value changes to `Active`, the restore operation is complete.

## Request Syntax
<a name="API_RestoreFromSnapshot_RequestSyntax"></a>

```
{
   "SnapshotId": "string"
}
```

## Request Parameters
<a name="API_RestoreFromSnapshot_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [SnapshotId](#API_RestoreFromSnapshot_RequestSyntax) **   <a name="DirectoryService-RestoreFromSnapshot-request-SnapshotId"></a>
The identifier of the snapshot to restore from.  
Type: String  
Pattern: `^s-[0-9a-f]{10}$`   
Required: Yes

## Response Elements
<a name="API_RestoreFromSnapshot_ResponseElements"></a>

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

## Errors
<a name="API_RestoreFromSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_RestoreFromSnapshot_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_RestoreFromSnapshot_Example_1"></a>

This example illustrates one usage of RestoreFromSnapshot.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 30
X-Amz-Target: DirectoryService_20150416.RestoreFromSnapshot
X-Amz-Date: 20161214T235310Z
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/20161214/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=5c6be5a543a9df855e15ed75c131318330c4acf9b791515e8b3524e2430c180f

 {
   "SnapshotId": "s-9267f6da4e"
 }
```

### Example Response
<a name="API_RestoreFromSnapshot_Example_2"></a>

This example illustrates one usage of RestoreFromSnapshot.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 78ebab96-c258-11e6-a4dc-e5519684970a
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Wed, 14 Dec 2016 23:53:12 GMT

{

}
```

## See Also
<a name="API_RestoreFromSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/RestoreFromSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/RestoreFromSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/RestoreFromSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/RestoreFromSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/RestoreFromSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/RestoreFromSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/RestoreFromSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/RestoreFromSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/RestoreFromSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/RestoreFromSnapshot) 

# ShareDirectory
<a name="API_ShareDirectory"></a>

Shares a specified directory (`DirectoryId`) in your AWS account (directory owner) with another AWS account (directory consumer). With this operation you can use your directory from any AWS account and from any Amazon VPC within an AWS Region.

When you share your AWS Managed Microsoft AD directory, AWS Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.

The `ShareMethod` parameter determines whether the specified directory can be shared between AWS accounts inside the same AWS organization (`ORGANIZATIONS`). It also determines whether you can share the directory with any other AWS account either inside or outside of the organization (`HANDSHAKE`).

The `ShareNotes` parameter is only used when `HANDSHAKE` is called, which sends a directory sharing request to the directory consumer. 

## Request Syntax
<a name="API_ShareDirectory_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "ShareMethod": "string",
   "ShareNotes": "string",
   "ShareTarget": { 
      "Id": "string",
      "Type": "string"
   }
}
```

## Request Parameters
<a name="API_ShareDirectory_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_ShareDirectory_RequestSyntax) **   <a name="DirectoryService-ShareDirectory-request-DirectoryId"></a>
Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [ShareMethod](#API_ShareDirectory_RequestSyntax) **   <a name="DirectoryService-ShareDirectory-request-ShareMethod"></a>
The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (`ORGANIZATIONS`) or with any AWS account by sending a directory sharing request (`HANDSHAKE`).  
Type: String  
Valid Values: `ORGANIZATIONS | HANDSHAKE`   
Required: Yes

 ** [ShareNotes](#API_ShareDirectory_RequestSyntax) **   <a name="DirectoryService-ShareDirectory-request-ShareNotes"></a>
A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [ShareTarget](#API_ShareDirectory_RequestSyntax) **   <a name="DirectoryService-ShareDirectory-request-ShareTarget"></a>
Identifier for the directory consumer account with whom the directory is to be shared.  
Type: [ShareTarget](API_ShareTarget.md) object  
Required: Yes

## Response Syntax
<a name="API_ShareDirectory_ResponseSyntax"></a>

```
{
   "SharedDirectoryId": "string"
}
```

## Response Elements
<a name="API_ShareDirectory_ResponseElements"></a>

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

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

 ** [SharedDirectoryId](#API_ShareDirectory_ResponseSyntax) **   <a name="DirectoryService-ShareDirectory-response-SharedDirectoryId"></a>
Identifier of the directory that is stored in the directory consumer account that is shared from the specified directory (`DirectoryId`).  
Type: String  
Pattern: `^d-[0-9a-f]{10}$` 

## Errors
<a name="API_ShareDirectory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryAlreadySharedException **   
The specified directory has already been shared with this AWS account.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidTargetException **   
The specified shared target is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** OrganizationsException **   
Exception encountered while trying to access your AWS organization.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** ShareLimitExceededException **   
The maximum number of AWS accounts that you can share with this directory has been reached.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_ShareDirectory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/ShareDirectory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/ShareDirectory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/ShareDirectory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/ShareDirectory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/ShareDirectory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/ShareDirectory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/ShareDirectory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/ShareDirectory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/ShareDirectory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/ShareDirectory) 

# StartADAssessment
<a name="API_StartADAssessment"></a>

Initiates a directory assessment to validate your self-managed AD environment for hybrid domain join. The assessment checks compatibility and connectivity of the self-managed AD environment.

A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: `CUSTOMER` and `SYSTEM`. Your AWS account has a limit of 100 `CUSTOMER` directory assessments.

The assessment process typically takes 30 minutes or more to complete. The assessment process is asynchronous and you can monitor it with `DescribeADAssessment`.

The `InstanceIds` must have a one-to-one correspondence with `CustomerDnsIps`, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410].

Note: You must provide exactly one `DirectoryId` or `AssessmentConfiguration`.

## Request Syntax
<a name="API_StartADAssessment_RequestSyntax"></a>

```
{
   "AssessmentConfiguration": { 
      "CustomerDnsIps": [ "string" ],
      "DnsName": "string",
      "InstanceIds": [ "string" ],
      "SecurityGroupIds": [ "string" ],
      "VpcSettings": { 
         "SubnetIds": [ "string" ],
         "VpcId": "string"
      }
   },
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_StartADAssessment_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AssessmentConfiguration](#API_StartADAssessment_RequestSyntax) **   <a name="DirectoryService-StartADAssessment-request-AssessmentConfiguration"></a>
Configuration parameters for the directory assessment, including DNS server information, domain name, Amazon VPC subnet, and AWS System Manager managed node details.  
Type: [AssessmentConfiguration](API_AssessmentConfiguration.md) object  
Required: No

 ** [DirectoryId](#API_StartADAssessment_RequestSyntax) **   <a name="DirectoryService-StartADAssessment-request-DirectoryId"></a>
The identifier of the directory for which to perform the assessment. This should be an existing directory. If the assessment is not for an existing directory, this parameter should be omitted.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: No

## Response Syntax
<a name="API_StartADAssessment_ResponseSyntax"></a>

```
{
   "AssessmentId": "string"
}
```

## Response Elements
<a name="API_StartADAssessment_ResponseElements"></a>

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

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

 ** [AssessmentId](#API_StartADAssessment_ResponseSyntax) **   <a name="DirectoryService-StartADAssessment-response-AssessmentId"></a>
The unique identifier of the newly started directory assessment. Use this identifier to monitor assessment progress and retrieve results.  
Type: String  
Pattern: `^da-[0-9a-f]{18}$` 

## Errors
<a name="API_StartADAssessment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ADAssessmentLimitExceededException **   
A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: `CUSTOMER` and `SYSTEM`. Your AWS account has a limit of 100 `CUSTOMER` directory assessments.  
If you attempt to create a hybrid directory; and you already have 100 `CUSTOMER` directory assessments;, you will encounter an error. Delete assessments to free up capacity before trying again.  
You can request an increase to your `CUSTOMER` directory assessment quota by contacting customer support or delete existing CUSTOMER directory assessments; to free up capacity.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_StartADAssessment_Examples"></a>

The following examples are formatted for legibility.

### Example Pre-join Request
<a name="API_StartADAssessment_Example_1"></a>

This example illustrates one usage of StartADAssessment.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 312
X-Amz-Target: DirectoryService_20150416.StartADAssessment
X-Amz-Date: 20231212T212029Z
User-Agent: aws-cli/2.0.0 Python/3.8.0 Linux/5.4.0 botocore/2.0.0
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
 Credential=AKIAI7E3BYXS3example/20231212/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
// Request - prejoin
{
    "AssessmentConfiguration": {
        "CustomerDnsIps": ["10.24.34.100", "10.24.34.200"],
        "DnsName": "ad.example.com",
        "VpcSettings": {
            "VpcId": "vpc-04c978example126f",
            "SubnetIds": ["subnet-0994bexampled9ea7", "subnet-095e06examplee7e7"]
        },
        "InstanceIds": ["i-10243410", "i-10243420"],
        "SecurityGroupIds": ["sg-0fbb77examplef199"]
    }
}
```

### Example Post-join Request
<a name="API_StartADAssessment_Example_2"></a>

This example illustrates one usage of StartADAssessment.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 312
X-Amz-Target: DirectoryService_20150416.StartADAssessment
X-Amz-Date: 20231212T212029Z
User-Agent: aws-cli/2.0.0 Python/3.8.0 Linux/5.4.0 botocore/2.0.0
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
 Credential=AKIAI7E3BYXS3example/20231212/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

// Request - postjoin
{
    "DirectoryId": "d-926example"
}
```

### Example Response
<a name="API_StartADAssessment_Example_3"></a>

This example illustrates one usage of StartADAssessment.

```
HTTP/1.1 200 OK
x-amzn-RequestId: cfc1cbc8-c0b0-11e6-aa44-41d91ee57463
Content-Type: application/x-amz-json-1.1
Content-Length: 45
Date: Mon, 12 Dec 2023 21:20:31 GMT

{
    "AssessmentId": "da-1234567890example1"
}
```

## See Also
<a name="API_StartADAssessment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/StartADAssessment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/StartADAssessment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/StartADAssessment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/StartADAssessment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/StartADAssessment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/StartADAssessment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/StartADAssessment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/StartADAssessment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/StartADAssessment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/StartADAssessment) 

# StartSchemaExtension
<a name="API_StartSchemaExtension"></a>

Applies a schema extension to a Microsoft AD directory.

## Request Syntax
<a name="API_StartSchemaExtension_RequestSyntax"></a>

```
{
   "CreateSnapshotBeforeSchemaExtension": boolean,
   "Description": "string",
   "DirectoryId": "string",
   "LdifContent": "string"
}
```

## Request Parameters
<a name="API_StartSchemaExtension_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [CreateSnapshotBeforeSchemaExtension](#API_StartSchemaExtension_RequestSyntax) **   <a name="DirectoryService-StartSchemaExtension-request-CreateSnapshotBeforeSchemaExtension"></a>
If true, creates a snapshot of the directory before applying the schema extension.  
Type: Boolean  
Required: Yes

 ** [Description](#API_StartSchemaExtension_RequestSyntax) **   <a name="DirectoryService-StartSchemaExtension-request-Description"></a>
A description of the schema extension.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$`   
Required: Yes

 ** [DirectoryId](#API_StartSchemaExtension_RequestSyntax) **   <a name="DirectoryService-StartSchemaExtension-request-DirectoryId"></a>
The identifier of the directory for which the schema extension will be applied to.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [LdifContent](#API_StartSchemaExtension_RequestSyntax) **   <a name="DirectoryService-StartSchemaExtension-request-LdifContent"></a>
The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \$1n. See the example request below for more details. The file size can be no larger than 1MB.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500000.  
Required: Yes

## Response Syntax
<a name="API_StartSchemaExtension_ResponseSyntax"></a>

```
{
   "SchemaExtensionId": "string"
}
```

## Response Elements
<a name="API_StartSchemaExtension_ResponseElements"></a>

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

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

 ** [SchemaExtensionId](#API_StartSchemaExtension_ResponseSyntax) **   <a name="DirectoryService-StartSchemaExtension-response-SchemaExtensionId"></a>
The identifier of the schema extension that will be applied.  
Type: String  
Pattern: `^e-[0-9a-f]{10}$` 

## Errors
<a name="API_StartSchemaExtension_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** SnapshotLimitExceededException **   
The maximum number of manual snapshots for the directory has been reached. You can use the [GetSnapshotLimits](API_GetSnapshotLimits.md) operation to determine the snapshot limits for a directory.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_StartSchemaExtension_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_StartSchemaExtension_Example_1"></a>

This example illustrates one usage of StartSchemaExtension.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 320
X-Amz-Target: DirectoryService_20150416.StartSchemaExtension
X-Amz-Date: 20161219T190703Z
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/20161219/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=5c1200f494c1771770d7aa964e45ee36d80e724e0d9a8e62ab9822574c8cc915

 {
   "CreateSnapshotBeforeSchemaExtension":true,
   "DirectoryId":"d-926example",
   "LdifContent":"dn: CN=User,CN=Schema,CN=Configuration,DC=sales,DC=example,DC=com\nchangetype: modify\nadd: mayContain\nmayContain: drink\n-\n\nDN:\nchangetype: modify\nreplace: schemaupdatenow\nschemaupdatenow: 1\n-",
   "Description":"Adds may contain attribute to user class. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \n. For example the LdifContent string above is formatted the following way in an Ldif file:

     dn: CN=User,CN=Schema,CN=Configuration,DC=sales,DC=example,DC=com
     changetype: modify
     add: mayContain
     mayContain: drink
     -

     dn:
     changetype: modify
     replace: schemaupdatenow
     schemaupdatenow: 1
     -"
 }
```

### Example Response
<a name="API_StartSchemaExtension_Example_2"></a>

This example illustrates one usage of StartSchemaExtension.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 54723d00-c61e-11e6-a96d-2b0686697d23
Content-Type: application/x-amz-json-1.1
Content-Length: 36
Date: Mon, 19 Dec 2016 19:07:04 GMT

{
  "SchemaExtensionId": "e-926731dc50"
}
```

## See Also
<a name="API_StartSchemaExtension_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/StartSchemaExtension) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/StartSchemaExtension) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/StartSchemaExtension) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/StartSchemaExtension) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/StartSchemaExtension) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/StartSchemaExtension) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/StartSchemaExtension) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/StartSchemaExtension) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/StartSchemaExtension) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/StartSchemaExtension) 

# UnshareDirectory
<a name="API_UnshareDirectory"></a>

Stops the directory sharing between the directory owner and consumer accounts. 

## Request Syntax
<a name="API_UnshareDirectory_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "UnshareTarget": { 
      "Id": "string",
      "Type": "string"
   }
}
```

## Request Parameters
<a name="API_UnshareDirectory_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_UnshareDirectory_RequestSyntax) **   <a name="DirectoryService-UnshareDirectory-request-DirectoryId"></a>
The identifier of the AWS Managed Microsoft AD directory that you want to stop sharing.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [UnshareTarget](#API_UnshareDirectory_RequestSyntax) **   <a name="DirectoryService-UnshareDirectory-request-UnshareTarget"></a>
Identifier for the directory consumer account with whom the directory has to be unshared.  
Type: [UnshareTarget](API_UnshareTarget.md) object  
Required: Yes

## Response Syntax
<a name="API_UnshareDirectory_ResponseSyntax"></a>

```
{
   "SharedDirectoryId": "string"
}
```

## Response Elements
<a name="API_UnshareDirectory_ResponseElements"></a>

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

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

 ** [SharedDirectoryId](#API_UnshareDirectory_ResponseSyntax) **   <a name="DirectoryService-UnshareDirectory-response-SharedDirectoryId"></a>
Identifier of the directory stored in the directory consumer account that is to be unshared from the specified directory (`DirectoryId`).  
Type: String  
Pattern: `^d-[0-9a-f]{10}$` 

## Errors
<a name="API_UnshareDirectory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryNotSharedException **   
The specified directory has not been shared with this AWS account.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidTargetException **   
The specified shared target is not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## See Also
<a name="API_UnshareDirectory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/UnshareDirectory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/UnshareDirectory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/UnshareDirectory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/UnshareDirectory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/UnshareDirectory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/UnshareDirectory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/UnshareDirectory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/UnshareDirectory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/UnshareDirectory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/UnshareDirectory) 

# UpdateConditionalForwarder
<a name="API_UpdateConditionalForwarder"></a>

Updates a conditional forwarder that has been set up for your AWS directory.

## Request Syntax
<a name="API_UpdateConditionalForwarder_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "DnsIpAddrs": [ "string" ],
   "DnsIpv6Addrs": [ "string" ],
   "RemoteDomainName": "string"
}
```

## Request Parameters
<a name="API_UpdateConditionalForwarder_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_UpdateConditionalForwarder_RequestSyntax) **   <a name="DirectoryService-UpdateConditionalForwarder-request-DirectoryId"></a>
The directory ID of the AWS directory for which to update the conditional forwarder.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [DnsIpAddrs](#API_UpdateConditionalForwarder_RequestSyntax) **   <a name="DirectoryService-UpdateConditionalForwarder-request-DnsIpAddrs"></a>
The updated IP addresses of the remote DNS server associated with the conditional forwarder.  
Type: Array of strings  
Pattern: `^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$`   
Required: No

 ** [DnsIpv6Addrs](#API_UpdateConditionalForwarder_RequestSyntax) **   <a name="DirectoryService-UpdateConditionalForwarder-request-DnsIpv6Addrs"></a>
The updated IPv6 addresses of the remote DNS server associated with the conditional forwarder.  
Type: Array of strings  
Pattern: `^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$`   
Required: No

 ** [RemoteDomainName](#API_UpdateConditionalForwarder_RequestSyntax) **   <a name="DirectoryService-UpdateConditionalForwarder-request-RemoteDomainName"></a>
The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+[.]?$`   
Required: Yes

## Response Elements
<a name="API_UpdateConditionalForwarder_ResponseElements"></a>

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

## Errors
<a name="API_UpdateConditionalForwarder_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_UpdateConditionalForwarder_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_UpdateConditionalForwarder_Example_1"></a>

This example illustrates one usage of UpdateConditionalForwarder.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 107
X-Amz-Target: DirectoryService_20150416.UpdateConditionalForwarder
X-Amz-Date: 20161215T183823Z
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/20161215/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=84648cead858ef1efd7db75ce248aa3e22a78139b109eec6122dc3c495b71085

 {
   "DirectoryId":"d-926example",
   "RemoteDomainName":"sales.example.com",
   "DnsIpAddrs": ["172.168.101.11"]
 }
```

### Example Response
<a name="API_UpdateConditionalForwarder_Example_2"></a>

This example illustrates one usage of UpdateConditionalForwarder.

```
HTTP/1.1 200 OK
x-amzn-RequestId: aa015a05-c2f5-11e6-b3d3-bf8f15b8b2ee
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Thu, 15 Dec 2016 18:38:27 GMT

 {

 }
```

## See Also
<a name="API_UpdateConditionalForwarder_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/UpdateConditionalForwarder) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/UpdateConditionalForwarder) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/UpdateConditionalForwarder) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/UpdateConditionalForwarder) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/UpdateConditionalForwarder) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/UpdateConditionalForwarder) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/UpdateConditionalForwarder) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/UpdateConditionalForwarder) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/UpdateConditionalForwarder) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/UpdateConditionalForwarder) 

# UpdateDirectorySetup
<a name="API_UpdateDirectorySetup"></a>

Updates directory configuration for the specified update type.

## Request Syntax
<a name="API_UpdateDirectorySetup_RequestSyntax"></a>

```
{
   "CreateSnapshotBeforeUpdate": boolean,
   "DirectoryId": "string",
   "DirectorySizeUpdateSettings": { 
      "DirectorySize": "string"
   },
   "NetworkUpdateSettings": { 
      "CustomerDnsIpsV6": [ "string" ],
      "NetworkType": "string"
   },
   "OSUpdateSettings": { 
      "OSVersion": "string"
   },
   "UpdateType": "string"
}
```

## Request Parameters
<a name="API_UpdateDirectorySetup_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [CreateSnapshotBeforeUpdate](#API_UpdateDirectorySetup_RequestSyntax) **   <a name="DirectoryService-UpdateDirectorySetup-request-CreateSnapshotBeforeUpdate"></a>
Specifies whether to create a directory snapshot before performing the update.  
Type: Boolean  
Required: No

 ** [DirectoryId](#API_UpdateDirectorySetup_RequestSyntax) **   <a name="DirectoryService-UpdateDirectorySetup-request-DirectoryId"></a>
The identifier of the directory to update.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [DirectorySizeUpdateSettings](#API_UpdateDirectorySetup_RequestSyntax) **   <a name="DirectoryService-UpdateDirectorySetup-request-DirectorySizeUpdateSettings"></a>
Directory size configuration to apply during the update operation.  
Type: [DirectorySizeUpdateSettings](API_DirectorySizeUpdateSettings.md) object  
Required: No

 ** [NetworkUpdateSettings](#API_UpdateDirectorySetup_RequestSyntax) **   <a name="DirectoryService-UpdateDirectorySetup-request-NetworkUpdateSettings"></a>
Network configuration to apply during the directory update operation.  
Type: [NetworkUpdateSettings](API_NetworkUpdateSettings.md) object  
Required: No

 ** [OSUpdateSettings](#API_UpdateDirectorySetup_RequestSyntax) **   <a name="DirectoryService-UpdateDirectorySetup-request-OSUpdateSettings"></a>
Operating system configuration to apply during the directory update operation.  
Type: [OSUpdateSettings](API_OSUpdateSettings.md) object  
Required: No

 ** [UpdateType](#API_UpdateDirectorySetup_RequestSyntax) **   <a name="DirectoryService-UpdateDirectorySetup-request-UpdateType"></a>
The type of update to perform on the directory.  
Type: String  
Valid Values: `OS | NETWORK | SIZE`   
Required: Yes

## Response Elements
<a name="API_UpdateDirectorySetup_ResponseElements"></a>

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

## Errors
<a name="API_UpdateDirectorySetup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryInDesiredStateException **   
 The directory is already updated to desired update type settings.     
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** SnapshotLimitExceededException **   
The maximum number of manual snapshots for the directory has been reached. You can use the [GetSnapshotLimits](API_GetSnapshotLimits.md) operation to determine the snapshot limits for a directory.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_UpdateDirectorySetup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/UpdateDirectorySetup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/UpdateDirectorySetup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/UpdateDirectorySetup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/UpdateDirectorySetup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/UpdateDirectorySetup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/UpdateDirectorySetup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/UpdateDirectorySetup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/UpdateDirectorySetup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/UpdateDirectorySetup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/UpdateDirectorySetup) 

# UpdateHybridAD
<a name="API_UpdateHybridAD"></a>

Updates the configuration of an existing hybrid directory. You can recover hybrid directory administrator account or modify self-managed instance settings.

Updates are applied asynchronously. Use [DescribeHybridADUpdate](API_DescribeHybridADUpdate.md) to monitor the progress of configuration changes.

The `InstanceIds` must have a one-to-one correspondence with `CustomerDnsIps`, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410].

**Note**  
You must provide at least one update to [UpdateHybridAD:HybridAdministratorAccountUpdate](#DirectoryService-UpdateHybridAD-request-HybridAdministratorAccountUpdate) or [UpdateHybridAD:SelfManagedInstancesSettings](#DirectoryService-UpdateHybridAD-request-SelfManagedInstancesSettings).

## Request Syntax
<a name="API_UpdateHybridAD_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "HybridAdministratorAccountUpdate": { 
      "SecretArn": "string"
   },
   "SelfManagedInstancesSettings": { 
      "CustomerDnsIps": [ "string" ],
      "InstanceIds": [ "string" ]
   }
}
```

## Request Parameters
<a name="API_UpdateHybridAD_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_UpdateHybridAD_RequestSyntax) **   <a name="DirectoryService-UpdateHybridAD-request-DirectoryId"></a>
The identifier of the hybrid directory to update.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [HybridAdministratorAccountUpdate](#API_UpdateHybridAD_RequestSyntax) **   <a name="DirectoryService-UpdateHybridAD-request-HybridAdministratorAccountUpdate"></a>
We create a hybrid directory administrator account when we create a hybrid directory. Use `HybridAdministratorAccountUpdate` to recover the hybrid directory administrator account if you have deleted it.  
To recover your hybrid directory administrator account, we need temporary access to a user in your self-managed AD with administrator permissions in the form of a secret from AWS Secrets Manager. We use these credentials once during recovery and don't store them.  
If your hybrid directory administrator account exists, then you don’t need to use `HybridAdministratorAccountUpdate`, even if you have updated your self-managed AD administrator user.  
Type: [HybridAdministratorAccountUpdate](API_HybridAdministratorAccountUpdate.md) object  
Required: No

 ** [SelfManagedInstancesSettings](#API_UpdateHybridAD_RequestSyntax) **   <a name="DirectoryService-UpdateHybridAD-request-SelfManagedInstancesSettings"></a>
Updates to the self-managed AD configuration, including DNS server IP addresses and AWS System Manager managed node identifiers.  
Type: [HybridCustomerInstancesSettings](API_HybridCustomerInstancesSettings.md) object  
Required: No

## Response Syntax
<a name="API_UpdateHybridAD_ResponseSyntax"></a>

```
{
   "AssessmentId": "string",
   "DirectoryId": "string"
}
```

## Response Elements
<a name="API_UpdateHybridAD_ResponseElements"></a>

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

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

 ** [AssessmentId](#API_UpdateHybridAD_ResponseSyntax) **   <a name="DirectoryService-UpdateHybridAD-response-AssessmentId"></a>
The identifier of the assessment performed to validate the update configuration. This assessment ensures the updated settings are compatible with your environment.  
Type: String  
Pattern: `^da-[0-9a-f]{18}$` 

 ** [DirectoryId](#API_UpdateHybridAD_ResponseSyntax) **   <a name="DirectoryService-UpdateHybridAD-response-DirectoryId"></a>
The identifier of the updated hybrid directory.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$` 

## Errors
<a name="API_UpdateHybridAD_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ADAssessmentLimitExceededException **   
A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: `CUSTOMER` and `SYSTEM`. Your AWS account has a limit of 100 `CUSTOMER` directory assessments.  
If you attempt to create a hybrid directory; and you already have 100 `CUSTOMER` directory assessments;, you will encounter an error. Delete assessments to free up capacity before trying again.  
You can request an increase to your `CUSTOMER` directory assessment quota by contacting customer support or delete existing CUSTOMER directory assessments; to free up capacity.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_UpdateHybridAD_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_UpdateHybridAD_Example_1"></a>

This example illustrates one usage of UpdateHybridAD.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 245
X-Amz-Target: DirectoryService_20150416.UpdateHybridAD
X-Amz-Date: 20231212T212029Z
User-Agent: aws-cli/2.0.0 Python/3.8.0 Linux/5.4.0 botocore/2.0.0
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
 Credential=AKIAI7E3BYXS3example/20231212/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

{
    "DirectoryId": d-926example,
    "HybridAdministratorAccountUpdate": {
        "SecretArn": "arn:aws:secretsmanager:eu-west-1:111122223333:secret:CredExample-DZESji"
    },
    "SelfManagedInstancesSettings": {
        "CustomerDnsIps": ["10.24.34.100", "10.24.34.200"],
        "InstanceIds": ["i-10243410", "i-10243420"],
    }
}
```

### Example Response
<a name="API_UpdateHybridAD_Example_2"></a>

This example illustrates one usage of UpdateHybridAD.

```
HTTP/1.1 200 OK
x-amzn-RequestId: cfc1cbc8-c0b0-11e6-aa44-41d91ee57463
Content-Type: application/x-amz-json-1.1
Content-Length: 75
Date: Mon, 12 Dec 2023 21:20:31 GMT

{
    "DirectoryId": "d-926example",
    "AssessmentId": "da-1234567890example1"
}
```

## See Also
<a name="API_UpdateHybridAD_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/UpdateHybridAD) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/UpdateHybridAD) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/UpdateHybridAD) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/UpdateHybridAD) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/UpdateHybridAD) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/UpdateHybridAD) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/UpdateHybridAD) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/UpdateHybridAD) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/UpdateHybridAD) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/UpdateHybridAD) 

# UpdateNumberOfDomainControllers
<a name="API_UpdateNumberOfDomainControllers"></a>

Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.

## Request Syntax
<a name="API_UpdateNumberOfDomainControllers_RequestSyntax"></a>

```
{
   "DesiredNumber": number,
   "DirectoryId": "string"
}
```

## Request Parameters
<a name="API_UpdateNumberOfDomainControllers_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DesiredNumber](#API_UpdateNumberOfDomainControllers_RequestSyntax) **   <a name="DirectoryService-UpdateNumberOfDomainControllers-request-DesiredNumber"></a>
The number of domain controllers desired in the directory.  
Type: Integer  
Valid Range: Minimum value of 2.  
Required: Yes

 ** [DirectoryId](#API_UpdateNumberOfDomainControllers_RequestSyntax) **   <a name="DirectoryService-UpdateNumberOfDomainControllers-request-DirectoryId"></a>
Identifier of the directory to which the domain controllers will be added or removed.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

## Response Elements
<a name="API_UpdateNumberOfDomainControllers_ResponseElements"></a>

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

## Errors
<a name="API_UpdateNumberOfDomainControllers_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DomainControllerLimitExceededException **   
The maximum allowed number of domain controllers per directory was exceeded. The default limit per directory is 20 domain controllers.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_UpdateNumberOfDomainControllers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/UpdateNumberOfDomainControllers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/UpdateNumberOfDomainControllers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/UpdateNumberOfDomainControllers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/UpdateNumberOfDomainControllers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/UpdateNumberOfDomainControllers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/UpdateNumberOfDomainControllers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/UpdateNumberOfDomainControllers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/UpdateNumberOfDomainControllers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/UpdateNumberOfDomainControllers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/UpdateNumberOfDomainControllers) 

# UpdateRadius
<a name="API_UpdateRadius"></a>

Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.

## Request Syntax
<a name="API_UpdateRadius_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "RadiusSettings": { 
      "AuthenticationProtocol": "string",
      "DisplayLabel": "string",
      "RadiusPort": number,
      "RadiusRetries": number,
      "RadiusServers": [ "string" ],
      "RadiusServersIpv6": [ "string" ],
      "RadiusTimeout": number,
      "SharedSecret": "string",
      "UseSameUsername": boolean
   }
}
```

## Request Parameters
<a name="API_UpdateRadius_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_UpdateRadius_RequestSyntax) **   <a name="DirectoryService-UpdateRadius-request-DirectoryId"></a>
The identifier of the directory for which to update the RADIUS server information.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [RadiusSettings](#API_UpdateRadius_RequestSyntax) **   <a name="DirectoryService-UpdateRadius-request-RadiusSettings"></a>
A [RadiusSettings](API_RadiusSettings.md) object that contains information about the RADIUS server.  
Type: [RadiusSettings](API_RadiusSettings.md) object  
Required: Yes

## Response Elements
<a name="API_UpdateRadius_ResponseElements"></a>

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

## Errors
<a name="API_UpdateRadius_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## Examples
<a name="API_UpdateRadius_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_UpdateRadius_Example_1"></a>

This example illustrates one usage of UpdateRadius.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 262
X-Amz-Target: DirectoryService_20150416.UpdateRadius
X-Amz-Date: 20161215T184937Z
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/20161215/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=6cc8097b61ad0ee23e166193d317a066feeea582d252b57923a0781dc011a686

 {
   "DirectoryId":"d-926example",
   "RadiusSettings":{
      "DisplayLabel":"MyRadius",
      "UseSameUsername":true,
      "RadiusTimeout":1,
      "AuthenticationProtocol":"PAP",
      "RadiusPort":1027,
      "RadiusRetries":1,
      "SharedSecret":"12345678",
      "RadiusServers":[
         "172.168.101.113"
      ]
   }
 }
```

### Example Response
<a name="API_UpdateRadius_Example_2"></a>

This example illustrates one usage of UpdateRadius.

```
HTTP/1.1 200 OK
x-amzn-RequestId: fcd40ac9-c247-11e6-a7ca-f9a52a6a0390
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Thu, 15 Dec 2016 18:49:39 GMT

{

}
```

## See Also
<a name="API_UpdateRadius_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/UpdateRadius) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/UpdateRadius) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/UpdateRadius) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/UpdateRadius) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/UpdateRadius) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/UpdateRadius) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/UpdateRadius) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/UpdateRadius) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/UpdateRadius) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/UpdateRadius) 

# UpdateSettings
<a name="API_UpdateSettings"></a>

Updates the configurable settings for the specified directory.

## Request Syntax
<a name="API_UpdateSettings_RequestSyntax"></a>

```
{
   "DirectoryId": "string",
   "Settings": [ 
      { 
         "Name": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_UpdateSettings_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DirectoryId](#API_UpdateSettings_RequestSyntax) **   <a name="DirectoryService-UpdateSettings-request-DirectoryId"></a>
The identifier of the directory for which to update settings.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$`   
Required: Yes

 ** [Settings](#API_UpdateSettings_RequestSyntax) **   <a name="DirectoryService-UpdateSettings-request-Settings"></a>
The list of [Setting](API_Setting.md) objects.  
Type: Array of [Setting](API_Setting.md) objects  
Required: Yes

## Response Syntax
<a name="API_UpdateSettings_ResponseSyntax"></a>

```
{
   "DirectoryId": "string"
}
```

## Response Elements
<a name="API_UpdateSettings_ResponseElements"></a>

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

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

 ** [DirectoryId](#API_UpdateSettings_ResponseSyntax) **   <a name="DirectoryService-UpdateSettings-response-DirectoryId"></a>
The identifier of the directory.  
Type: String  
Pattern: `^d-[0-9a-f]{10}$` 

## Errors
<a name="API_UpdateSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryDoesNotExistException **   
The specified directory does not exist in the system.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** DirectoryUnavailableException **   
The specified directory is unavailable.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** IncompatibleSettingsException **   
The specified directory setting is not compatible with other settings.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** UnsupportedSettingsException **   
The specified directory setting is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## See Also
<a name="API_UpdateSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/UpdateSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/UpdateSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/UpdateSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/UpdateSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/UpdateSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/UpdateSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/UpdateSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/UpdateSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/UpdateSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/UpdateSettings) 

# UpdateTrust
<a name="API_UpdateTrust"></a>

Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an self-managed Active Directory.

## Request Syntax
<a name="API_UpdateTrust_RequestSyntax"></a>

```
{
   "SelectiveAuth": "string",
   "TrustId": "string"
}
```

## Request Parameters
<a name="API_UpdateTrust_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [SelectiveAuth](#API_UpdateTrust_RequestSyntax) **   <a name="DirectoryService-UpdateTrust-request-SelectiveAuth"></a>
Updates selective authentication for the trust.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: No

 ** [TrustId](#API_UpdateTrust_RequestSyntax) **   <a name="DirectoryService-UpdateTrust-request-TrustId"></a>
Identifier of the trust relationship.  
Type: String  
Pattern: `^t-[0-9a-f]{10}$`   
Required: Yes

## Response Syntax
<a name="API_UpdateTrust_ResponseSyntax"></a>

```
{
   "RequestId": "string",
   "TrustId": "string"
}
```

## Response Elements
<a name="API_UpdateTrust_ResponseElements"></a>

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

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

 ** [RequestId](#API_UpdateTrust_ResponseSyntax) **   <a name="DirectoryService-UpdateTrust-response-RequestId"></a>
The AWS request identifier.  
Type: String  
Pattern: `^([A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12})$` 

 ** [TrustId](#API_UpdateTrust_ResponseSyntax) **   <a name="DirectoryService-UpdateTrust-response-TrustId"></a>
Identifier of the trust relationship.  
Type: String  
Pattern: `^t-[0-9a-f]{10}$` 

## Errors
<a name="API_UpdateTrust_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

## See Also
<a name="API_UpdateTrust_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/UpdateTrust) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/UpdateTrust) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/UpdateTrust) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/UpdateTrust) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/UpdateTrust) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/UpdateTrust) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/UpdateTrust) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/UpdateTrust) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/UpdateTrust) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/UpdateTrust) 

# VerifyTrust
<a name="API_VerifyTrust"></a>

 AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain.

## Request Syntax
<a name="API_VerifyTrust_RequestSyntax"></a>

```
{
   "TrustId": "string"
}
```

## Request Parameters
<a name="API_VerifyTrust_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [TrustId](#API_VerifyTrust_RequestSyntax) **   <a name="DirectoryService-VerifyTrust-request-TrustId"></a>
The unique Trust ID of the trust relationship to verify.  
Type: String  
Pattern: `^t-[0-9a-f]{10}$`   
Required: Yes

## Response Syntax
<a name="API_VerifyTrust_ResponseSyntax"></a>

```
{
   "TrustId": "string"
}
```

## Response Elements
<a name="API_VerifyTrust_ResponseElements"></a>

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

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

 ** [TrustId](#API_VerifyTrust_ResponseSyntax) **   <a name="DirectoryService-VerifyTrust-response-TrustId"></a>
The unique Trust ID of the trust relationship that was verified.  
Type: String  
Pattern: `^t-[0-9a-f]{10}$` 

## Errors
<a name="API_VerifyTrust_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClientException **   
A client exception has occurred.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** EntityDoesNotExistException **   
The specified entity could not be found.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

 ** ServiceException **   
An exception has occurred in AWS Directory Service.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 500

 ** UnsupportedOperationException **   
The operation is not supported.    
 ** Message **   
The descriptive message for the exception.  
 ** RequestId **   
The AWS request identifier.
HTTP Status Code: 400

## Examples
<a name="API_VerifyTrust_Examples"></a>

The following examples are formatted for legibility.

### Example Request
<a name="API_VerifyTrust_Example_1"></a>

This example illustrates one usage of VerifyTrust.

```
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 27
X-Amz-Target: DirectoryService_20150416.VerifyTrust
X-Amz-Date: 20161215T191010Z
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/20161215/us-west-2/ds/aws4_request,
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,
 Signature=249c3fb0ac94d57cc9abb43f6422fe237fce723ddd9462a4666712e46e3b5371

 {
   "TrustId": "t-9267353df0"
 }
```

### Example Response
<a name="API_VerifyTrust_Example_2"></a>

This example illustrates one usage of VerifyTrust.

```
HTTP/1.1 200 OK
x-amzn-RequestId: 3343bc79-c18f-11e6-ba7f-e33ae22bc363
Content-Type: application/x-amz-json-1.1
Content-Length: 26
Date: Thu, 15 Dec 2016 19:10:12 GMT

{
   "TrustId": "t-9267353df0"
}
```

## See Also
<a name="API_VerifyTrust_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ds-2015-04-16/VerifyTrust) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ds-2015-04-16/VerifyTrust) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/VerifyTrust) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/VerifyTrust) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/VerifyTrust) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/VerifyTrust) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/VerifyTrust) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/VerifyTrust) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/VerifyTrust) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/VerifyTrust)