AppFabric / Paginator / ListAppAuthorizations

ListAppAuthorizations#

class AppFabric.Paginator.ListAppAuthorizations#
paginator = client.get_paginator('list_app_authorizations')
paginate(**kwargs)#

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

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

{
    'appAuthorizationSummaryList': [
        {
            'appAuthorizationArn': 'string',
            'appBundleArn': 'string',
            'app': 'string',
            'tenant': {
                'tenantIdentifier': 'string',
                'tenantDisplayName': 'string'
            },
            'status': 'PendingConnect'|'Connected'|'ConnectionValidationFailed'|'TokenAutoRotationFailed',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • appAuthorizationSummaryList (list) –

      Contains a list of app authorization summaries.

      • (dict) –

        Contains a summary of an app authorization.

        • appAuthorizationArn (string) –

          The Amazon Resource Name (ARN) of the app authorization.

        • appBundleArn (string) –

          The Amazon Resource Name (ARN) of the app bundle for the app authorization.

        • app (string) –

          The name of the application.

        • tenant (dict) –

          Contains information about an application tenant, such as the application display name and identifier.

          • tenantIdentifier (string) –

            The ID of the application tenant.

          • tenantDisplayName (string) –

            The display name of the tenant.

        • status (string) –

          The state of the app authorization.

          The following states are possible:

          • PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.

          • Connected: The app authorization is connected to the application, and is ready to be used.

          • ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.

          • TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.

        • updatedAt (datetime) –

          Timestamp for when the app authorization was last updated.

    • NextToken (string) –

      A token to resume pagination.