SsmSap / Client / start_configuration_checks

start_configuration_checks

SsmSap.Client.start_configuration_checks(**kwargs)

Initiates configuration check operations against a specified application.

See also: AWS API Documentation

Request Syntax

response = client.start_configuration_checks(
    ApplicationId='string',
    ConfigurationCheckIds=[
        'SAP_CHECK_01'|'SAP_CHECK_02'|'SAP_CHECK_03',
    ]
)
Parameters:

  • ApplicationId (string) –

    [REQUIRED]

    The ID of the application.

  • ConfigurationCheckIds (list) –

    The list of configuration checks to perform.

    • (string) –

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 that were started.

      • (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.

Exceptions