AccessAnalyzerClient#
Index > AccessAnalyzer > AccessAnalyzerClient
Auto-generated documentation for AccessAnalyzer type annotations stubs module mypy-boto3-accessanalyzer.
AccessAnalyzerClient#
Type annotations and code completion for boto3.client("accessanalyzer").
boto3 documentation
# AccessAnalyzerClient usage example
from boto3.session import Session
from mypy_boto3_accessanalyzer.client import AccessAnalyzerClient
def get_accessanalyzer_client() -> AccessAnalyzerClient:
return Session().client("accessanalyzer")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("accessanalyzer").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("accessanalyzer")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.InvalidParameterException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.UnprocessableEntityException,
client.exceptions.ValidationException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_accessanalyzer.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...Methods#
apply_archive_rule#
Retroactively applies the archive rule to existing findings that meet the archive rule criteria.
Type annotations and code completion for boto3.client("accessanalyzer").apply_archive_rule method.
boto3 documentation
# apply_archive_rule method definition
def apply_archive_rule(
self,
*,
analyzerArn: str,
ruleName: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# apply_archive_rule method usage example with argument unpacking
kwargs: ApplyArchiveRuleRequestRequestTypeDef = { # (1)
"analyzerArn": ...,
"ruleName": ...,
}
parent.apply_archive_rule(**kwargs)can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("accessanalyzer").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...cancel_policy_generation#
Cancels the requested policy generation.
Type annotations and code completion for boto3.client("accessanalyzer").cancel_policy_generation method.
boto3 documentation
# cancel_policy_generation method definition
def cancel_policy_generation(
self,
*,
jobId: str,
) -> Dict[str, Any]:
...# cancel_policy_generation method usage example with argument unpacking
kwargs: CancelPolicyGenerationRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.cancel_policy_generation(**kwargs)check_access_not_granted#
Checks whether the specified access isn't allowed by a policy.
Type annotations and code completion for boto3.client("accessanalyzer").check_access_not_granted method.
boto3 documentation
# check_access_not_granted method definition
def check_access_not_granted(
self,
*,
policyDocument: str,
access: Sequence[AccessTypeDef], # (1)
policyType: AccessCheckPolicyTypeType, # (2)
) -> CheckAccessNotGrantedResponseTypeDef: # (3)
...# check_access_not_granted method usage example with argument unpacking
kwargs: CheckAccessNotGrantedRequestRequestTypeDef = { # (1)
"policyDocument": ...,
"access": ...,
"policyType": ...,
}
parent.check_access_not_granted(**kwargs)check_no_new_access#
Checks whether new access is allowed for an updated policy when compared to the existing policy.
Type annotations and code completion for boto3.client("accessanalyzer").check_no_new_access method.
boto3 documentation
# check_no_new_access method definition
def check_no_new_access(
self,
*,
newPolicyDocument: str,
existingPolicyDocument: str,
policyType: AccessCheckPolicyTypeType, # (1)
) -> CheckNoNewAccessResponseTypeDef: # (2)
...# check_no_new_access method usage example with argument unpacking
kwargs: CheckNoNewAccessRequestRequestTypeDef = { # (1)
"newPolicyDocument": ...,
"existingPolicyDocument": ...,
"policyType": ...,
}
parent.check_no_new_access(**kwargs)close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("accessanalyzer").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...create_access_preview#
Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.
Type annotations and code completion for boto3.client("accessanalyzer").create_access_preview method.
boto3 documentation
# create_access_preview method definition
def create_access_preview(
self,
*,
analyzerArn: str,
configurations: Mapping[str, ConfigurationTypeDef], # (1)
clientToken: str = ...,
) -> CreateAccessPreviewResponseTypeDef: # (2)
...# create_access_preview method usage example with argument unpacking
kwargs: CreateAccessPreviewRequestRequestTypeDef = { # (1)
"analyzerArn": ...,
"configurations": ...,
}
parent.create_access_preview(**kwargs)create_analyzer#
Creates an analyzer for your account.
Type annotations and code completion for boto3.client("accessanalyzer").create_analyzer method.
boto3 documentation
# create_analyzer method definition
def create_analyzer(
self,
*,
analyzerName: str,
type: TypeType, # (1)
archiveRules: Sequence[InlineArchiveRuleTypeDef] = ..., # (2)
tags: Mapping[str, str] = ...,
clientToken: str = ...,
configuration: AnalyzerConfigurationTypeDef = ..., # (3)
) -> CreateAnalyzerResponseTypeDef: # (4)
...- See TypeType
- See InlineArchiveRuleTypeDef
- See AnalyzerConfigurationTypeDef
- See CreateAnalyzerResponseTypeDef
# create_analyzer method usage example with argument unpacking
kwargs: CreateAnalyzerRequestRequestTypeDef = { # (1)
"analyzerName": ...,
"type": ...,
}
parent.create_analyzer(**kwargs)create_archive_rule#
Creates an archive rule for the specified analyzer.
Type annotations and code completion for boto3.client("accessanalyzer").create_archive_rule method.
boto3 documentation
# create_archive_rule method definition
def create_archive_rule(
self,
*,
analyzerName: str,
ruleName: str,
filter: Mapping[str, CriterionTypeDef], # (1)
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...# create_archive_rule method usage example with argument unpacking
kwargs: CreateArchiveRuleRequestRequestTypeDef = { # (1)
"analyzerName": ...,
"ruleName": ...,
"filter": ...,
}
parent.create_archive_rule(**kwargs)delete_analyzer#
Deletes the specified analyzer.
Type annotations and code completion for boto3.client("accessanalyzer").delete_analyzer method.
boto3 documentation
# delete_analyzer method definition
def delete_analyzer(
self,
*,
analyzerName: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_analyzer method usage example with argument unpacking
kwargs: DeleteAnalyzerRequestRequestTypeDef = { # (1)
"analyzerName": ...,
}
parent.delete_analyzer(**kwargs)delete_archive_rule#
Deletes the specified archive rule.
Type annotations and code completion for boto3.client("accessanalyzer").delete_archive_rule method.
boto3 documentation
# delete_archive_rule method definition
def delete_archive_rule(
self,
*,
analyzerName: str,
ruleName: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_archive_rule method usage example with argument unpacking
kwargs: DeleteArchiveRuleRequestRequestTypeDef = { # (1)
"analyzerName": ...,
"ruleName": ...,
}
parent.delete_archive_rule(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("accessanalyzer").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:
...get_access_preview#
Retrieves information about an access preview for the specified analyzer.
Type annotations and code completion for boto3.client("accessanalyzer").get_access_preview method.
boto3 documentation
# get_access_preview method definition
def get_access_preview(
self,
*,
accessPreviewId: str,
analyzerArn: str,
) -> GetAccessPreviewResponseTypeDef: # (1)
...# get_access_preview method usage example with argument unpacking
kwargs: GetAccessPreviewRequestRequestTypeDef = { # (1)
"accessPreviewId": ...,
"analyzerArn": ...,
}
parent.get_access_preview(**kwargs)get_analyzed_resource#
Retrieves information about a resource that was analyzed.
Type annotations and code completion for boto3.client("accessanalyzer").get_analyzed_resource method.
boto3 documentation
# get_analyzed_resource method definition
def get_analyzed_resource(
self,
*,
analyzerArn: str,
resourceArn: str,
) -> GetAnalyzedResourceResponseTypeDef: # (1)
...# get_analyzed_resource method usage example with argument unpacking
kwargs: GetAnalyzedResourceRequestRequestTypeDef = { # (1)
"analyzerArn": ...,
"resourceArn": ...,
}
parent.get_analyzed_resource(**kwargs)get_analyzer#
Retrieves information about the specified analyzer.
Type annotations and code completion for boto3.client("accessanalyzer").get_analyzer method.
boto3 documentation
# get_analyzer method definition
def get_analyzer(
self,
*,
analyzerName: str,
) -> GetAnalyzerResponseTypeDef: # (1)
...# get_analyzer method usage example with argument unpacking
kwargs: GetAnalyzerRequestRequestTypeDef = { # (1)
"analyzerName": ...,
}
parent.get_analyzer(**kwargs)get_archive_rule#
Retrieves information about an archive rule.
Type annotations and code completion for boto3.client("accessanalyzer").get_archive_rule method.
boto3 documentation
# get_archive_rule method definition
def get_archive_rule(
self,
*,
analyzerName: str,
ruleName: str,
) -> GetArchiveRuleResponseTypeDef: # (1)
...# get_archive_rule method usage example with argument unpacking
kwargs: GetArchiveRuleRequestRequestTypeDef = { # (1)
"analyzerName": ...,
"ruleName": ...,
}
parent.get_archive_rule(**kwargs)get_finding#
Retrieves information about the specified finding.
Type annotations and code completion for boto3.client("accessanalyzer").get_finding method.