:doc:`DirectoryService <../../ds>` / Paginator / DescribeUpdateDirectory

***********************
DescribeUpdateDirectory
***********************



.. py:class:: DirectoryService.Paginator.DescribeUpdateDirectory

  ::

    
    paginator = client.get_paginator('describe_update_directory')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`DirectoryService.Client.describe_update_directory`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeUpdateDirectory>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DirectoryId='string',
          UpdateType='OS'|'NETWORK'|'SIZE',
          RegionName='string',
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': 'string'
          }
      )
      
    :type DirectoryId: string
    :param DirectoryId: **[REQUIRED]** 

      The unique identifier of the directory.

      

    
    :type UpdateType: string
    :param UpdateType: **[REQUIRED]** 

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

      

    
    :type RegionName: string
    :param RegionName: 

      The name of the Region.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: 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.

              
        
      
    