AppFabric / Paginator / ListIngestions

ListIngestions

class AppFabric.Paginator.ListIngestions

paginator = client.get_paginator('list_ingestions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AppFabric.Client.list_ingestions().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• appBundleIdentifier (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

• 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

{
    'ingestions': [
        {
            'arn': 'string',
            'app': 'string',
            'tenantId': 'string',
            'state': 'enabled'|'disabled'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ingestions (list) –

    Contains a list of ingestion summaries.

    • (dict) –

      Contains a summary of an ingestion.

      • arn (string) –

        The Amazon Resource Name (ARN) of the ingestion.

      • app (string) –

        The name of the application.

      • tenantId (string) –

        The ID of the application tenant.

      • state (string) –

        The status of the ingestion.

  • NextToken (string) –

    A token to resume pagination.