:doc:`Amplify <../../amplify>` / Client / list_backend_environments

*************************
list_backend_environments
*************************



.. py:method:: Amplify.Client.list_backend_environments(**kwargs)

  

  Lists the backend environments for an Amplify app.

   

  This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBackendEnvironments>`_  


  **Request Syntax**
  ::

    response = client.list_backend_environments(
        appId='string',
        environmentName='string',
        nextToken='string',
        maxResults=123
    )
    
  :type appId: string
  :param appId: **[REQUIRED]** 

    The unique ID for an Amplify app.

    

  
  :type environmentName: string
  :param environmentName: 

    The name of the backend environment

    

  
  :type nextToken: string
  :param nextToken: 

    A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of records to list in a single response.

    

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

    
    ::

      {
          'backendEnvironments': [
              {
                  'backendEnvironmentArn': 'string',
                  'environmentName': 'string',
                  'stackName': 'string',
                  'deploymentArtifacts': 'string',
                  'createTime': datetime(2015, 1, 1),
                  'updateTime': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The result structure for the list backend environments result.

      
      

      - **backendEnvironments** *(list) --* 

        The list of backend environments for an Amplify app.

        
        

        - *(dict) --* 

          Describes the backend environment associated with a ``Branch`` of a Gen 1 Amplify app. Amplify Gen 1 applications are created using Amplify Studio or the Amplify command line interface (CLI).

          
          

          - **backendEnvironmentArn** *(string) --* 

            The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

            
          

          - **environmentName** *(string) --* 

            The name for a backend environment that is part of an Amplify app.

            
          

          - **stackName** *(string) --* 

            The AWS CloudFormation stack name of a backend environment.

            
          

          - **deploymentArtifacts** *(string) --* 

            The name of deployment artifacts.

            
          

          - **createTime** *(datetime) --* 

            The creation date and time for a backend environment that is part of an Amplify app.

            
          

          - **updateTime** *(datetime) --* 

            The last updated date and time for a backend environment that is part of an Amplify app.

            
      
    
      

      - **nextToken** *(string) --* 

        A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

        
  
  **Exceptions**
  
  *   :py:class:`Amplify.Client.exceptions.BadRequestException`

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

  
  *   :py:class:`Amplify.Client.exceptions.InternalFailureException`

  