:doc:`DataZone <../../datazone>` / Paginator / ListEnvironments

****************
ListEnvironments
****************



.. py:class:: DataZone.Paginator.ListEnvironments

  ::

    
    paginator = client.get_paginator('list_environments')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DataZone.Client.list_environments`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListEnvironments>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          domainIdentifier='string',
          awsAccountId='string',
          status='ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE',
          awsAccountRegion='string',
          projectIdentifier='string',
          environmentProfileIdentifier='string',
          environmentBlueprintIdentifier='string',
          provider='string',
          name='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type domainIdentifier: string
    :param domainIdentifier: **[REQUIRED]** 

      The identifier of the Amazon DataZone domain.

      

    
    :type awsAccountId: string
    :param awsAccountId: 

      The identifier of the Amazon Web Services account where you want to list environments.

      

    
    :type status: string
    :param status: 

      The status of the environments that you want to list.

      

    
    :type awsAccountRegion: string
    :param awsAccountRegion: 

      The Amazon Web Services region where you want to list environments.

      

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

      The identifier of the Amazon DataZone project.

      

    
    :type environmentProfileIdentifier: string
    :param environmentProfileIdentifier: 

      The identifier of the environment profile.

      

    
    :type environmentBlueprintIdentifier: string
    :param environmentBlueprintIdentifier: 

      The identifier of the Amazon DataZone blueprint.

      

    
    :type provider: string
    :param provider: 

      The provider of the environment.

      

    
    :type name: string
    :param name: 

      The name of the environment.

      

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

      
      ::

        {
            'items': [
                {
                    'projectId': 'string',
                    'id': 'string',
                    'domainId': 'string',
                    'createdBy': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1),
                    'name': 'string',
                    'description': 'string',
                    'environmentProfileId': 'string',
                    'awsAccountId': 'string',
                    'awsAccountRegion': 'string',
                    'provider': 'string',
                    'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE',
                    'environmentConfigurationId': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          The results of the ``ListEnvironments`` action.

          
          

          - *(dict) --* 

            The details of an environment.

            
            

            - **projectId** *(string) --* 

              The identifier of the project in which the environment exists.

              
            

            - **id** *(string) --* 

              The identifier of the environment.

              
            

            - **domainId** *(string) --* 

              The identifier of the Amazon DataZone domain in which the environment exists.

              
            

            - **createdBy** *(string) --* 

              The Amazon DataZone user who created the environment.

              
            

            - **createdAt** *(datetime) --* 

              The timestamp of when the environment was created.

              
            

            - **updatedAt** *(datetime) --* 

              The timestamp of when the environment was updated.

              
            

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

              The name of the environment.

              
            

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

              The description of the environment.

              
            

            - **environmentProfileId** *(string) --* 

              The identifier of the environment profile with which the environment was created.

              
            

            - **awsAccountId** *(string) --* 

              The identifier of the Amazon Web Services account in which an environment exists.

              
            

            - **awsAccountRegion** *(string) --* 

              The Amazon Web Services Region in which an environment exists.

              
            

            - **provider** *(string) --* 

              The provider of the environment.

              
            

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

              The status of the environment.

              
            

            - **environmentConfigurationId** *(string) --* 

              The configuration ID with which the environment is created.

              
        
      
        

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

          A token to resume pagination.

          
    