SsmSap / Paginator / ListSubCheckResults

ListSubCheckResults

class SsmSap.Paginator.ListSubCheckResults
paginator = client.get_paginator('list_sub_check_results')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OperationId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • OperationId (string) –

    [REQUIRED]

    The ID of the configuration check operation.

  • 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

{
    'SubCheckResults': [
        {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'References': [
                'string',
            ]
        },
    ],

}

Response Structure

  • (dict) –

    • SubCheckResults (list) –

      The sub-check results of a configuration check operation.

      • (dict) –

        Represents the result of a sub-check within a configuration check operation.

        • Id (string) –

          The unique identifier of the sub-check result.

        • Name (string) –

          The name of the sub-check.

        • Description (string) –

          A description of what the sub-check validates.

        • References (list) –

          A list of references or documentation links related to the sub-check.

          • (string) –