:doc:`DataZone <../../datazone>` / Client / list_environments

*****************
list_environments
*****************



.. py:method:: DataZone.Client.list_environments(**kwargs)

  

  Lists Amazon DataZone environments.

  

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


  **Request Syntax**
  ::

    response = client.list_environments(
        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',
        maxResults=123,
        nextToken='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 maxResults: integer
  :param maxResults: 

    The maximum number of environments to return in a single call to ``ListEnvironments``. When the number of environments to be listed is greater than the value of ``MaxResults``, the response contains a ``NextToken`` value that you can use in a subsequent call to ``ListEnvironments`` to list the next set of environments.

    

  
  :type nextToken: string
  :param nextToken: 

    When the number of environments is greater than the default value for the ``MaxResults`` parameter, or if you explicitly specify a value for ``MaxResults`` that is less than the number of environments, the response includes a pagination token named ``NextToken``. You can specify this ``NextToken`` value in a subsequent call to ``ListEnvironments`` to list the next set of environments.

    

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

        When the number of environments is greater than the default value for the ``MaxResults`` parameter, or if you explicitly specify a value for ``MaxResults`` that is less than the number of environments, the response includes a pagination token named ``NextToken``. You can specify this ``NextToken`` value in a subsequent call to ``ListEnvironments`` to list the next set of environments.

        
  
  **Exceptions**
  
  *   :py:class:`DataZone.Client.exceptions.InternalServerException`

  
  *   :py:class:`DataZone.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DataZone.Client.exceptions.ThrottlingException`

  
  *   :py:class:`DataZone.Client.exceptions.ValidationException`

  
  *   :py:class:`DataZone.Client.exceptions.UnauthorizedException`

  