DescribeUpdateDirectoryCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DirectoryServiceClient, DescribeUpdateDirectoryCommand } from "@aws-sdk/client-directory-service"; // ES Modules import
// const { DirectoryServiceClient, DescribeUpdateDirectoryCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import
const client = new DirectoryServiceClient(config);
const input = { // DescribeUpdateDirectoryRequest
  DirectoryId: "STRING_VALUE", // required
  UpdateType: "OS", // required
  RegionName: "STRING_VALUE",
  NextToken: "STRING_VALUE",
};
const command = new DescribeUpdateDirectoryCommand(input);
const response = await client.send(command);
// { // DescribeUpdateDirectoryResult
//   UpdateActivities: [ // UpdateActivities
//     { // UpdateInfoEntry
//       Region: "STRING_VALUE",
//       Status: "Updated" || "Updating" || "UpdateFailed",
//       StatusReason: "STRING_VALUE",
//       InitiatedBy: "STRING_VALUE",
//       NewValue: { // UpdateValue
//         OSUpdateSettings: { // OSUpdateSettings
//           OSVersion: "SERVER_2012" || "SERVER_2019",
//         },
//       },
//       PreviousValue: {
//         OSUpdateSettings: {
//           OSVersion: "SERVER_2012" || "SERVER_2019",
//         },
//       },
//       StartTime: new Date("TIMESTAMP"),
//       LastUpdatedDateTime: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeUpdateDirectoryCommand Input

See DescribeUpdateDirectoryCommandInput for more details

Parameter
Type
Description
DirectoryId
Required
string | undefined

The unique identifier of the directory.

UpdateType
Required
UpdateType | undefined

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

NextToken
string | undefined

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

RegionName
string | undefined

The name of the Region.

DescribeUpdateDirectoryCommand Output

See DescribeUpdateDirectoryCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

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

UpdateActivities
UpdateInfoEntry[] | undefined

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

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ClientException
client

A client exception has occurred.

DirectoryDoesNotExistException
client

The specified directory does not exist in the system.

InvalidNextTokenException
client

The NextToken value is not valid.

InvalidParameterException
client

One or more parameters are not valid.

ServiceException
server

An exception has occurred in Directory Service.

DirectoryServiceServiceException
Base exception class for all service exceptions from DirectoryService service.