SSM / Client / list_resource_compliance_summaries

list_resource_compliance_summaries#

SSM.Client.list_resource_compliance_summaries(**kwargs)#

Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.

Request Syntax

response = client.list_resource_compliance_summaries(
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'Type': 'EQUAL'|'NOT_EQUAL'|'BEGIN_WITH'|'LESS_THAN'|'GREATER_THAN'
        },
    ],
    NextToken='string',
    MaxResults=123
)

Parameters:

Filters (list) –
One or more filters. Use a filter to return a more specific list of results.
- (dict) –
  
  One or more filters. Use a filter to return a more specific list of results.
  - Key (string) –
    
    The name of the filter.
  - Values (list) –
    
    The value for which to search.
    - (string) –
  - Type (string) –
    
    The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith, LessThan, or GreaterThan.
NextToken (string) – A token to start the list. Use this token to get the next set of results.
MaxResults (integer) – The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'ResourceComplianceSummaryItems': [
        {
            'ComplianceType': 'string',
            'ResourceType': 'string',
            'ResourceId': 'string',
            'Status': 'COMPLIANT'|'NON_COMPLIANT',
            'OverallSeverity': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'INFORMATIONAL'|'UNSPECIFIED',
            'ExecutionSummary': {
                'ExecutionTime': datetime(2015, 1, 1),
                'ExecutionId': 'string',
                'ExecutionType': 'string'
            },
            'CompliantSummary': {
                'CompliantCount': 123,
                'SeveritySummary': {
                    'CriticalCount': 123,
                    'HighCount': 123,
                    'MediumCount': 123,
                    'LowCount': 123,
                    'InformationalCount': 123,
                    'UnspecifiedCount': 123
                }
            },
            'NonCompliantSummary': {
                'NonCompliantCount': 123,
                'SeveritySummary': {
                    'CriticalCount': 123,
                    'HighCount': 123,
                    'MediumCount': 123,
                    'LowCount': 123,
                    'InformationalCount': 123,
                    'UnspecifiedCount': 123
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- ResourceComplianceSummaryItems (list) –
  
  A summary count for specified or targeted managed nodes. Summary count includes information about compliant and non-compliant State Manager associations, patch status, or custom items according to the filter criteria that you specify.
  - (dict) –
    
    Compliance summary information for a specific resource.
    - ComplianceType (string) –
      
      The compliance type.
    - ResourceType (string) –
      
      The resource type.
    - ResourceId (string) –
      
      The resource ID.
    - Status (string) –
      
      The compliance status for the resource.
    - OverallSeverity (string) –
      
      The highest severity item found for the resource. The resource is compliant for this item.
    - ExecutionSummary (dict) –
      
      Information about the execution.
      - ExecutionTime (datetime) –
        
        The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
      - ExecutionId (string) –
        
        An ID created by the system when PutComplianceItems was called. For example, CommandID is a valid execution ID. You can use this ID in subsequent calls.
      - ExecutionType (string) –
        
        The type of execution. For example, Command is a valid execution type.
    - CompliantSummary (dict) –
      
      A list of items that are compliant for the resource.
      - CompliantCount (integer) –
        
        The total number of resources that are compliant.
      - SeveritySummary (dict) –
        
        A summary of the compliance severity by compliance type.
        
        CriticalCount (integer) –
        
        The total number of resources or compliance items that have a severity level of Critical. Critical severity is determined by the organization that published the compliance items.
        
        HighCount (integer) –
        
        The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.
        
        MediumCount (integer) –
        
        The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.
        
        LowCount (integer) –
        
        The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.
        
        InformationalCount (integer) –
        
        The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.
        
        UnspecifiedCount (integer) –
        
        The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.
    - NonCompliantSummary (dict) –
      
      A list of items that aren’t compliant for the resource.
      - NonCompliantCount (integer) –
        
        The total number of compliance items that aren’t compliant.
      - SeveritySummary (dict) –
        
        A summary of the non-compliance severity by compliance type
        
        CriticalCount (integer) –
        
        The total number of resources or compliance items that have a severity level of Critical. Critical severity is determined by the organization that published the compliance items.
        
        HighCount (integer) –
        
        The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.
        
        MediumCount (integer) –
        
        The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.
        
        LowCount (integer) –
        
        The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.
        
        InformationalCount (integer) –
        
        The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.
        
        UnspecifiedCount (integer) –
        
        The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.
- NextToken (string) –
  
  The token for the next set of items to return. Use this token to get the next set of results.

Exceptions

SSM.Client.exceptions.InvalidFilter
SSM.Client.exceptions.InvalidNextToken
SSM.Client.exceptions.InternalServerError