:doc:`Proton <../../proton>` / Client / list_environment_account_connections

************************************
list_environment_account_connections
************************************



.. py:method:: Proton.Client.list_environment_account_connections(**kwargs)

  

  View a list of environment account connections.

   

  For more information, see `Environment account connections <https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html>`__ in the *Proton User guide*.

  

  .. danger::

        This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentAccountConnections>`_  


  **Request Syntax**
  ::

    response = client.list_environment_account_connections(
        environmentName='string',
        maxResults=123,
        nextToken='string',
        requestedBy='MANAGEMENT_ACCOUNT'|'ENVIRONMENT_ACCOUNT',
        statuses=[
            'PENDING'|'CONNECTED'|'REJECTED',
        ]
    )
    
  :type environmentName: string
  :param environmentName: 

    The environment name that's associated with each listed environment account connection.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of environment account connections to list.

    

  
  :type nextToken: string
  :param nextToken: 

    A token that indicates the location of the next environment account connection in the array of environment account connections, after the list of environment account connections that was previously requested.

    

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

    The type of account making the ``ListEnvironmentAccountConnections`` request.

    

  
  :type statuses: list
  :param statuses: 

    The status details for each listed environment account connection.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'environmentAccountConnections': [
              {
                  'arn': 'string',
                  'componentRoleArn': 'string',
                  'environmentAccountId': 'string',
                  'environmentName': 'string',
                  'id': 'string',
                  'lastModifiedAt': datetime(2015, 1, 1),
                  'managementAccountId': 'string',
                  'requestedAt': datetime(2015, 1, 1),
                  'roleArn': 'string',
                  'status': 'PENDING'|'CONNECTED'|'REJECTED'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **environmentAccountConnections** *(list) --* 

        An array of environment account connections with details that's returned by Proton.

        
        

        - *(dict) --* 

          Summary data of an Proton environment account connection resource.

          
          

          - **arn** *(string) --* 

            The Amazon Resource Name (ARN) of the environment account connection.

            
          

          - **componentRoleArn** *(string) --* 

            The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

             

            The environment account connection must have a ``componentRoleArn`` to allow directly defined components to be associated with any environments running in the account.

             

            For more information about components, see `Proton components <https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html>`__ in the *Proton User Guide*.

            
          

          - **environmentAccountId** *(string) --* 

            The ID of the environment account that's connected to the environment account connection.

            
          

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

            The name of the environment that's associated with the environment account connection.

            
          

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

            The ID of the environment account connection.

            
          

          - **lastModifiedAt** *(datetime) --* 

            The time when the environment account connection was last modified.

            
          

          - **managementAccountId** *(string) --* 

            The ID of the management account that's connected to the environment account connection.

            
          

          - **requestedAt** *(datetime) --* 

            The time when the environment account connection request was made.

            
          

          - **roleArn** *(string) --* 

            The IAM service role that's associated with the environment account connection.

            
          

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

            The status of the environment account connection.

            
      
    
      

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

        A token that indicates the location of the next environment account connection in the array of environment account connections, after the current requested list of environment account connections.

        
  
  **Exceptions**
  
  *   :py:class:`Proton.Client.exceptions.ValidationException`

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

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

  
  *   :py:class:`Proton.Client.exceptions.InternalServerException`

  