DescribeUpdateDirectory

class DirectoryService.Paginator.DescribeUpdateDirectory
paginator = client.get_paginator('describe_update_directory')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DirectoryService.Client.describe_update_directory().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DirectoryId='string',
    UpdateType='OS',
    RegionName='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': '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.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

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)
        },
    ],

}

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.