DescribeUpdateDirectory - Amazon Directory Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Describes the updates of a directory for a particular update type.

Request Syntax

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

Request Parameters

The request accepts the following data in JSON format.


The unique identifier of the directory.

Type: String

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

Required: Yes


The DescribeUpdateDirectoryResult. NextToken value from a previous call to DescribeUpdateDirectory. Pass null if this is the first call.

Type: String

Required: No


The name of the Region.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 32.

Required: No


The type of updates you want to describe for the directory.

Type: String

Valid Values: OS

Required: Yes

Response Syntax

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

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

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


If not null, more results are available. Pass this value for the NextToken parameter.

Type: String


The list of update activities on a directory for the requested update type.

Type: Array of UpdateInfoEntry objects


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


Client authentication is not available in this region at this time.

HTTP Status Code: 400


A client exception has occurred.

HTTP Status Code: 400


The specified directory does not exist in the system.

HTTP Status Code: 400


The NextToken value is not valid.

HTTP Status Code: 400


One or more parameters are not valid.

HTTP Status Code: 400


An exception has occurred in Amazon Directory Service.

HTTP Status Code: 500

See Also

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