TrustedAdvisorPublicAPIClient

Index > TrustedAdvisorPublicAPI > TrustedAdvisorPublicAPIClient

Auto-generated documentation for TrustedAdvisorPublicAPI type annotations stubs module types-boto3-trustedadvisor.

TrustedAdvisorPublicAPIClient

Type annotations and code completion for boto3.client("trustedadvisor"). boto3 documentation

# TrustedAdvisorPublicAPIClient usage example

from boto3.session import Session
from types_boto3_trustedadvisor.client import TrustedAdvisorPublicAPIClient

def get_trustedadvisor_client() -> TrustedAdvisorPublicAPIClient:
    return Session().client("trustedadvisor")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("trustedadvisor").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("trustedadvisor")

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)

# Exceptions.exceptions type checking example

from types_boto3_trustedadvisor.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("trustedadvisor").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("trustedadvisor").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

batch_update_recommendation_resource_exclusion

Update one or more exclusion status for a list of recommendation resources.

Type annotations and code completion for boto3.client("trustedadvisor").batch_update_recommendation_resource_exclusion method. boto3 documentation

# batch_update_recommendation_resource_exclusion method definition

def batch_update_recommendation_resource_exclusion(
    self,
    *,
    recommendationResourceExclusions: Sequence[RecommendationResourceExclusionTypeDef],  # (1)
) -> BatchUpdateRecommendationResourceExclusionResponseTypeDef:  # (2)
    ...

1. See Sequence[RecommendationResourceExclusionTypeDef]
2. See BatchUpdateRecommendationResourceExclusionResponseTypeDef

# batch_update_recommendation_resource_exclusion method usage example with argument unpacking

kwargs: BatchUpdateRecommendationResourceExclusionRequestTypeDef = {  # (1)
    "recommendationResourceExclusions": ...,
}

parent.batch_update_recommendation_resource_exclusion(**kwargs)

1. See BatchUpdateRecommendationResourceExclusionRequestTypeDef

get_organization_recommendation

Get a specific recommendation within an AWS Organizations organization.

Type annotations and code completion for boto3.client("trustedadvisor").get_organization_recommendation method. boto3 documentation

# get_organization_recommendation method definition

def get_organization_recommendation(
    self,
    *,
    organizationRecommendationIdentifier: str,
) -> GetOrganizationRecommendationResponseTypeDef:  # (1)
    ...

1. See GetOrganizationRecommendationResponseTypeDef

# get_organization_recommendation method usage example with argument unpacking

kwargs: GetOrganizationRecommendationRequestTypeDef = {  # (1)
    "organizationRecommendationIdentifier": ...,
}

parent.get_organization_recommendation(**kwargs)

1. See GetOrganizationRecommendationRequestTypeDef

get_recommendation

Get a specific Recommendation.

Type annotations and code completion for boto3.client("trustedadvisor").get_recommendation method. boto3 documentation

# get_recommendation method definition

def get_recommendation(
    self,
    *,
    recommendationIdentifier: str,
) -> GetRecommendationResponseTypeDef:  # (1)
    ...

1. See GetRecommendationResponseTypeDef

# get_recommendation method usage example with argument unpacking

kwargs: GetRecommendationRequestTypeDef = {  # (1)
    "recommendationIdentifier": ...,
}

parent.get_recommendation(**kwargs)

1. See GetRecommendationRequestTypeDef

list_checks

List a filterable set of Checks.

Type annotations and code completion for boto3.client("trustedadvisor").list_checks method. boto3 documentation

# list_checks method definition

def list_checks(
    self,
    *,
    awsService: str = ...,
    language: RecommendationLanguageType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    pillar: RecommendationPillarType = ...,  # (2)
    source: RecommendationSourceType = ...,  # (3)
) -> ListChecksResponseTypeDef:  # (4)
    ...

1. See RecommendationLanguageType
2. See RecommendationPillarType
3. See RecommendationSourceType
4. See ListChecksResponseTypeDef

# list_checks method usage example with argument unpacking

kwargs: ListChecksRequestTypeDef = {  # (1)
    "awsService": ...,
}

