SsmSap / Client / list_sub_check_results

list_sub_check_results

SsmSap.Client.list_sub_check_results(**kwargs)

Lists the sub-check results of a specified configuration check operation.

See also: AWS API Documentation

Request Syntax

response = client.list_sub_check_results(
    OperationId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • OperationId (string) –

    [REQUIRED]

    The ID of the configuration check operation.

  • 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

{
    'SubCheckResults': [
        {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'References': [
                'string',
            ]
        },
    ],
    'NextToken': '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) –

    • 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