SecurityAgent / Paginator / ListIntegrations

ListIntegrations

class SecurityAgent.Paginator.ListIntegrations

paginator = client.get_paginator('list_integrations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filter={
        'provider': 'GITHUB',
        'providerType': 'SOURCE_CODE'|'DOCUMENTATION'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filter (dict) –

  Filter criteria for integrations

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: provider, providerType.

  • provider (string) –

    Filter by provider

  • providerType (string) –

    Filter by provider type

• 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

{
    'integrationSummaries': [
        {
            'integrationId': 'string',
            'installationId': 'string',
            'provider': 'GITHUB',
            'providerType': 'SOURCE_CODE'|'DOCUMENTATION',
            'displayName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • integrationSummaries (list) –

    List of integration summaries

    • (dict) –

      Summary information about an integration

      • integrationId (string) –

        Unique identifier of the integration

      • installationId (string) –

        Installation identifier from the provider

      • provider (string) –

        Provider type

      • providerType (string) –

        Type of provider integration

      • displayName (string) –

        Display name for the integration

  • NextToken (string) –

    A token to resume pagination.