TrustedAdvisorPublicAPI / Client / list_checks

list_checks#

TrustedAdvisorPublicAPI.Client.list_checks(**kwargs)#

List a filterable set of Checks

See also: AWS API Documentation

Request Syntax

response = client.list_checks(
    awsService='string',
    language='en'|'ja'|'zh'|'fr'|'de'|'ko'|'zh_TW'|'it'|'es'|'pt_BR'|'id',
    maxResults=123,
    nextToken='string',
    pillar='cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence',
    source='aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected'
)
Parameters:

  • awsService (string) – The aws service associated with the check

  • language (string) – The ISO 639-1 code for the language that you want your checks to appear in.

  • maxResults (integer) – The maximum number of results to return per page.

  • nextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • pillar (string) – The pillar of the check

  • source (string) – The source of the check

Return type:

dict

Returns:

Response Syntax

{
    'checkSummaries': [
        {
            'arn': 'string',
            'awsServices': [
                'string',
            ],
            'description': 'string',
            'id': 'string',
            'metadata': {
                'string': 'string'
            },
            'name': 'string',
            'pillars': [
                'cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence',
            ],
            'source': 'aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • checkSummaries (list) –

      The list of Checks

      • (dict) –

        A summary of an AWS Trusted Advisor Check

        • arn (string) –

          The ARN of the AWS Trusted Advisor Check

        • awsServices (list) –

          The AWS Services that the Check applies to

          • (string) –

        • description (string) –

          A description of what the AWS Trusted Advisor Check is monitoring

        • id (string) –

          The unique identifier of the AWS Trusted Advisor Check

        • metadata (dict) –

          The column headings for the metadata returned in the resource

          • (string) –

            • (string) –

        • name (string) –

          The name of the AWS Trusted Advisor Check

        • pillars (list) –

          The Recommendation pillars that the AWS Trusted Advisor Check falls under

          • (string) –

        • source (string) –

          The source of the Recommendation

    • nextToken (string) –

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Exceptions

  • TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException

  • TrustedAdvisorPublicAPI.Client.exceptions.InternalServerException

  • TrustedAdvisorPublicAPI.Client.exceptions.ValidationException

  • TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException