ServerlessApplicationRepository / Paginator / ListApplications

ListApplications

class ServerlessApplicationRepository.Paginator.ListApplications

paginator = client.get_paginator('list_applications')

paginate(**kwargs)

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

See also: AWS API Documentation

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

{
    'Applications': [
        {
            'ApplicationId': 'string',
            'Author': 'string',
            'CreationTime': 'string',
            'Description': 'string',
            'HomePageUrl': 'string',
            'Labels': [
                'string',
            ],
            'Name': 'string',
            'SpdxLicenseId': 'string'
        },
    ],

}

Response Structure

• (dict) –

  Success

  • Applications (list) –

    An array of application summaries.

    • (dict) –

      Summary of details about the application.

      • ApplicationId (string) –

        The application Amazon Resource Name (ARN).

      • Author (string) –

        The name of the author publishing the app.

        Minimum length=1. Maximum length=127.

        Pattern “^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$”;

      • CreationTime (string) –

        The date and time this resource was created.

      • Description (string) –

        The description of the application.

        Minimum length=1. Maximum length=256

      • HomePageUrl (string) –

        A URL with more information about the application, for example the location of your GitHub repository for the application.

      • Labels (list) –

        Labels to improve discovery of apps in search results.

        Minimum length=1. Maximum length=127. Maximum number of labels: 10

        Pattern: “^[a-zA-Z0-9+\-_:\/@]+$”;

        • (string) –

      • Name (string) –

        The name of the application.

        Minimum length=1. Maximum length=140

        Pattern: “[a-zA-Z0-9\-]+”;

      • SpdxLicenseId (string) –

        A valid identifier from https://spdx.org/licenses/.