Transfer / Client / list_web_apps

list_web_apps#

Transfer.Client.list_web_apps(**kwargs)#

Lists all web apps associated with your Amazon Web Services account for your current region.

Request Syntax

response = client.list_web_apps(
    MaxResults=123,
    NextToken='string'
)

Parameters:

MaxResults (integer) – The maximum number of items to return.
NextToken (string) – Returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional web apps.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'WebApps': [
        {
            'Arn': 'string',
            'WebAppId': 'string',
            'AccessEndpoint': 'string',
            'WebAppEndpoint': 'string'
        },
    ]
}

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.

Exceptions

Transfer.Client.exceptions.InvalidRequestException
Transfer.Client.exceptions.ThrottlingException
Transfer.Client.exceptions.InternalServiceError
Transfer.Client.exceptions.InvalidNextTokenException