SecurityAgent / Paginator / ListApplications

ListApplications¶

class SecurityAgent.Paginator.ListApplications¶

paginator = client.get_paginator('list_applications')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from SecurityAgent.Client.list_applications().

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

{
    'applicationSummaries': [
        {
            'applicationId': 'string',
            'applicationName': 'string',
            'domain': 'string',
            'defaultKmsKeyId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- applicationSummaries (list) –
  
  The list of application summaries.
  - (dict) –
    
    Contains summary information about an application.
    - applicationId (string) –
      
      The unique identifier of the application.
    - applicationName (string) –
      
      The name of the application.
    - domain (string) –
      
      The domain associated with the application.
    - defaultKmsKeyId (string) –
      
      The identifier of the default AWS KMS key used to encrypt data for the application.
- NextToken (string) –
  
  A token to resume pagination.