DirectoryService / Client / describe_update_directory

describe_update_directory#

DirectoryService.Client.describe_update_directory(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_update_directory(
    DirectoryId='string',
    UpdateType='OS',
    RegionName='string',
    NextToken='string'
)
Parameters:

  • DirectoryId (string) –

    [REQUIRED]

    The unique identifier of the directory.

  • UpdateType (string) –

    [REQUIRED]

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

  • RegionName (string) – The name of the Region.

  • NextToken (string) – The DescribeUpdateDirectoryResult. NextToken value from a previous call to DescribeUpdateDirectory. Pass null if this is the first call.

Return type:

dict

Returns:

Response Syntax

{
    'UpdateActivities': [
        {
            'Region': 'string',
            'Status': 'Updated'|'Updating'|'UpdateFailed',
            'StatusReason': 'string',
            'InitiatedBy': 'string',
            'NewValue': {
                'OSUpdateSettings': {
                    'OSVersion': 'SERVER_2012'|'SERVER_2019'
                }
            },
            'PreviousValue': {
                'OSUpdateSettings': {
                    'OSVersion': 'SERVER_2012'|'SERVER_2019'
                }
            },
            'StartTime': datetime(2015, 1, 1),
            'LastUpdatedDateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • UpdateActivities (list) –

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

      • (dict) –

        An entry of update information related to a requested update type.

        • Region (string) –

          The name of the Region.

        • Status (string) –

          The status of the update performed on the directory.

        • StatusReason (string) –

          The reason for the current status of the update type activity.

        • InitiatedBy (string) –

          This specifies if the update was initiated by the customer or by the service team.

        • NewValue (dict) –

          The new value of the target setting.

          • OSUpdateSettings (dict) –

            The OS update related settings.

            • OSVersion (string) –

              OS version that the directory needs to be updated to.

        • PreviousValue (dict) –

          The old value of the target setting.

          • OSUpdateSettings (dict) –

            The OS update related settings.

            • OSVersion (string) –

              OS version that the directory needs to be updated to.

        • StartTime (datetime) –

          The start time of the UpdateDirectorySetup for the particular type.

        • LastUpdatedDateTime (datetime) –

          The last updated date and time of a particular directory setting.

    • NextToken (string) –

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

Exceptions

  • DirectoryService.Client.exceptions.DirectoryDoesNotExistException

  • DirectoryService.Client.exceptions.InvalidParameterException

  • DirectoryService.Client.exceptions.AccessDeniedException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ServiceException

  • DirectoryService.Client.exceptions.InvalidNextTokenException