SsmSap / Client / list_sub_check_rule_results

list_sub_check_rule_results¶

SsmSap.Client.list_sub_check_rule_results(**kwargs)¶

Lists the rules of a specified sub-check belonging to a configuration check operation.

Request Syntax

response = client.list_sub_check_rule_results(
    SubCheckResultId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

SubCheckResultId (string) –
[REQUIRED]

The ID of the sub check result.
MaxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'RuleResults': [
        {
            'Id': 'string',
            'Description': 'string',
            'Status': 'PASSED'|'FAILED'|'WARNING'|'INFO'|'UNKNOWN',
            'Message': 'string',
            'Metadata': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- RuleResults (list) –
  
  The rule results of a sub-check belonging to a configuration check operation.
  - (dict) –
    
    Represents the result of a single rule within a configuration check.
    - Id (string) –
      
      The unique identifier of the rule result.
    - Description (string) –
      
      A description of what the rule validates.
    - Status (string) –
      
      The status of the rule result.
    - Message (string) –
      
      A message providing details about the rule result.
    - Metadata (dict) –
      
      Additional metadata associated with the rule result.
      - (string) –
        
        (string) –
- NextToken (string) –
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

SsmSap.Client.exceptions.ValidationException
SsmSap.Client.exceptions.InternalServerException