Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeHybridADUpdate

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


{
   "DirectoryId": "string",
   "NextToken": "string",
   "UpdateType": "string"
}

Request Parameters

The request accepts the following data in JSON format.

DirectoryId

The identifier of the hybrid directory for which to retrieve update information.

Type: String

Pattern: ^d-[0-9a-f]{10}$

Required: Yes

NextToken

The pagination token from a previous request to DescribeHybridADUpdate. Pass null if this is the first request.

Type: String

Required: No

UpdateType

The type of update activities to retrieve. Valid values include SelfManagedInstances and HybridAdministratorAccount.

Type: String

Valid Values: SelfManagedInstances | HybridAdministratorAccount

Required: No

Response Syntax


{
   "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

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

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

Information about update activities for the hybrid directory, organized by update type.

Type: HybridUpdateActivities object

Errors

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

ClientException

A client exception has occurred.

HTTP Status Code: 400

DirectoryDoesNotExistException

The specified directory does not exist in the system.

HTTP Status Code: 400

InvalidNextTokenException

The NextToken value is not valid.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 400

ServiceException

An exception has occurred in AWS Directory Service.

HTTP Status Code: 500

UnsupportedOperationException

The operation is not supported.

HTTP Status Code: 400

Examples

The following examples are formatted for legibility.

Example Request

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

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"
            }
        ]
    }
}