TrustedAdvisorPublicAPIClient#
Index > TrustedAdvisorPublicAPI > TrustedAdvisorPublicAPIClient
Auto-generated documentation for TrustedAdvisorPublicAPI type annotations stubs module types-aiobotocore-trustedadvisor.
TrustedAdvisorPublicAPIClient#
Type annotations and code completion for session.client("trustedadvisor")
boto3 documentation
# TrustedAdvisorPublicAPIClient usage example
from aioboto3.session import Session
from types_aiobotocore_trustedadvisor.client import TrustedAdvisorPublicAPIClient
session = Session()
async with session.client("trustedadvisor") as client:
client: TrustedAdvisorPublicAPIClient
Exceptions#
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("trustedadvisor").exceptions
structure.
# TrustedAdvisorPublicAPIClient.exceptions usage example
async with session.client("trustedadvisor") as client:
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# TrustedAdvisorPublicAPIClient.exceptions type checking example
from types_aiobotocore_trustedadvisor.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.client("trustedadvisor").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.client("trustedadvisor").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("trustedadvisor").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_organization_recommendation#
Get a specific recommendation within an AWS Organizations organization.
Type annotations and code completion for session.client("trustedadvisor").get_organization_recommendation
method.
boto3 documentation
# get_organization_recommendation method definition
await def get_organization_recommendation(
self,
*,
organizationRecommendationIdentifier: str,
) -> GetOrganizationRecommendationResponseTypeDef: # (1)
...
# get_organization_recommendation method usage example with argument unpacking
kwargs: GetOrganizationRecommendationRequestRequestTypeDef = { # (1)
"organizationRecommendationIdentifier": ...,
}
parent.get_organization_recommendation(**kwargs)
get_recommendation#
Get a specific Recommendation See also: AWS API Documentation.
Type annotations and code completion for session.client("trustedadvisor").get_recommendation
method.
boto3 documentation
# get_recommendation method definition
await def get_recommendation(
self,
*,
recommendationIdentifier: str,
) -> GetRecommendationResponseTypeDef: # (1)
...
# get_recommendation method usage example with argument unpacking
kwargs: GetRecommendationRequestRequestTypeDef = { # (1)
"recommendationIdentifier": ...,
}
parent.get_recommendation(**kwargs)
list_checks#
List a filterable set of Checks See also: AWS API Documentation.
Type annotations and code completion for session.client("trustedadvisor").list_checks
method.
boto3 documentation
# list_checks method definition
await def list_checks(
self,
*,
awsService: str = ...,
language: RecommendationLanguageType = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
pillar: RecommendationPillarType = ..., # (2)
source: RecommendationSourceType = ..., # (3)
) -> ListChecksResponseTypeDef: # (4)
...
- See RecommendationLanguageType
- See RecommendationPillarType
- See RecommendationSourceType
- See ListChecksResponseTypeDef
# list_checks method usage example with argument unpacking
kwargs: ListChecksRequestRequestTypeDef = { # (1)
"awsService": ...,
}
parent.list_checks(**kwargs)
list_organization_recommendation_accounts#
Lists the accounts that own the resources for an organization aggregate recommendation.
Type annotations and code completion for session.client("trustedadvisor").list_organization_recommendation_accounts
method.
boto3 documentation
# list_organization_recommendation_accounts method definition
await def list_organization_recommendation_accounts(
self,
*,
organizationRecommendationIdentifier: str,
affectedAccountId: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListOrganizationRecommendationAccountsResponseTypeDef: # (1)
...
# list_organization_recommendation_accounts method usage example with argument unpacking
kwargs: ListOrganizationRecommendationAccountsRequestRequestTypeDef = { # (1)
"organizationRecommendationIdentifier": ...,
}
parent.list_organization_recommendation_accounts(**kwargs)
list_organization_recommendation_resources#
List Resources of a Recommendation within an Organization.
Type annotations and code completion for session.client("trustedadvisor").list_organization_recommendation_resources
method.
boto3 documentation
# list_organization_recommendation_resources method definition
await def list_organization_recommendation_resources(
self,
*,
organizationRecommendationIdentifier: str,
affectedAccountId: str = ...,
maxResults: int = ...,
nextToken: str = ...,
regionCode: str = ...,
status: ResourceStatusType = ..., # (1)
) -> ListOrganizationRecommendationResourcesResponseTypeDef: # (2)
...
# list_organization_recommendation_resources method usage example with argument unpacking
kwargs: ListOrganizationRecommendationResourcesRequestRequestTypeDef = { # (1)
"organizationRecommendationIdentifier": ...,
}
parent.list_organization_recommendation_resources(**kwargs)
list_organization_recommendations#
List a filterable set of Recommendations within an Organization.
Type annotations and code completion for session.client("trustedadvisor").list_organization_recommendations
method.
boto3 documentation
# list_organization_recommendations method definition
await def list_organization_recommendations(
self,
*,
afterLastUpdatedAt: Union[datetime, str] = ...,
awsService: str = ...,
beforeLastUpdatedAt: Union[datetime, str] = ...,
checkIdentifier: str = ...,
maxResults: int = ...,
nextToken: str = ...,
pillar: RecommendationPillarType = ..., # (1)
source: RecommendationSourceType = ..., # (2)
status: RecommendationStatusType = ..., # (3)
type: RecommendationTypeType = ..., # (4)
) -> ListOrganizationRecommendationsResponseTypeDef: # (5)
...
- See RecommendationPillarType
- See RecommendationSourceType
- See RecommendationStatusType
- See RecommendationTypeType
- See ListOrganizationRecommendationsResponseTypeDef
# list_organization_recommendations method usage example with argument unpacking
kwargs: ListOrganizationRecommendationsRequestRequestTypeDef = { # (1)
"afterLastUpdatedAt": ...,
}
parent.list_organization_recommendations(**kwargs)
list_recommendation_resources#
List Resources of a Recommendation See also: AWS API Documentation.
Type annotations and code completion for session.client("trustedadvisor").list_recommendation_resources
method.
boto3 documentation
# list_recommendation_resources method definition
await def list_recommendation_resources(
self,
*,
recommendationIdentifier: str,
maxResults: int = ...,
nextToken: str = ...,
regionCode: str = ...,
status: ResourceStatusType = ..., # (1)
) -> ListRecommendationResourcesResponseTypeDef: # (2)
...
# list_recommendation_resources method usage example with argument unpacking
kwargs: ListRecommendationResourcesRequestRequestTypeDef = { # (1)
"recommendationIdentifier": ...,
}
parent.list_recommendation_resources(**kwargs)
list_recommendations#
List a filterable set of Recommendations See also: AWS API Documentation.
Type annotations and code completion for session.client("trustedadvisor").list_recommendations
method.
boto3 documentation
# list_recommendations method definition
await def list_recommendations(
self,
*,
afterLastUpdatedAt: Union[datetime, str] = ...,
awsService: str = ...,
beforeLastUpdatedAt: Union[datetime, str] = ...,
checkIdentifier: str = ...,
maxResults: int = ...,
nextToken: str = ...,
pillar: RecommendationPillarType = ..., # (1)
source: RecommendationSourceType = ..., # (2)
status: RecommendationStatusType = ..., # (3)
type: RecommendationTypeType = ..., # (4)
) -> ListRecommendationsResponseTypeDef: # (5)
...
- See RecommendationPillarType
- See RecommendationSourceType
- See RecommendationStatusType
- See RecommendationTypeType
- See ListRecommendationsResponseTypeDef
# list_recommendations method usage example with argument unpacking
kwargs: ListRecommendationsRequestRequestTypeDef = { # (1)
"afterLastUpdatedAt": ...,
}
parent.list_recommendations(**kwargs)
update_organization_recommendation_lifecycle#
Update the lifecyle of a Recommendation within an Organization.
Type annotations and code completion for session.client("trustedadvisor").update_organization_recommendation_lifecycle
method.
boto3 documentation
# update_organization_recommendation_lifecycle method definition
await def update_organization_recommendation_lifecycle(
self,
*,
lifecycleStage: UpdateRecommendationLifecycleStageType, # (1)
organizationRecommendationIdentifier: str,
updateReason: str = ...,
updateReasonCode: UpdateRecommendationLifecycleStageReasonCodeType = ..., # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...
- See UpdateRecommendationLifecycleStageType
- See UpdateRecommendationLifecycleStageReasonCodeType
- See EmptyResponseMetadataTypeDef
# update_organization_recommendation_lifecycle method usage example with argument unpacking
kwargs: UpdateOrganizationRecommendationLifecycleRequestRequestTypeDef = { # (1)
"lifecycleStage": ...,
"organizationRecommendationIdentifier": ...,
}
parent.update_organization_recommendation_lifecycle(**kwargs)
update_recommendation_lifecycle#
Update the lifecyle of a Recommendation.
Type annotations and code completion for session.client("trustedadvisor").update_recommendation_lifecycle
method.
boto3 documentation
# update_recommendation_lifecycle method definition
await def update_recommendation_lifecycle(
self,
*,
lifecycleStage: UpdateRecommendationLifecycleStageType, # (1)
recommendationIdentifier: str,
updateReason: str = ...,
updateReasonCode: UpdateRecommendationLifecycleStageReasonCodeType = ..., # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...
- See UpdateRecommendationLifecycleStageType
- See UpdateRecommendationLifecycleStageReasonCodeType
- See EmptyResponseMetadataTypeDef
# update_recommendation_lifecycle method usage example with argument unpacking
kwargs: UpdateRecommendationLifecycleRequestRequestTypeDef = { # (1)
"lifecycleStage": ...,
"recommendationIdentifier": ...,
}
parent.update_recommendation_lifecycle(**kwargs)
__aenter__#
Type annotations and code completion for session.client("trustedadvisor").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> TrustedAdvisorPublicAPIClient:
...
__aexit__#
Type annotations and code completion for session.client("trustedadvisor").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.client("trustedadvisor").get_paginator
method with overloads.
client.get_paginator("list_checks")
-> ListChecksPaginatorclient.get_paginator("list_organization_recommendation_accounts")
-> ListOrganizationRecommendationAccountsPaginatorclient.get_paginator("list_organization_recommendation_resources")
-> ListOrganizationRecommendationResourcesPaginatorclient.get_paginator("list_organization_recommendations")
-> ListOrganizationRecommendationsPaginatorclient.get_paginator("list_recommendation_resources")
-> ListRecommendationResourcesPaginatorclient.get_paginator("list_recommendations")
-> ListRecommendationsPaginator