TrustedAdvisorPublicAPI *********************** Client ====== class TrustedAdvisorPublicAPI.Client A low-level client representing TrustedAdvisor Public API TrustedAdvisor Public API import boto3 client = boto3.client('trustedadvisor') These are the available methods: * batch_update_recommendation_resource_exclusion * can_paginate * close * get_organization_recommendation * get_paginator * get_recommendation * get_waiter * list_checks * list_organization_recommendation_accounts * list_organization_recommendation_resources * list_organization_recommendations * list_recommendation_resources * list_recommendations * update_organization_recommendation_lifecycle * update_recommendation_lifecycle Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListChecks * ListOrganizationRecommendationAccounts * ListOrganizationRecommendationResources * ListOrganizationRecommendations * ListRecommendationResources * ListRecommendations TrustedAdvisorPublicAPI / Paginator / ListRecommendationResources ListRecommendationResources *************************** class TrustedAdvisorPublicAPI.Paginator.ListRecommendationResources paginator = client.get_paginator('list_recommendation_resources') paginate(**kwargs) Creates an iterator that will paginate through responses from " TrustedAdvisorPublicAPI.Client.list_recommendation_resources()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( exclusionStatus='excluded'|'included', recommendationIdentifier='string', regionCode='string', status='ok'|'warning'|'error', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **exclusionStatus** (*string*) -- The exclusion status of the resource * **recommendationIdentifier** (*string*) -- **[REQUIRED]** The Recommendation identifier * **regionCode** (*string*) -- The AWS Region code of the resource * **status** (*string*) -- The status of the resource * **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** { 'recommendationResourceSummaries': [ { 'arn': 'string', 'awsResourceId': 'string', 'exclusionStatus': 'excluded'|'included', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'metadata': { 'string': 'string' }, 'recommendationArn': 'string', 'regionCode': 'string', 'status': 'ok'|'warning'|'error' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **recommendationResourceSummaries** *(list) --* A list of Recommendation Resources * *(dict) --* Summary of a Recommendation Resource * **arn** *(string) --* The ARN of the Recommendation Resource * **awsResourceId** *(string) --* The AWS resource identifier * **exclusionStatus** *(string) --* The exclusion status of the Recommendation Resource * **id** *(string) --* The ID of the Recommendation Resource * **lastUpdatedAt** *(datetime) --* When the Recommendation Resource was last updated * **metadata** *(dict) --* Metadata associated with the Recommendation Resource * *(string) --* * *(string) --* * **recommendationArn** *(string) --* The Recommendation ARN * **regionCode** *(string) --* The AWS Region code that the Recommendation Resource is in * **status** *(string) --* The current status of the Recommendation Resource * **NextToken** *(string) --* A token to resume pagination. TrustedAdvisorPublicAPI / Paginator / ListOrganizationRecommendationResources ListOrganizationRecommendationResources *************************************** class TrustedAdvisorPublicAPI.Paginator.ListOrganizationRecommendationResources paginator = client.get_paginator('list_organization_recommendation_resources') paginate(**kwargs) Creates an iterator that will paginate through responses from " TrustedAdvisorPublicAPI.Client.list_organization_recommendation _resources()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( affectedAccountId='string', exclusionStatus='excluded'|'included', organizationRecommendationIdentifier='string', regionCode='string', status='ok'|'warning'|'error', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **affectedAccountId** (*string*) -- An account affected by this organization recommendation * **exclusionStatus** (*string*) -- The exclusion status of the resource * **organizationRecommendationIdentifier** (*string*) -- **[REQUIRED]** The AWS Organization organization's Recommendation identifier * **regionCode** (*string*) -- The AWS Region code of the resource * **status** (*string*) -- The status of the resource * **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** { 'organizationRecommendationResourceSummaries': [ { 'accountId': 'string', 'arn': 'string', 'awsResourceId': 'string', 'exclusionStatus': 'excluded'|'included', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'metadata': { 'string': 'string' }, 'recommendationArn': 'string', 'regionCode': 'string', 'status': 'ok'|'warning'|'error' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **organizationRecommendationResourceSummaries** *(list) --* A list of Recommendation Resources * *(dict) --* Organization Recommendation Resource Summary * **accountId** *(string) --* The AWS account ID * **arn** *(string) --* The ARN of the Recommendation Resource * **awsResourceId** *(string) --* The AWS resource identifier * **exclusionStatus** *(string) --* The exclusion status of the Recommendation Resource * **id** *(string) --* The ID of the Recommendation Resource * **lastUpdatedAt** *(datetime) --* When the Recommendation Resource was last updated * **metadata** *(dict) --* Metadata associated with the Recommendation Resource * *(string) --* * *(string) --* * **recommendationArn** *(string) --* The Recommendation ARN * **regionCode** *(string) --* The AWS Region code that the Recommendation Resource is in * **status** *(string) --* The current status of the Recommendation Resource * **NextToken** *(string) --* A token to resume pagination. TrustedAdvisorPublicAPI / Paginator / ListRecommendations ListRecommendations ******************* class TrustedAdvisorPublicAPI.Paginator.ListRecommendations paginator = client.get_paginator('list_recommendations') paginate(**kwargs) Creates an iterator that will paginate through responses from "TrustedAdvisorPublicAPI.Client.list_recommendations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( afterLastUpdatedAt=datetime(2015, 1, 1), awsService='string', beforeLastUpdatedAt=datetime(2015, 1, 1), checkIdentifier='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', status='ok'|'warning'|'error', type='standard'|'priority', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **afterLastUpdatedAt** (*datetime*) -- After the last update of the Recommendation * **awsService** (*string*) -- The aws service associated with the Recommendation * **beforeLastUpdatedAt** (*datetime*) -- Before the last update of the Recommendation * **checkIdentifier** (*string*) -- The check identifier of the Recommendation * **pillar** (*string*) -- The pillar of the Recommendation * **source** (*string*) -- The source of the Recommendation * **status** (*string*) -- The status of the Recommendation * **type** (*string*) -- The type of the Recommendation * **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** { 'recommendationSummaries': [ { 'arn': 'string', 'awsServices': [ 'string', ], 'checkArn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'lifecycleStage': 'in_progress'|'pending_response'|'dismissed'|'resolved', 'name': 'string', 'pillarSpecificAggregates': { 'costOptimizing': { 'estimatedMonthlySavings': 123.0, 'estimatedPercentMonthlySavings': 123.0 } }, 'pillars': [ 'cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence', ], 'resourcesAggregates': { 'errorCount': 123, 'okCount': 123, 'warningCount': 123 }, 'source': 'aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected', 'status': 'ok'|'warning'|'error', 'type': 'standard'|'priority' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **recommendationSummaries** *(list) --* The list of Recommendations * *(dict) --* Summary of Recommendation for an Account * **arn** *(string) --* The ARN of the Recommendation * **awsServices** *(list) --* The AWS Services that the Recommendation applies to * *(string) --* * **checkArn** *(string) --* The AWS Trusted Advisor Check ARN that relates to the Recommendation * **createdAt** *(datetime) --* When the Recommendation was created, if created by AWS Trusted Advisor Priority * **id** *(string) --* The ID which identifies where the Recommendation was produced * **lastUpdatedAt** *(datetime) --* When the Recommendation was last updated * **lifecycleStage** *(string) --* The lifecycle stage from AWS Trusted Advisor Priority * **name** *(string) --* The name of the AWS Trusted Advisor Recommendation * **pillarSpecificAggregates** *(dict) --* The pillar aggregations for cost savings * **costOptimizing** *(dict) --* Cost optimizing aggregates * **estimatedMonthlySavings** *(float) --* The estimated monthly savings * **estimatedPercentMonthlySavings** *(float) --* The estimated percently monthly savings * **pillars** *(list) --* The Pillars that the Recommendation is optimizing * *(string) --* * **resourcesAggregates** *(dict) --* An aggregation of all resources * **errorCount** *(integer) --* The number of AWS resources that were flagged to have errors according to the Trusted Advisor check * **okCount** *(integer) --* The number of AWS resources that were flagged to be OK according to the Trusted Advisor check * **warningCount** *(integer) --* The number of AWS resources that were flagged to have warning according to the Trusted Advisor check * **source** *(string) --* The source of the Recommendation * **status** *(string) --* The status of the Recommendation * **type** *(string) --* Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority * **NextToken** *(string) --* A token to resume pagination. 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. TrustedAdvisorPublicAPI / Paginator / ListOrganizationRecommendationAccounts ListOrganizationRecommendationAccounts ************************************** class TrustedAdvisorPublicAPI.Paginator.ListOrganizationRecommendationAccounts paginator = client.get_paginator('list_organization_recommendation_accounts') paginate(**kwargs) Creates an iterator that will paginate through responses from " TrustedAdvisorPublicAPI.Client.list_organization_recommendation _accounts()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( affectedAccountId='string', organizationRecommendationIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **affectedAccountId** (*string*) -- An account affected by this organization recommendation * **organizationRecommendationIdentifier** (*string*) -- **[REQUIRED]** The Recommendation identifier * **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** { 'accountRecommendationLifecycleSummaries': [ { 'accountId': 'string', 'accountRecommendationArn': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'lifecycleStage': 'in_progress'|'pending_response'|'dismissed'|'resolved', 'updateReason': 'string', 'updateReasonCode': 'non_critical_account'|'temporary_account'|'valid_business_case'|'other_methods_available'|'low_priority'|'not_applicable'|'other', 'updatedOnBehalfOf': 'string', 'updatedOnBehalfOfJobTitle': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **accountRecommendationLifecycleSummaries** *(list) --* The account recommendations lifecycles that are applicable to the Recommendation * *(dict) --* Summary of an AccountRecommendationLifecycle for an Organization Recommendation * **accountId** *(string) --* The AWS account ID * **accountRecommendationArn** *(string) --* The Recommendation ARN * **lastUpdatedAt** *(datetime) --* When the Recommendation was last updated * **lifecycleStage** *(string) --* The lifecycle stage from AWS Trusted Advisor Priority * **updateReason** *(string) --* Reason for the lifecycle stage change * **updateReasonCode** *(string) --* Reason code for the lifecycle state change * **updatedOnBehalfOf** *(string) --* The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority * **updatedOnBehalfOfJobTitle** *(string) --* The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority * **NextToken** *(string) --* A token to resume pagination. TrustedAdvisorPublicAPI / Paginator / ListOrganizationRecommendations ListOrganizationRecommendations ******************************* class TrustedAdvisorPublicAPI.Paginator.ListOrganizationRecommendations paginator = client.get_paginator('list_organization_recommendations') paginate(**kwargs) Creates an iterator that will paginate through responses from " TrustedAdvisorPublicAPI.Client.list_organization_recommendation s()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( afterLastUpdatedAt=datetime(2015, 1, 1), awsService='string', beforeLastUpdatedAt=datetime(2015, 1, 1), checkIdentifier='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', status='ok'|'warning'|'error', type='standard'|'priority', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **afterLastUpdatedAt** (*datetime*) -- After the last update of the Recommendation * **awsService** (*string*) -- The aws service associated with the Recommendation * **beforeLastUpdatedAt** (*datetime*) -- Before the last update of the Recommendation * **checkIdentifier** (*string*) -- The check identifier of the Recommendation * **pillar** (*string*) -- The pillar of the Recommendation * **source** (*string*) -- The source of the Recommendation * **status** (*string*) -- The status of the Recommendation * **type** (*string*) -- The type of the Recommendation * **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** { 'organizationRecommendationSummaries': [ { 'arn': 'string', 'awsServices': [ 'string', ], 'checkArn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'lifecycleStage': 'in_progress'|'pending_response'|'dismissed'|'resolved', 'name': 'string', 'pillarSpecificAggregates': { 'costOptimizing': { 'estimatedMonthlySavings': 123.0, 'estimatedPercentMonthlySavings': 123.0 } }, 'pillars': [ 'cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence', ], 'resourcesAggregates': { 'errorCount': 123, 'okCount': 123, 'warningCount': 123 }, 'source': 'aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected', 'status': 'ok'|'warning'|'error', 'type': 'standard'|'priority' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **organizationRecommendationSummaries** *(list) --* The list of Recommendations * *(dict) --* Summary of recommendation for accounts within an Organization * **arn** *(string) --* The ARN of the Recommendation * **awsServices** *(list) --* The AWS Services that the Recommendation applies to * *(string) --* * **checkArn** *(string) --* The AWS Trusted Advisor Check ARN that relates to the Recommendation * **createdAt** *(datetime) --* When the Recommendation was created, if created by AWS Trusted Advisor Priority * **id** *(string) --* The ID which identifies where the Recommendation was produced * **lastUpdatedAt** *(datetime) --* When the Recommendation was last updated * **lifecycleStage** *(string) --* The lifecycle stage from AWS Trusted Advisor Priority * **name** *(string) --* The name of the AWS Trusted Advisor Recommendation * **pillarSpecificAggregates** *(dict) --* The pillar aggregations for cost savings * **costOptimizing** *(dict) --* Cost optimizing aggregates * **estimatedMonthlySavings** *(float) --* The estimated monthly savings * **estimatedPercentMonthlySavings** *(float) --* The estimated percently monthly savings * **pillars** *(list) --* The Pillars that the Recommendation is optimizing * *(string) --* * **resourcesAggregates** *(dict) --* An aggregation of all resources * **errorCount** *(integer) --* The number of AWS resources that were flagged to have errors according to the Trusted Advisor check * **okCount** *(integer) --* The number of AWS resources that were flagged to be OK according to the Trusted Advisor check * **warningCount** *(integer) --* The number of AWS resources that were flagged to have warning according to the Trusted Advisor check * **source** *(string) --* The source of the Recommendation * **status** *(string) --* The status of the Recommendation * **type** *(string) --* Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority * **NextToken** *(string) --* A token to resume pagination. TrustedAdvisorPublicAPI / Client / get_paginator get_paginator ************* TrustedAdvisorPublicAPI.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. TrustedAdvisorPublicAPI / Client / batch_update_recommendation_resource_exclusion batch_update_recommendation_resource_exclusion ********************************************** TrustedAdvisorPublicAPI.Client.batch_update_recommendation_resource_exclusion(**kwargs) Update one or more exclusion status for a list of recommendation resources See also: AWS API Documentation **Request Syntax** response = client.batch_update_recommendation_resource_exclusion( recommendationResourceExclusions=[ { 'arn': 'string', 'isExcluded': True|False }, ] ) Parameters: **recommendationResourceExclusions** (*list*) -- **[REQUIRED]** A list of recommendation resource ARNs and exclusion status to update * *(dict) --* The request entry for Recommendation Resource exclusion. Each entry is a combination of Recommendation Resource ARN and corresponding exclusion status * **arn** *(string) --* **[REQUIRED]** The ARN of the Recommendation Resource * **isExcluded** *(boolean) --* **[REQUIRED]** The exclusion status Return type: dict Returns: **Response Syntax** { 'batchUpdateRecommendationResourceExclusionErrors': [ { 'arn': 'string', 'errorCode': 'string', 'errorMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **batchUpdateRecommendationResourceExclusionErrors** *(list) --* A list of recommendation resource ARNs whose exclusion status failed to update, if any * *(dict) --* The error entry for Recommendation Resource exclusion. Each entry is a combination of Recommendation Resource ARN, error code and error message * **arn** *(string) --* The ARN of the Recommendation Resource * **errorCode** *(string) --* The error code * **errorMessage** *(string) --* The error message **Exceptions** * "TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException" * "TrustedAdvisorPublicAPI.Client.exceptions.ConflictException" * "TrustedAdvisorPublicAPI.Client.exceptions.InternalServerExcepti on" * "TrustedAdvisorPublicAPI.Client.exceptions.ValidationException" * "TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException" TrustedAdvisorPublicAPI / Client / list_recommendation_resources list_recommendation_resources ***************************** TrustedAdvisorPublicAPI.Client.list_recommendation_resources(**kwargs) List Resources of a Recommendation See also: AWS API Documentation **Request Syntax** response = client.list_recommendation_resources( exclusionStatus='excluded'|'included', maxResults=123, nextToken='string', recommendationIdentifier='string', regionCode='string', status='ok'|'warning'|'error' ) Parameters: * **exclusionStatus** (*string*) -- The exclusion status of the resource * **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. * **recommendationIdentifier** (*string*) -- **[REQUIRED]** The Recommendation identifier * **regionCode** (*string*) -- The AWS Region code of the resource * **status** (*string*) -- The status of the resource Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'recommendationResourceSummaries': [ { 'arn': 'string', 'awsResourceId': 'string', 'exclusionStatus': 'excluded'|'included', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'metadata': { 'string': 'string' }, 'recommendationArn': 'string', 'regionCode': 'string', 'status': 'ok'|'warning'|'error' }, ] } **Response Structure** * *(dict) --* * **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. * **recommendationResourceSummaries** *(list) --* A list of Recommendation Resources * *(dict) --* Summary of a Recommendation Resource * **arn** *(string) --* The ARN of the Recommendation Resource * **awsResourceId** *(string) --* The AWS resource identifier * **exclusionStatus** *(string) --* The exclusion status of the Recommendation Resource * **id** *(string) --* The ID of the Recommendation Resource * **lastUpdatedAt** *(datetime) --* When the Recommendation Resource was last updated * **metadata** *(dict) --* Metadata associated with the Recommendation Resource * *(string) --* * *(string) --* * **recommendationArn** *(string) --* The Recommendation ARN * **regionCode** *(string) --* The AWS Region code that the Recommendation Resource is in * **status** *(string) --* The current status of the Recommendation Resource **Exceptions** * "TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException" * "TrustedAdvisorPublicAPI.Client.exceptions.InternalServerExcepti on" * "TrustedAdvisorPublicAPI.Client.exceptions.ValidationException" * "TrustedAdvisorPublicAPI.Client.exceptions.ResourceNotFoundExcep tion" * "TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException" TrustedAdvisorPublicAPI / Client / can_paginate can_paginate ************ TrustedAdvisorPublicAPI.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. TrustedAdvisorPublicAPI / Client / list_organization_recommendations list_organization_recommendations ********************************* TrustedAdvisorPublicAPI.Client.list_organization_recommendations(**kwargs) List a filterable set of Recommendations within an Organization. This API only supports prioritized recommendations. See also: AWS API Documentation **Request Syntax** response = client.list_organization_recommendations( afterLastUpdatedAt=datetime(2015, 1, 1), awsService='string', beforeLastUpdatedAt=datetime(2015, 1, 1), checkIdentifier='string', 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', status='ok'|'warning'|'error', type='standard'|'priority' ) Parameters: * **afterLastUpdatedAt** (*datetime*) -- After the last update of the Recommendation * **awsService** (*string*) -- The aws service associated with the Recommendation * **beforeLastUpdatedAt** (*datetime*) -- Before the last update of the Recommendation * **checkIdentifier** (*string*) -- The check identifier of the Recommendation * **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 Recommendation * **source** (*string*) -- The source of the Recommendation * **status** (*string*) -- The status of the Recommendation * **type** (*string*) -- The type of the Recommendation Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'organizationRecommendationSummaries': [ { 'arn': 'string', 'awsServices': [ 'string', ], 'checkArn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'lifecycleStage': 'in_progress'|'pending_response'|'dismissed'|'resolved', 'name': 'string', 'pillarSpecificAggregates': { 'costOptimizing': { 'estimatedMonthlySavings': 123.0, 'estimatedPercentMonthlySavings': 123.0 } }, 'pillars': [ 'cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence', ], 'resourcesAggregates': { 'errorCount': 123, 'okCount': 123, 'warningCount': 123 }, 'source': 'aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected', 'status': 'ok'|'warning'|'error', 'type': 'standard'|'priority' }, ] } **Response Structure** * *(dict) --* * **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. * **organizationRecommendationSummaries** *(list) --* The list of Recommendations * *(dict) --* Summary of recommendation for accounts within an Organization * **arn** *(string) --* The ARN of the Recommendation * **awsServices** *(list) --* The AWS Services that the Recommendation applies to * *(string) --* * **checkArn** *(string) --* The AWS Trusted Advisor Check ARN that relates to the Recommendation * **createdAt** *(datetime) --* When the Recommendation was created, if created by AWS Trusted Advisor Priority * **id** *(string) --* The ID which identifies where the Recommendation was produced * **lastUpdatedAt** *(datetime) --* When the Recommendation was last updated * **lifecycleStage** *(string) --* The lifecycle stage from AWS Trusted Advisor Priority * **name** *(string) --* The name of the AWS Trusted Advisor Recommendation * **pillarSpecificAggregates** *(dict) --* The pillar aggregations for cost savings * **costOptimizing** *(dict) --* Cost optimizing aggregates * **estimatedMonthlySavings** *(float) --* The estimated monthly savings * **estimatedPercentMonthlySavings** *(float) --* The estimated percently monthly savings * **pillars** *(list) --* The Pillars that the Recommendation is optimizing * *(string) --* * **resourcesAggregates** *(dict) --* An aggregation of all resources * **errorCount** *(integer) --* The number of AWS resources that were flagged to have errors according to the Trusted Advisor check * **okCount** *(integer) --* The number of AWS resources that were flagged to be OK according to the Trusted Advisor check * **warningCount** *(integer) --* The number of AWS resources that were flagged to have warning according to the Trusted Advisor check * **source** *(string) --* The source of the Recommendation * **status** *(string) --* The status of the Recommendation * **type** *(string) --* Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority **Exceptions** * "TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException" * "TrustedAdvisorPublicAPI.Client.exceptions.InternalServerExcepti on" * "TrustedAdvisorPublicAPI.Client.exceptions.ValidationException" * "TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException" TrustedAdvisorPublicAPI / Client / list_organization_recommendation_resources list_organization_recommendation_resources ****************************************** TrustedAdvisorPublicAPI.Client.list_organization_recommendation_resources(**kwargs) List Resources of a Recommendation within an Organization. This API only supports prioritized recommendations. See also: AWS API Documentation **Request Syntax** response = client.list_organization_recommendation_resources( affectedAccountId='string', exclusionStatus='excluded'|'included', maxResults=123, nextToken='string', organizationRecommendationIdentifier='string', regionCode='string', status='ok'|'warning'|'error' ) Parameters: * **affectedAccountId** (*string*) -- An account affected by this organization recommendation * **exclusionStatus** (*string*) -- The exclusion status of the resource * **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. * **organizationRecommendationIdentifier** (*string*) -- **[REQUIRED]** The AWS Organization organization's Recommendation identifier * **regionCode** (*string*) -- The AWS Region code of the resource * **status** (*string*) -- The status of the resource Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'organizationRecommendationResourceSummaries': [ { 'accountId': 'string', 'arn': 'string', 'awsResourceId': 'string', 'exclusionStatus': 'excluded'|'included', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'metadata': { 'string': 'string' }, 'recommendationArn': 'string', 'regionCode': 'string', 'status': 'ok'|'warning'|'error' }, ] } **Response Structure** * *(dict) --* * **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. * **organizationRecommendationResourceSummaries** *(list) --* A list of Recommendation Resources * *(dict) --* Organization Recommendation Resource Summary * **accountId** *(string) --* The AWS account ID * **arn** *(string) --* The ARN of the Recommendation Resource * **awsResourceId** *(string) --* The AWS resource identifier * **exclusionStatus** *(string) --* The exclusion status of the Recommendation Resource * **id** *(string) --* The ID of the Recommendation Resource * **lastUpdatedAt** *(datetime) --* When the Recommendation Resource was last updated * **metadata** *(dict) --* Metadata associated with the Recommendation Resource * *(string) --* * *(string) --* * **recommendationArn** *(string) --* The Recommendation ARN * **regionCode** *(string) --* The AWS Region code that the Recommendation Resource is in * **status** *(string) --* The current status of the Recommendation Resource **Exceptions** * "TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException" * "TrustedAdvisorPublicAPI.Client.exceptions.InternalServerExcepti on" * "TrustedAdvisorPublicAPI.Client.exceptions.ValidationException" * "TrustedAdvisorPublicAPI.Client.exceptions.ResourceNotFoundExcep tion" * "TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException" TrustedAdvisorPublicAPI / Client / get_waiter get_waiter ********** TrustedAdvisorPublicAPI.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" TrustedAdvisorPublicAPI / Client / update_organization_recommendation_lifecycle update_organization_recommendation_lifecycle ******************************************** TrustedAdvisorPublicAPI.Client.update_organization_recommendation_lifecycle(**kwargs) Update the lifecycle of a Recommendation within an Organization. This API only supports prioritized recommendations. See also: AWS API Documentation **Request Syntax** response = client.update_organization_recommendation_lifecycle( lifecycleStage='pending_response'|'in_progress'|'dismissed'|'resolved', organizationRecommendationIdentifier='string', updateReason='string', updateReasonCode='non_critical_account'|'temporary_account'|'valid_business_case'|'other_methods_available'|'low_priority'|'not_applicable'|'other' ) Parameters: * **lifecycleStage** (*string*) -- **[REQUIRED]** The new lifecycle stage * **organizationRecommendationIdentifier** (*string*) -- **[REQUIRED]** The Recommendation identifier for AWS Trusted Advisor Priority recommendations * **updateReason** (*string*) -- Reason for the lifecycle stage change * **updateReasonCode** (*string*) -- Reason code for the lifecycle state change Returns: None **Exceptions** * "TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException" * "TrustedAdvisorPublicAPI.Client.exceptions.ConflictException" * "TrustedAdvisorPublicAPI.Client.exceptions.InternalServerExcepti on" * "TrustedAdvisorPublicAPI.Client.exceptions.ValidationException" * "TrustedAdvisorPublicAPI.Client.exceptions.ResourceNotFoundExcep tion" * "TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException" TrustedAdvisorPublicAPI / Client / list_organization_recommendation_accounts list_organization_recommendation_accounts ***************************************** TrustedAdvisorPublicAPI.Client.list_organization_recommendation_accounts(**kwargs) Lists the accounts that own the resources for an organization aggregate recommendation. This API only supports prioritized recommendations. See also: AWS API Documentation **Request Syntax** response = client.list_organization_recommendation_accounts( affectedAccountId='string', maxResults=123, nextToken='string', organizationRecommendationIdentifier='string' ) Parameters: * **affectedAccountId** (*string*) -- An account affected by this organization recommendation * **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. * **organizationRecommendationIdentifier** (*string*) -- **[REQUIRED]** The Recommendation identifier Return type: dict Returns: **Response Syntax** { 'accountRecommendationLifecycleSummaries': [ { 'accountId': 'string', 'accountRecommendationArn': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'lifecycleStage': 'in_progress'|'pending_response'|'dismissed'|'resolved', 'updateReason': 'string', 'updateReasonCode': 'non_critical_account'|'temporary_account'|'valid_business_case'|'other_methods_available'|'low_priority'|'not_applicable'|'other', 'updatedOnBehalfOf': 'string', 'updatedOnBehalfOfJobTitle': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **accountRecommendationLifecycleSummaries** *(list) --* The account recommendations lifecycles that are applicable to the Recommendation * *(dict) --* Summary of an AccountRecommendationLifecycle for an Organization Recommendation * **accountId** *(string) --* The AWS account ID * **accountRecommendationArn** *(string) --* The Recommendation ARN * **lastUpdatedAt** *(datetime) --* When the Recommendation was last updated * **lifecycleStage** *(string) --* The lifecycle stage from AWS Trusted Advisor Priority * **updateReason** *(string) --* Reason for the lifecycle stage change * **updateReasonCode** *(string) --* Reason code for the lifecycle state change * **updatedOnBehalfOf** *(string) --* The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority * **updatedOnBehalfOfJobTitle** *(string) --* The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority * **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.InternalServerExcepti on" * "TrustedAdvisorPublicAPI.Client.exceptions.ValidationException" * "TrustedAdvisorPublicAPI.Client.exceptions.ResourceNotFoundExcep tion" * "TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException" TrustedAdvisorPublicAPI / Client / update_recommendation_lifecycle update_recommendation_lifecycle ******************************* TrustedAdvisorPublicAPI.Client.update_recommendation_lifecycle(**kwargs) Update the lifecyle of a Recommendation. This API only supports prioritized recommendations. See also: AWS API Documentation **Request Syntax** response = client.update_recommendation_lifecycle( lifecycleStage='pending_response'|'in_progress'|'dismissed'|'resolved', recommendationIdentifier='string', updateReason='string', updateReasonCode='non_critical_account'|'temporary_account'|'valid_business_case'|'other_methods_available'|'low_priority'|'not_applicable'|'other' ) Parameters: * **lifecycleStage** (*string*) -- **[REQUIRED]** The new lifecycle stage * **recommendationIdentifier** (*string*) -- **[REQUIRED]** The Recommendation identifier for AWS Trusted Advisor Priority recommendations * **updateReason** (*string*) -- Reason for the lifecycle stage change * **updateReasonCode** (*string*) -- Reason code for the lifecycle state change Returns: None **Exceptions** * "TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException" * "TrustedAdvisorPublicAPI.Client.exceptions.ConflictException" * "TrustedAdvisorPublicAPI.Client.exceptions.InternalServerExcepti on" * "TrustedAdvisorPublicAPI.Client.exceptions.ValidationException" * "TrustedAdvisorPublicAPI.Client.exceptions.ResourceNotFoundExcep tion" * "TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException" TrustedAdvisorPublicAPI / Client / close close ***** TrustedAdvisorPublicAPI.Client.close() Closes underlying endpoint connections. TrustedAdvisorPublicAPI / Client / get_organization_recommendation get_organization_recommendation ******************************* TrustedAdvisorPublicAPI.Client.get_organization_recommendation(**kwargs) Get a specific recommendation within an AWS Organizations organization. This API supports only prioritized recommendations. See also: AWS API Documentation **Request Syntax** response = client.get_organization_recommendation( organizationRecommendationIdentifier='string' ) Parameters: **organizationRecommendationIdentifier** (*string*) -- **[REQUIRED]** The Recommendation identifier Return type: dict Returns: **Response Syntax** { 'organizationRecommendation': { 'arn': 'string', 'awsServices': [ 'string', ], 'checkArn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'lifecycleStage': 'in_progress'|'pending_response'|'dismissed'|'resolved', 'name': 'string', 'pillarSpecificAggregates': { 'costOptimizing': { 'estimatedMonthlySavings': 123.0, 'estimatedPercentMonthlySavings': 123.0 } }, 'pillars': [ 'cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence', ], 'resolvedAt': datetime(2015, 1, 1), 'resourcesAggregates': { 'errorCount': 123, 'okCount': 123, 'warningCount': 123 }, 'source': 'aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected', 'status': 'ok'|'warning'|'error', 'type': 'standard'|'priority', 'updateReason': 'string', 'updateReasonCode': 'non_critical_account'|'temporary_account'|'valid_business_case'|'other_methods_available'|'low_priority'|'not_applicable'|'other', 'updatedOnBehalfOf': 'string', 'updatedOnBehalfOfJobTitle': 'string' } } **Response Structure** * *(dict) --* * **organizationRecommendation** *(dict) --* The Recommendation * **arn** *(string) --* The ARN of the Recommendation * **awsServices** *(list) --* The AWS Services that the Recommendation applies to * *(string) --* * **checkArn** *(string) --* The AWS Trusted Advisor Check ARN that relates to the Recommendation * **createdAt** *(datetime) --* When the Recommendation was created, if created by AWS Trusted Advisor Priority * **createdBy** *(string) --* The creator, if created by AWS Trusted Advisor Priority * **description** *(string) --* A description for AWS Trusted Advisor recommendations * **id** *(string) --* The ID which identifies where the Recommendation was produced * **lastUpdatedAt** *(datetime) --* When the Recommendation was last updated * **lifecycleStage** *(string) --* The lifecycle stage from AWS Trusted Advisor Priority * **name** *(string) --* The name of the AWS Trusted Advisor Recommendation * **pillarSpecificAggregates** *(dict) --* The pillar aggregations for cost savings * **costOptimizing** *(dict) --* Cost optimizing aggregates * **estimatedMonthlySavings** *(float) --* The estimated monthly savings * **estimatedPercentMonthlySavings** *(float) --* The estimated percently monthly savings * **pillars** *(list) --* The Pillars that the Recommendation is optimizing * *(string) --* * **resolvedAt** *(datetime) --* When the Recommendation was resolved * **resourcesAggregates** *(dict) --* An aggregation of all resources * **errorCount** *(integer) --* The number of AWS resources that were flagged to have errors according to the Trusted Advisor check * **okCount** *(integer) --* The number of AWS resources that were flagged to be OK according to the Trusted Advisor check * **warningCount** *(integer) --* The number of AWS resources that were flagged to have warning according to the Trusted Advisor check * **source** *(string) --* The source of the Recommendation * **status** *(string) --* The status of the Recommendation * **type** *(string) --* Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority * **updateReason** *(string) --* Reason for the lifecycle stage change * **updateReasonCode** *(string) --* Reason code for the lifecycle state change * **updatedOnBehalfOf** *(string) --* The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority * **updatedOnBehalfOfJobTitle** *(string) --* The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority **Exceptions** * "TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException" * "TrustedAdvisorPublicAPI.Client.exceptions.InternalServerExcepti on" * "TrustedAdvisorPublicAPI.Client.exceptions.ValidationException" * "TrustedAdvisorPublicAPI.Client.exceptions.ResourceNotFoundExcep tion" * "TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException" TrustedAdvisorPublicAPI / Client / list_recommendations list_recommendations ******************** TrustedAdvisorPublicAPI.Client.list_recommendations(**kwargs) List a filterable set of Recommendations See also: AWS API Documentation **Request Syntax** response = client.list_recommendations( afterLastUpdatedAt=datetime(2015, 1, 1), awsService='string', beforeLastUpdatedAt=datetime(2015, 1, 1), checkIdentifier='string', 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', status='ok'|'warning'|'error', type='standard'|'priority' ) Parameters: * **afterLastUpdatedAt** (*datetime*) -- After the last update of the Recommendation * **awsService** (*string*) -- The aws service associated with the Recommendation * **beforeLastUpdatedAt** (*datetime*) -- Before the last update of the Recommendation * **checkIdentifier** (*string*) -- The check identifier of the Recommendation * **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 Recommendation * **source** (*string*) -- The source of the Recommendation * **status** (*string*) -- The status of the Recommendation * **type** (*string*) -- The type of the Recommendation Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'recommendationSummaries': [ { 'arn': 'string', 'awsServices': [ 'string', ], 'checkArn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'lifecycleStage': 'in_progress'|'pending_response'|'dismissed'|'resolved', 'name': 'string', 'pillarSpecificAggregates': { 'costOptimizing': { 'estimatedMonthlySavings': 123.0, 'estimatedPercentMonthlySavings': 123.0 } }, 'pillars': [ 'cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence', ], 'resourcesAggregates': { 'errorCount': 123, 'okCount': 123, 'warningCount': 123 }, 'source': 'aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected', 'status': 'ok'|'warning'|'error', 'type': 'standard'|'priority' }, ] } **Response Structure** * *(dict) --* * **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. * **recommendationSummaries** *(list) --* The list of Recommendations * *(dict) --* Summary of Recommendation for an Account * **arn** *(string) --* The ARN of the Recommendation * **awsServices** *(list) --* The AWS Services that the Recommendation applies to * *(string) --* * **checkArn** *(string) --* The AWS Trusted Advisor Check ARN that relates to the Recommendation * **createdAt** *(datetime) --* When the Recommendation was created, if created by AWS Trusted Advisor Priority * **id** *(string) --* The ID which identifies where the Recommendation was produced * **lastUpdatedAt** *(datetime) --* When the Recommendation was last updated * **lifecycleStage** *(string) --* The lifecycle stage from AWS Trusted Advisor Priority * **name** *(string) --* The name of the AWS Trusted Advisor Recommendation * **pillarSpecificAggregates** *(dict) --* The pillar aggregations for cost savings * **costOptimizing** *(dict) --* Cost optimizing aggregates * **estimatedMonthlySavings** *(float) --* The estimated monthly savings * **estimatedPercentMonthlySavings** *(float) --* The estimated percently monthly savings * **pillars** *(list) --* The Pillars that the Recommendation is optimizing * *(string) --* * **resourcesAggregates** *(dict) --* An aggregation of all resources * **errorCount** *(integer) --* The number of AWS resources that were flagged to have errors according to the Trusted Advisor check * **okCount** *(integer) --* The number of AWS resources that were flagged to be OK according to the Trusted Advisor check * **warningCount** *(integer) --* The number of AWS resources that were flagged to have warning according to the Trusted Advisor check * **source** *(string) --* The source of the Recommendation * **status** *(string) --* The status of the Recommendation * **type** *(string) --* Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority **Exceptions** * "TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException" * "TrustedAdvisorPublicAPI.Client.exceptions.InternalServerExcepti on" * "TrustedAdvisorPublicAPI.Client.exceptions.ValidationException" * "TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException" TrustedAdvisorPublicAPI / Client / get_recommendation get_recommendation ****************** TrustedAdvisorPublicAPI.Client.get_recommendation(**kwargs) Get a specific Recommendation See also: AWS API Documentation **Request Syntax** response = client.get_recommendation( recommendationIdentifier='string' ) Parameters: **recommendationIdentifier** (*string*) -- **[REQUIRED]** The Recommendation identifier Return type: dict Returns: **Response Syntax** { 'recommendation': { 'arn': 'string', 'awsServices': [ 'string', ], 'checkArn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'lifecycleStage': 'in_progress'|'pending_response'|'dismissed'|'resolved', 'name': 'string', 'pillarSpecificAggregates': { 'costOptimizing': { 'estimatedMonthlySavings': 123.0, 'estimatedPercentMonthlySavings': 123.0 } }, 'pillars': [ 'cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence', ], 'resolvedAt': datetime(2015, 1, 1), 'resourcesAggregates': { 'errorCount': 123, 'okCount': 123, 'warningCount': 123 }, 'source': 'aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected', 'status': 'ok'|'warning'|'error', 'type': 'standard'|'priority', 'updateReason': 'string', 'updateReasonCode': 'non_critical_account'|'temporary_account'|'valid_business_case'|'other_methods_available'|'low_priority'|'not_applicable'|'other', 'updatedOnBehalfOf': 'string', 'updatedOnBehalfOfJobTitle': 'string' } } **Response Structure** * *(dict) --* * **recommendation** *(dict) --* The Recommendation * **arn** *(string) --* The ARN of the Recommendation * **awsServices** *(list) --* The AWS Services that the Recommendation applies to * *(string) --* * **checkArn** *(string) --* The AWS Trusted Advisor Check ARN that relates to the Recommendation * **createdAt** *(datetime) --* When the Recommendation was created, if created by AWS Trusted Advisor Priority * **createdBy** *(string) --* The creator, if created by AWS Trusted Advisor Priority * **description** *(string) --* A description for AWS Trusted Advisor recommendations * **id** *(string) --* The ID which identifies where the Recommendation was produced * **lastUpdatedAt** *(datetime) --* When the Recommendation was last updated * **lifecycleStage** *(string) --* The lifecycle stage from AWS Trusted Advisor Priority * **name** *(string) --* The name of the AWS Trusted Advisor Recommendation * **pillarSpecificAggregates** *(dict) --* The pillar aggregations for cost savings * **costOptimizing** *(dict) --* Cost optimizing aggregates * **estimatedMonthlySavings** *(float) --* The estimated monthly savings * **estimatedPercentMonthlySavings** *(float) --* The estimated percently monthly savings * **pillars** *(list) --* The Pillars that the Recommendation is optimizing * *(string) --* * **resolvedAt** *(datetime) --* When the Recommendation was resolved * **resourcesAggregates** *(dict) --* An aggregation of all resources * **errorCount** *(integer) --* The number of AWS resources that were flagged to have errors according to the Trusted Advisor check * **okCount** *(integer) --* The number of AWS resources that were flagged to be OK according to the Trusted Advisor check * **warningCount** *(integer) --* The number of AWS resources that were flagged to have warning according to the Trusted Advisor check * **source** *(string) --* The source of the Recommendation * **status** *(string) --* The status of the Recommendation * **type** *(string) --* Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority * **updateReason** *(string) --* Reason for the lifecycle stage change * **updateReasonCode** *(string) --* Reason code for the lifecycle state change * **updatedOnBehalfOf** *(string) --* The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority * **updatedOnBehalfOfJobTitle** *(string) --* The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority **Exceptions** * "TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException" * "TrustedAdvisorPublicAPI.Client.exceptions.InternalServerExcepti on" * "TrustedAdvisorPublicAPI.Client.exceptions.ValidationException" * "TrustedAdvisorPublicAPI.Client.exceptions.ResourceNotFoundExcep tion" * "TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException" 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.InternalServerExcepti on" * "TrustedAdvisorPublicAPI.Client.exceptions.ValidationException" * "TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException"