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

***********************
get_backend_environment
***********************



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

  

  Returns a backend environment 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/GetBackendEnvironment>`_  


  **Request Syntax**
  ::

    response = client.get_backend_environment(
        appId='string',
        environmentName='string'
    )
    
  :type appId: string
  :param appId: **[REQUIRED]** 

    The unique id for an Amplify app.

    

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

    The name for the backend environment.

    

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

    
    ::

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

    

    - *(dict) --* 

      The result structure for the get backend environment result.

      
      

      - **backendEnvironment** *(dict) --* 

        Describes the backend environment for an Amplify app.

        
        

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

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

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

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

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

  