TrustedAdvisorPublicAPI / Paginator / ListChecks
ListChecks#
- class TrustedAdvisorPublicAPI.Paginator.ListChecks#
paginator = client.get_paginator('list_checks')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
TrustedAdvisorPublicAPI.Client.list_checks()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( awsService='string', language='en'|'ja'|'zh'|'fr'|'de'|'ko'|'zh_TW'|'it'|'es'|'pt_BR'|'id', 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', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- 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.
pillar (string) – The pillar of the check
source (string) – The source of the check
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- 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) –
A token to resume pagination.