parent.list_checks(**kwargs)

1. See ListChecksRequestTypeDef

list_organization_recommendation_accounts

Lists the accounts that own the resources for an organization aggregate recommendation.

Type annotations and code completion for boto3.client("trustedadvisor").list_organization_recommendation_accounts method. boto3 documentation

# list_organization_recommendation_accounts method definition

def list_organization_recommendation_accounts(
    self,
    *,
    organizationRecommendationIdentifier: str,
    affectedAccountId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListOrganizationRecommendationAccountsResponseTypeDef:  # (1)
    ...

1. See ListOrganizationRecommendationAccountsResponseTypeDef

# list_organization_recommendation_accounts method usage example with argument unpacking

kwargs: ListOrganizationRecommendationAccountsRequestTypeDef = {  # (1)
    "organizationRecommendationIdentifier": ...,
}

parent.list_organization_recommendation_accounts(**kwargs)

1. See ListOrganizationRecommendationAccountsRequestTypeDef

list_organization_recommendation_resources

List Resources of a Recommendation within an Organization.

Type annotations and code completion for boto3.client("trustedadvisor").list_organization_recommendation_resources method. boto3 documentation

# list_organization_recommendation_resources method definition

def list_organization_recommendation_resources(
    self,
    *,
    organizationRecommendationIdentifier: str,
    affectedAccountId: str = ...,
    exclusionStatus: ExclusionStatusType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    regionCode: str = ...,
    status: ResourceStatusType = ...,  # (2)
) -> ListOrganizationRecommendationResourcesResponseTypeDef:  # (3)
    ...

1. See ExclusionStatusType
2. See ResourceStatusType
3. See ListOrganizationRecommendationResourcesResponseTypeDef

# list_organization_recommendation_resources method usage example with argument unpacking

kwargs: ListOrganizationRecommendationResourcesRequestTypeDef = {  # (1)
    "organizationRecommendationIdentifier": ...,
}

parent.list_organization_recommendation_resources(**kwargs)

1. See ListOrganizationRecommendationResourcesRequestTypeDef

list_organization_recommendations

List a filterable set of Recommendations within an Organization.

Type annotations and code completion for boto3.client("trustedadvisor").list_organization_recommendations method. boto3 documentation

# list_organization_recommendations method definition

def list_organization_recommendations(
    self,
    *,
    afterLastUpdatedAt: TimestampTypeDef = ...,
    awsService: str = ...,
    beforeLastUpdatedAt: TimestampTypeDef = ...,
    checkIdentifier: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    pillar: RecommendationPillarType = ...,  # (1)
    source: RecommendationSourceType = ...,  # (2)
    status: RecommendationStatusType = ...,  # (3)
    type: RecommendationTypeType = ...,  # (4)
) -> ListOrganizationRecommendationsResponseTypeDef:  # (5)
    ...

1. See RecommendationPillarType
2. See RecommendationSourceType
3. See RecommendationStatusType
4. See RecommendationTypeType
5. See ListOrganizationRecommendationsResponseTypeDef

# list_organization_recommendations method usage example with argument unpacking

kwargs: ListOrganizationRecommendationsRequestTypeDef = {  # (1)
    "afterLastUpdatedAt": ...,
}

parent.list_organization_recommendations(**kwargs)

1. See ListOrganizationRecommendationsRequestTypeDef

list_recommendation_resources

List Resources of a Recommendation.

Type annotations and code completion for boto3.client("trustedadvisor").list_recommendation_resources method. boto3 documentation

# list_recommendation_resources method definition

def list_recommendation_resources(
    self,
    *,
    recommendationIdentifier: str,
    exclusionStatus: ExclusionStatusType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    regionCode: str = ...,
    status: ResourceStatusType = ...,  # (2)
) -> ListRecommendationResourcesResponseTypeDef:  # (3)
    ...

1. See ExclusionStatusType
2. See ResourceStatusType
3. See ListRecommendationResourcesResponseTypeDef

# list_recommendation_resources method usage example with argument unpacking

kwargs: ListRecommendationResourcesRequestTypeDef = {  # (1)
    "recommendationIdentifier": ...,
}

parent.list_recommendation_resources(**kwargs)

1. See ListRecommendationResourcesRequestTypeDef

list_recommendations

List a filterable set of Recommendations.

Type annotations and code completion for boto3.client("trustedadvisor").list_recommendations method. boto3 documentation

# list_recommendations method definition

def list_recommendations(
    self,
    *,
    afterLastUpdatedAt: TimestampTypeDef = ...,
    awsService: str = ...,
    beforeLastUpdatedAt: TimestampTypeDef = ...,
    checkIdentifier: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    pillar: RecommendationPillarType = ...,  # (1)
    source: RecommendationSourceType = ...,  # (2)
    status: RecommendationStatusType = ...,  # (3)
    type: RecommendationTypeType = ...,  # (4)
) -> ListRecommendationsResponseTypeDef:  # (5)
    ...

1. See RecommendationPillarType
2. See RecommendationSourceType
3. See RecommendationStatusType
4. See RecommendationTypeType
5. See ListRecommendationsResponseTypeDef

# list_recommendations method usage example with argument unpacking

kwargs: ListRecommendationsRequestTypeDef = {  # (1)
    "afterLastUpdatedAt": ...,
}

parent.list_recommendations(**kwargs)

1. See ListRecommendationsRequestTypeDef

update_organization_recommendation_lifecycle

Update the lifecycle of a Recommendation within an Organization.

Type annotations and code completion for boto3.client("trustedadvisor").update_organization_recommendation_lifecycle method. boto3 documentation

# update_organization_recommendation_lifecycle method definition

def update_organization_recommendation_lifecycle(
    self,
    *,
    lifecycleStage: UpdateRecommendationLifecycleStageType,  # (1)
    organizationRecommendationIdentifier: str,
    updateReason: str = ...,
    updateReasonCode: UpdateRecommendationLifecycleStageReasonCodeType = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See UpdateRecommendationLifecycleStageType
2. See UpdateRecommendationLifecycleStageReasonCodeType
3. See EmptyResponseMetadataTypeDef

# update_organization_recommendation_lifecycle method usage example with argument unpacking

kwargs: UpdateOrganizationRecommendationLifecycleRequestTypeDef = {  # (1)
    "lifecycleStage": ...,
    "organizationRecommendationIdentifier": ...,
}

parent.update_organization_recommendation_lifecycle(**kwargs)

1. See UpdateOrganizationRecommendationLifecycleRequestTypeDef

update_recommendation_lifecycle

Update the lifecyle of a Recommendation.

Type annotations and code completion for boto3.client("trustedadvisor").update_recommendation_lifecycle method. boto3 documentation

# update_recommendation_lifecycle method definition

def update_recommendation_lifecycle(
    self,
    *,
    lifecycleStage: UpdateRecommendationLifecycleStageType,  # (1)
    recommendationIdentifier: str,
    updateReason: str = ...,
    updateReasonCode: UpdateRecommendationLifecycleStageReasonCodeType = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See UpdateRecommendationLifecycleStageType
2. See UpdateRecommendationLifecycleStageReasonCodeType
3. See EmptyResponseMetadataTypeDef

# update_recommendation_lifecycle method usage example with argument unpacking

kwargs: UpdateRecommendationLifecycleRequestTypeDef = {  # (1)
    "lifecycleStage": ...,
    "recommendationIdentifier": ...,
}

parent.update_recommendation_lifecycle(**kwargs)

1. See UpdateRecommendationLifecycleRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("trustedadvisor").get_paginator method with overloads.

• client.get_paginator("list_checks") -> ListChecksPaginator
• client.get_paginator("list_organization_recommendation_accounts") -> ListOrganizationRecommendationAccountsPaginator
• client.get_paginator("list_organization_recommendation_resources") -> ListOrganizationRecommendationResourcesPaginator
• client.get_paginator("list_organization_recommendations") -> ListOrganizationRecommendationsPaginator
• client.get_paginator("list_recommendation_resources") -> ListRecommendationResourcesPaginator
• client.get_paginator("list_recommendations") -> ListRecommendationsPaginator