:doc:`SWF <../../swf>` / Paginator / ListActivityTypes

*****************
ListActivityTypes
*****************



.. py:class:: SWF.Paginator.ListActivityTypes

  ::

    
    paginator = client.get_paginator('list_activity_types')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`SWF.Client.list_activity_types`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/swf-2012-01-25/ListActivityTypes>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          domain='string',
          name='string',
          registrationStatus='REGISTERED'|'DEPRECATED',
          reverseOrder=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type domain: string
    :param domain: **[REQUIRED]** 

      The name of the domain in which the activity types have been registered.

      

    
    :type name: string
    :param name: 

      If specified, only lists the activity types that have this name.

      

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

      Specifies the registration status of the activity types to list.

      

    
    :type reverseOrder: boolean
    :param reverseOrder: 

      When set to ``true``, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by ``name`` of the activity types.

      

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

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

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

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'typeInfos': [
                {
                    'activityType': {
                        'name': 'string',
                        'version': 'string'
                    },
                    'status': 'REGISTERED'|'DEPRECATED',
                    'description': 'string',
                    'creationDate': datetime(2015, 1, 1),
                    'deprecationDate': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Contains a paginated list of activity type information structures.

        
        

        - **typeInfos** *(list) --* 

          List of activity type information.

          
          

          - *(dict) --* 

            Detailed information about an activity type.

            
            

            - **activityType** *(dict) --* 

              The  ActivityType type structure representing the activity type.

              
              

              - **name** *(string) --* 

                The name of this activity.

                 

                .. note::

                  

                  The combination of activity type name and version must be unique within a domain.

                  

                
              

              - **version** *(string) --* 

                The version of this activity.

                 

                .. note::

                  

                  The combination of activity type name and version must be unique with in a domain.

                  

                
          
            

            - **status** *(string) --* 

              The current status of the activity type.

              
            

            - **description** *(string) --* 

              The description of the activity type provided in  RegisterActivityType.

              
            

            - **creationDate** *(datetime) --* 

              The date and time this activity type was created through  RegisterActivityType.

              
            

            - **deprecationDate** *(datetime) --* 

              If DEPRECATED, the date and time  DeprecateActivityType was called.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    