SsmSap / Paginator / ListConfigurationCheckOperations

ListConfigurationCheckOperations

class SsmSap.Paginator.ListConfigurationCheckOperations
paginator = client.get_paginator('list_configuration_check_operations')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApplicationId='string',
    ListMode='ALL_OPERATIONS'|'LATEST_PER_CHECK',
    Filters=[
        {
            'Name': 'string',
            'Value': 'string',
            'Operator': 'Equals'|'GreaterThanOrEquals'|'LessThanOrEquals'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • ApplicationId (string) –

    [REQUIRED]

    The ID of the application.

  • ListMode (string) –

    The mode for listing configuration check operations. Defaults to “LATEST_PER_CHECK”.

    • LATEST_PER_CHECK - Will list the latest configuration check operation per check type.

    • ALL_OPERATIONS - Will list all configuration check operations performed on the application.

  • Filters (list) –

    The filters of an operation.

    • (dict) –

      A specific result obtained by specifying the name, value, and operator.

      • Name (string) – [REQUIRED]

        The name of the filter. Filter names are case-sensitive.

      • Value (string) – [REQUIRED]

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values

      • Operator (string) – [REQUIRED]

        The operator for the filter.

  • 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

{
    'ConfigurationCheckOperations': [
        {
            'Id': 'string',
            'ApplicationId': 'string',
            'Status': 'INPROGRESS'|'SUCCESS'|'ERROR',
            'StatusMessage': 'string',
            'ConfigurationCheckId': 'SAP_CHECK_01'|'SAP_CHECK_02'|'SAP_CHECK_03',
            'ConfigurationCheckName': 'string',
            'ConfigurationCheckDescription': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'RuleStatusCounts': {
                'Failed': 123,
                'Warning': 123,
                'Info': 123,
                'Passed': 123,
                'Unknown': 123
            }
        },
    ],

}

Response Structure

  • (dict) –

    • ConfigurationCheckOperations (list) –

      The configuration check operations performed by AWS Systems Manager for SAP.

      • (dict) –

        Represents a configuration check operation that has been executed against an application.

        • Id (string) –

          The unique identifier of the configuration check operation.

        • ApplicationId (string) –

          The ID of the application against which the configuration check was performed.

        • Status (string) –

          The current status of the configuration check operation.

        • StatusMessage (string) –

          A message providing additional details about the status of the configuration check operation.

        • ConfigurationCheckId (string) –

          The unique identifier of the configuration check that was performed.

        • ConfigurationCheckName (string) –

          The name of the configuration check that was performed.

        • ConfigurationCheckDescription (string) –

          A description of the configuration check that was performed.

        • StartTime (datetime) –

          The time at which the configuration check operation started.

        • EndTime (datetime) –

          The time at which the configuration check operation completed.

        • RuleStatusCounts (dict) –

          A summary of all the rule results, showing counts for each status type.

          • Failed (integer) –

            The number of rules that failed.

          • Warning (integer) –

            The number of rules that returned warnings.

          • Info (integer) –

            The number of rules that returned informational results.

          • Passed (integer) –

            The number of rules that passed.

          • Unknown (integer) –

            The number of rules with unknown status.