:doc:`Transfer <../../transfer>` / Client / list_web_apps

*************
list_web_apps
*************



.. py:method:: Transfer.Client.list_web_apps(**kwargs)

  

  Lists all web apps associated with your Amazon Web Services account for your current region. The response includes the endpoint type for each web app, showing whether it is publicly accessible or VPC hosted.

   

  For more information about using VPC endpoints with Transfer Family, see `Create a Transfer Family web app in a VPC <https://docs.aws.amazon.com/transfer/latest/userguide/create-webapp-in-vpc.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListWebApps>`_  


  **Request Syntax**
  ::

    response = client.list_web_apps(
        MaxResults=123,
        NextToken='string'
    )
    
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of items to return.

    

  
  :type NextToken: string
  :param NextToken: 

    Returns the ``NextToken`` parameter in the output. You can then pass the ``NextToken`` parameter in a subsequent command to continue listing additional web apps.

    

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

    
    ::

      {
          'NextToken': 'string',
          'WebApps': [
              {
                  'Arn': 'string',
                  'WebAppId': 'string',
                  'AccessEndpoint': 'string',
                  'WebAppEndpoint': 'string',
                  'EndpointType': 'PUBLIC'|'VPC'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        Provide this value for the ``NextToken`` parameter in a subsequent command to continue listing additional web apps.

        
      

      - **WebApps** *(list) --* 

        Returns, for each listed web app, a structure that contains details for the web app.

        
        

        - *(dict) --* 

          a structure that contains details for the web app.

          
          

          - **Arn** *(string) --* 

            The Amazon Resource Name (ARN) for the web app.

            
          

          - **WebAppId** *(string) --* 

            The unique identifier for the web app.

            
          

          - **AccessEndpoint** *(string) --* 

            The ``AccessEndpoint`` is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.

            
          

          - **WebAppEndpoint** *(string) --* 

            The ``WebAppEndpoint`` is the unique URL for your Transfer Family web app. This is the value that you use when you configure **Origins** on CloudFront.

            
          

          - **EndpointType** *(string) --* 

            The type of endpoint hosting the web app. Valid values are ``PUBLIC`` for publicly accessible endpoints and ``VPC`` for VPC-hosted endpoints.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`Transfer.Client.exceptions.InvalidRequestException`

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

  
  *   :py:class:`Transfer.Client.exceptions.InternalServiceError`

  
  *   :py:class:`Transfer.Client.exceptions.InvalidNextTokenException`

  