AWS directoryservice documentation change
Summary
Added new API documentation for DescribeHybridADUpdate operation which retrieves update activity details for hybrid directories including administrator account changes and self-managed instance settings
Security assessment
The change documents a new API that provides visibility into administrator account updates and instance configuration changes - critical security-related activities. While this improves audit capabilities, there is no evidence it addresses a specific existing vulnerability.
Diff
diff --git a/directoryservice/latest/devguide/API_DescribeHybridADUpdate.md b/directoryservice/latest/devguide/API_DescribeHybridADUpdate.md index 8b1378917..16d2fe2ba 100644 --- a//directoryservice/latest/devguide/API_DescribeHybridADUpdate.md +++ b//directoryservice/latest/devguide/API_DescribeHybridADUpdate.md @@ -0,0 +1 @@ +[](/pdfs/directoryservice/latest/devguide/directoryservice-api.pdf#API_DescribeHybridADUpdate "Open PDF") @@ -1,0 +3,263 @@ +[Documentation](/index.html)[AWS Directory Service](/directory-service/index.html)[API Reference](welcome.html) + +Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsExamplesSee 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](./API_DescribeHybridADUpdate.html). 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](./API_HybridUpdateActivities.html#DirectoryService-Type-HybridUpdateActivities-HybridAdministratorAccount)": [ + { + "[AssessmentId](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-AssessmentId)": "**_string_** ", + "[InitiatedBy](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-InitiatedBy)": "**_string_** ", + "[LastUpdatedDateTime](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-LastUpdatedDateTime)": **_number_** , + "[NewValue](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-NewValue)": { + "[DnsIps](./API_HybridUpdateValue.html#DirectoryService-Type-HybridUpdateValue-DnsIps)": [ "**_string_** " ], + "[InstanceIds](./API_HybridUpdateValue.html#DirectoryService-Type-HybridUpdateValue-InstanceIds)": [ "**_string_** " ] + }, + "[PreviousValue](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-PreviousValue)": { + "[DnsIps](./API_HybridUpdateValue.html#DirectoryService-Type-HybridUpdateValue-DnsIps)": [ "**_string_** " ], + "[InstanceIds](./API_HybridUpdateValue.html#DirectoryService-Type-HybridUpdateValue-InstanceIds)": [ "**_string_** " ] + }, + "[StartTime](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-StartTime)": **_number_** , + "[Status](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-Status)": "**_string_** ", + "[StatusReason](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-StatusReason)": "**_string_** " + } + ], + "[SelfManagedInstances](./API_HybridUpdateActivities.html#DirectoryService-Type-HybridUpdateActivities-SelfManagedInstances)": [ + { + "[AssessmentId](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-AssessmentId)": "**_string_** ", + "[InitiatedBy](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-InitiatedBy)": "**_string_** ", + "[LastUpdatedDateTime](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-LastUpdatedDateTime)": **_number_** , + "[NewValue](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-NewValue)": { + "[DnsIps](./API_HybridUpdateValue.html#DirectoryService-Type-HybridUpdateValue-DnsIps)": [ "**_string_** " ], + "[InstanceIds](./API_HybridUpdateValue.html#DirectoryService-Type-HybridUpdateValue-InstanceIds)": [ "**_string_** " ] + }, + "[PreviousValue](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-PreviousValue)": { + "[DnsIps](./API_HybridUpdateValue.html#DirectoryService-Type-HybridUpdateValue-DnsIps)": [ "**_string_** " ], + "[InstanceIds](./API_HybridUpdateValue.html#DirectoryService-Type-HybridUpdateValue-InstanceIds)": [ "**_string_** " ] + }, + "[StartTime](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-StartTime)": **_number_** , + "[Status](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-Status)": "**_string_** ", + "[StatusReason](./API_HybridUpdateInfoEntry.html#DirectoryService-Type-HybridUpdateInfoEntry-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](./API_HybridUpdateActivities.html) object + +## Errors + +For information about the errors that are common to all actions, see [Common Errors](./CommonErrors.html). + +**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.