MainframeModernization / Paginator / ListApplications


class MainframeModernization.Paginator.ListApplications#
paginator = client.get_paginator('list_applications')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • environmentId (string) – The unique identifier of the runtime environment where the applications are deployed.

  • names (list) –

    The names of the applications.

    • (string) –

  • 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:



Response Syntax

    'applications': [
            'applicationArn': 'string',
            'applicationId': 'string',
            'applicationVersion': 123,
            'creationTime': datetime(2015, 1, 1),
            'deploymentStatus': 'Deploying'|'Deployed',
            'description': 'string',
            'engineType': 'microfocus'|'bluage',
            'environmentId': 'string',
            'lastStartTime': datetime(2015, 1, 1),
            'name': 'string',
            'roleArn': 'string',
            'status': 'Creating'|'Created'|'Available'|'Ready'|'Starting'|'Running'|'Stopping'|'Stopped'|'Failed'|'Deleting'|'Deleting From Environment',
            'versionStatus': 'Creating'|'Available'|'Failed'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • applications (list) –

      Returns a list of summary details for all the applications in a runtime environment.

      • (dict) –

        A subset of the possible application attributes. Used in the application list.

        • applicationArn (string) –

          The Amazon Resource Name (ARN) of the application.

        • applicationId (string) –

          The unique identifier of the application.

        • applicationVersion (integer) –

          The version of the application.

        • creationTime (datetime) –

          The timestamp when the application was created.

        • deploymentStatus (string) –

          Indicates either an ongoing deployment or if the application has ever deployed successfully.

        • description (string) –

          The description of the application.

        • engineType (string) –

          The type of the target platform for this application.

        • environmentId (string) –

          The unique identifier of the runtime environment that hosts this application.

        • lastStartTime (datetime) –

          The timestamp when you last started the application. Null until the application runs for the first time.

        • name (string) –

          The name of the application.

        • roleArn (string) –

          The Amazon Resource Name (ARN) of the role associated with the application.

        • status (string) –

          The status of the application.

        • versionStatus (string) –

          Indicates the status of the latest version of the application.

    • NextToken (string) –

      A token to resume pagination.