AccessAnalyzerClient
Index > AccessAnalyzer > AccessAnalyzerClient
Auto-generated documentation for AccessAnalyzer type annotations stubs module types-aiobotocore-accessanalyzer.
AccessAnalyzerClient
Type annotations and code completion for session.client("accessanalyzer")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_accessanalyzer.client import AccessAnalyzerClient
session = Session()
async with session.client("accessanalyzer") as client:
client: AccessAnalyzerClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("accessanalyzer").exceptions
structure.
async with session.client("accessanalyzer") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
from types_aiobotocore_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 session.client("accessanalyzer").apply_archive_rule
method.
boto3 documentation
await def apply_archive_rule(
self,
*,
analyzerArn: str,
ruleName: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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 session.client("accessanalyzer").can_paginate
method.
boto3 documentation
cancel_policy_generation
Cancels the requested policy generation.
Type annotations and code completion for session.client("accessanalyzer").cancel_policy_generation
method.
boto3 documentation
kwargs: CancelPolicyGenerationRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.cancel_policy_generation(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("accessanalyzer").close
method.
boto3 documentation
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 session.client("accessanalyzer").create_access_preview
method.
boto3 documentation
await def create_access_preview(
self,
*,
analyzerArn: str,
configurations: Mapping[str, ConfigurationTypeDef], # (1)
clientToken: str = ...,
) -> CreateAccessPreviewResponseTypeDef: # (2)
...
kwargs: CreateAccessPreviewRequestRequestTypeDef = { # (1)
"analyzerArn": ...,
"configurations": ...,
}
parent.create_access_preview(**kwargs)
create_analyzer
Creates an analyzer for your account.
Type annotations and code completion for session.client("accessanalyzer").create_analyzer
method.
boto3 documentation
await def create_analyzer(
self,
*,
analyzerName: str,
type: TypeType, # (1)
archiveRules: Sequence[InlineArchiveRuleTypeDef] = ..., # (2)
clientToken: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateAnalyzerResponseTypeDef: # (3)
...
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 session.client("accessanalyzer").create_archive_rule
method.
boto3 documentation
await def create_archive_rule(
self,
*,
analyzerName: str,
filter: Mapping[str, CriterionTypeDef], # (1)
ruleName: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: CreateArchiveRuleRequestRequestTypeDef = { # (1)
"analyzerName": ...,
"filter": ...,
"ruleName": ...,
}
parent.create_archive_rule(**kwargs)
delete_analyzer
Deletes the specified analyzer.
Type annotations and code completion for session.client("accessanalyzer").delete_analyzer
method.
boto3 documentation
await def delete_analyzer(
self,
*,
analyzerName: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAnalyzerRequestRequestTypeDef = { # (1)
"analyzerName": ...,
}
parent.delete_analyzer(**kwargs)
delete_archive_rule
Deletes the specified archive rule.
Type annotations and code completion for session.client("accessanalyzer").delete_archive_rule
method.
boto3 documentation
await def delete_archive_rule(
self,
*,
analyzerName: str,
ruleName: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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 session.client("accessanalyzer").generate_presigned_url
method.
boto3 documentation
await 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 session.client("accessanalyzer").get_access_preview
method.
boto3 documentation
await def get_access_preview(
self,
*,
accessPreviewId: str,
analyzerArn: str,
) -> GetAccessPreviewResponseTypeDef: # (1)
...
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 session.client("accessanalyzer").get_analyzed_resource
method.
boto3 documentation
await def get_analyzed_resource(
self,
*,
analyzerArn: str,
resourceArn: str,
) -> GetAnalyzedResourceResponseTypeDef: # (1)
...
kwargs: GetAnalyzedResourceRequestRequestTypeDef = { # (1)
"analyzerArn": ...,
"resourceArn": ...,
}
parent.get_analyzed_resource(**kwargs)
get_analyzer
Retrieves information about the specified analyzer.
Type annotations and code completion for session.client("accessanalyzer").get_analyzer
method.
boto3 documentation
await def get_analyzer(
self,
*,
analyzerName: str,
) -> GetAnalyzerResponseTypeDef: # (1)
...
kwargs: GetAnalyzerRequestRequestTypeDef = { # (1)
"analyzerName": ...,
}
parent.get_analyzer(**kwargs)
get_archive_rule
Retrieves information about an archive rule.
Type annotations and code completion for session.client("accessanalyzer").get_archive_rule
method.
boto3 documentation
await def get_archive_rule(
self,
*,
analyzerName: str,
ruleName: str,
) -> GetArchiveRuleResponseTypeDef: # (1)
...
kwargs: GetArchiveRuleRequestRequestTypeDef = { # (1)
"analyzerName": ...,
"ruleName": ...,
}
parent.get_archive_rule(**kwargs)
get_finding
Retrieves information about the specified finding.
Type annotations and code completion for session.client("accessanalyzer").get_finding
method.
boto3 documentation
await def get_finding(
self,
*,
analyzerArn: str,
id: str,
) -> GetFindingResponseTypeDef: # (1)
...
kwargs: GetFindingRequestRequestTypeDef = { # (1)
"analyzerArn": ...,
"id": ...,
}
parent.get_finding(**kwargs)
get_generated_policy
Retrieves the policy that was generated using StartPolicyGeneration
.
Type annotations and code completion for session.client("accessanalyzer").get_generated_policy
method.
boto3 documentation
await def get_generated_policy(
self,
*,
jobId: str,
includeResourcePlaceholders: bool = ...,
includeServiceLevelTemplate: bool = ...,
) -> GetGeneratedPolicyResponseTypeDef: # (1)
...
kwargs: GetGeneratedPolicyRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.get_generated_policy(**kwargs)
list_access_preview_findings
Retrieves a list of access preview findings generated by the specified access preview.
Type annotations and code completion for session.client("accessanalyzer").list_access_preview_findings
method.
boto3 documentation
await def list_access_preview_findings(
self,
*,
accessPreviewId: str,
analyzerArn: str,
filter: Mapping[str, CriterionTypeDef] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListAccessPreviewFindingsResponseTypeDef: # (2)
...
kwargs: ListAccessPreviewFindingsRequestRequestTypeDef = { # (1)
"accessPreviewId": ...,
"analyzerArn": ...,
}
parent.list_access_preview_findings(**kwargs)
list_access_previews
Retrieves a list of access previews for the specified analyzer.
Type annotations and code completion for session.client("accessanalyzer").list_access_previews
method.
boto3 documentation
await def list_access_previews(
self,
*,
analyzerArn: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListAccessPreviewsResponseTypeDef: # (1)
...
kwargs: ListAccessPreviewsRequestRequestTypeDef = { # (1)
"analyzerArn": ...,
}
parent.list_access_previews(**kwargs)
list_analyzed_resources
Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..
Type annotations and code completion for session.client("accessanalyzer").list_analyzed_resources
method.
boto3 documentation
await def list_analyzed_resources(
self,
*,
analyzerArn: str,
maxResults: int = ...,
nextToken: str = ...,
resourceType: ResourceTypeType = ..., # (1)
) -> ListAnalyzedResourcesResponseTypeDef: # (2)
...
kwargs: ListAnalyzedResourcesRequestRequestTypeDef = { # (1)
"analyzerArn": ...,
}
parent.list_analyzed_resources(**kwargs)
list_analyzers
Retrieves a list of analyzers.
Type annotations and code completion for session.client("accessanalyzer").list_analyzers
method.
boto3 documentation
await def list_analyzers(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
type: TypeType = ..., # (1)
) -> ListAnalyzersResponseTypeDef: # (2)
...
- See TypeType
- See ListAnalyzersResponseTypeDef
kwargs: ListAnalyzersRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_analyzers(**kwargs)
list_archive_rules
Retrieves a list of archive rules created for the specified analyzer.
Type annotations and code completion for session.client("accessanalyzer").list_archive_rules
method.
boto3 documentation
await def list_archive_rules(
self,
*,
analyzerName: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListArchiveRulesResponseTypeDef: # (1)
...
kwargs: ListArchiveRulesRequestRequestTypeDef = { # (1)
"analyzerName": ...,
}
parent.list_archive_rules(**kwargs)
list_findings
Retrieves a list of findings generated by the specified analyzer.
Type annotations and code completion for session.client("accessanalyzer").list_findings
method.
boto3 documentation
await def list_findings(
self,
*,
analyzerArn: str,
filter: Mapping[str, CriterionTypeDef] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
sort: SortCriteriaTypeDef = ..., # (2)
) -> ListFindingsResponseTypeDef: # (3)
...
kwargs: ListFindingsRequestRequestTypeDef = { # (1)
"analyzerArn": ...,
}
parent.list_findings(**kwargs)
list_policy_generations
Lists all of the policy generations requested in the last seven days.
Type annotations and code completion for session.client("accessanalyzer").list_policy_generations
method.
boto3 documentation
await def list_policy_generations(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
principalArn: str = ...,
) -> ListPolicyGenerationsResponseTypeDef: # (1)
...
kwargs: ListPolicyGenerationsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_policy_generations(**kwargs)
list_tags_for_resource
Retrieves a list of tags applied to the specified resource.
Type annotations and code completion for session.client("accessanalyzer").list_tags_for_resource
method.
boto3 documentation
await def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
start_policy_generation
Starts the policy generation request.
Type annotations and code completion for session.client("accessanalyzer").start_policy_generation
method.
boto3 documentation
await def start_policy_generation(
self,
*,
policyGenerationDetails: PolicyGenerationDetailsTypeDef, # (1)
clientToken: str = ...,
cloudTrailDetails: CloudTrailDetailsTypeDef = ..., # (2)
) -> StartPolicyGenerationResponseTypeDef: # (3)
...
- See PolicyGenerationDetailsTypeDef
- See CloudTrailDetailsTypeDef
- See StartPolicyGenerationResponseTypeDef
kwargs: StartPolicyGenerationRequestRequestTypeDef = { # (1)
"policyGenerationDetails": ...,
}
parent.start_policy_generation(**kwargs)
start_resource_scan
Immediately starts a scan of the policies applied to the specified resource.
Type annotations and code completion for session.client("accessanalyzer").start_resource_scan
method.
boto3 documentation
await def start_resource_scan(
self,
*,
analyzerArn: str,
resourceArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: StartResourceScanRequestRequestTypeDef = { # (1)
"analyzerArn": ...,
"resourceArn": ...,
}
parent.start_resource_scan(**kwargs)
tag_resource
Adds a tag to the specified resource.
Type annotations and code completion for session.client("accessanalyzer").tag_resource
method.
boto3 documentation
await def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes a tag from the specified resource.
Type annotations and code completion for session.client("accessanalyzer").untag_resource
method.
boto3 documentation
await def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_archive_rule
Updates the criteria and values for the specified archive rule.
Type annotations and code completion for session.client("accessanalyzer").update_archive_rule
method.
boto3 documentation
await def update_archive_rule(
self,
*,
analyzerName: str,
filter: Mapping[str, CriterionTypeDef], # (1)
ruleName: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateArchiveRuleRequestRequestTypeDef = { # (1)
"analyzerName": ...,
"filter": ...,
"ruleName": ...,
}
parent.update_archive_rule(**kwargs)
update_findings
Updates the status for the specified findings.
Type annotations and code completion for session.client("accessanalyzer").update_findings
method.
boto3 documentation
await def update_findings(
self,
*,
analyzerArn: str,
status: FindingStatusUpdateType, # (1)
clientToken: str = ...,
ids: Sequence[str] = ...,
resourceArn: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateFindingsRequestRequestTypeDef = { # (1)
"analyzerArn": ...,
"status": ...,
}
parent.update_findings(**kwargs)
validate_policy
Requests the validation of a policy and returns a list of findings.
Type annotations and code completion for session.client("accessanalyzer").validate_policy
method.
boto3 documentation
await def validate_policy(
self,
*,
policyDocument: str,
policyType: PolicyTypeType, # (1)
locale: LocaleType = ..., # (2)
maxResults: int = ...,
nextToken: str = ...,
validatePolicyResourceType: ValidatePolicyResourceTypeType = ..., # (3)
) -> ValidatePolicyResponseTypeDef: # (4)
...
- See PolicyTypeType
- See LocaleType
- See ValidatePolicyResourceTypeType
- See ValidatePolicyResponseTypeDef
kwargs: ValidatePolicyRequestRequestTypeDef = { # (1)
"policyDocument": ...,
"policyType": ...,
}
parent.validate_policy(**kwargs)
__aenter__
Type annotations and code completion for session.client("accessanalyzer").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("accessanalyzer").__aexit__
method.
boto3 documentation
get_paginator
Type annotations and code completion for session.client("accessanalyzer").get_paginator
method with overloads.
client.get_paginator("list_access_preview_findings")
-> ListAccessPreviewFindingsPaginatorclient.get_paginator("list_access_previews")
-> ListAccessPreviewsPaginatorclient.get_paginator("list_analyzed_resources")
-> ListAnalyzedResourcesPaginatorclient.get_paginator("list_analyzers")
-> ListAnalyzersPaginatorclient.get_paginator("list_archive_rules")
-> ListArchiveRulesPaginatorclient.get_paginator("list_findings")
-> ListFindingsPaginatorclient.get_paginator("list_policy_generations")
-> ListPolicyGenerationsPaginatorclient.get_paginator("validate_policy")
-> ValidatePolicyPaginator