Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeUpdateDirectory

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.

DirectoryId

The unique identifier of the directory.

Type: String

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

Required: Yes

NextToken

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

Type: String

Required: No

RegionName

The name of the Region.

Type: String

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

Required: No

UpdateType

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.

NextToken

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

Type: String

UpdateActivities

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

Type: Array of UpdateInfoEntry objects

Errors

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

AccessDeniedException

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

HTTP Status Code: 400

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 Amazon Directory Service.

HTTP Status Code: 500