Transfer / Paginator / ListWebApps

ListWebApps#

class Transfer.Paginator.ListWebApps#

paginator = client.get_paginator('list_web_apps')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from Transfer.Client.list_web_apps().

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

MaxItems (integer) –

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) –

The size of each page.
StartingToken (string) –

A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- 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.