SsmSap / Paginator / ListComponents

ListComponents

class SsmSap.Paginator.ListComponents

paginator = client.get_paginator('list_components')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SsmSap.Client.list_components().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ApplicationId (string) – The ID of the application.

• 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

{
    'Components': [
        {
            'ApplicationId': 'string',
            'ComponentId': 'string',
            'ComponentType': 'HANA',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  • Components (list) –

    List of components registered with AWS System Manager for SAP.

    • (dict) –

      The summary of the component.

      • ApplicationId (string) –

        The ID of the application.

      • ComponentId (string) –

        The ID of the component.

      • ComponentType (string) –

        The type of the component.

      • Tags (dict) –

        The tags of the component.

        • (string) –

          • (string) –