Skip to content

Type definitions#

Index > AccessAnalyzer > Type definitions

Auto-generated documentation for AccessAnalyzer type annotations stubs module mypy-boto3-accessanalyzer.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AccessPreviewStatusReasonTypeDef#

# AccessPreviewStatusReasonTypeDef definition

class AccessPreviewStatusReasonTypeDef(TypedDict):
    code: AccessPreviewStatusReasonCodeType,  # (1)
  1. See AccessPreviewStatusReasonCodeType

AccessTypeDef#

# AccessTypeDef definition

class AccessTypeDef(TypedDict):
    actions: Sequence[str],

AclGranteeTypeDef#

# AclGranteeTypeDef definition

class AclGranteeTypeDef(TypedDict):
    id: NotRequired[str],
    uri: NotRequired[str],

AnalyzedResourceSummaryTypeDef#

# AnalyzedResourceSummaryTypeDef definition

class AnalyzedResourceSummaryTypeDef(TypedDict):
    resourceArn: str,
    resourceOwnerAccount: str,
    resourceType: ResourceTypeType,  # (1)
  1. See ResourceTypeType

AnalyzedResourceTypeDef#

# AnalyzedResourceTypeDef definition

class AnalyzedResourceTypeDef(TypedDict):
    resourceArn: str,
    resourceType: ResourceTypeType,  # (1)
    createdAt: datetime,
    analyzedAt: datetime,
    updatedAt: datetime,
    isPublic: bool,
    resourceOwnerAccount: str,
    actions: NotRequired[List[str]],
    sharedVia: NotRequired[List[str]],
    status: NotRequired[FindingStatusType],  # (2)
    error: NotRequired[str],
  1. See ResourceTypeType
  2. See FindingStatusType

UnusedAccessConfigurationTypeDef#

# UnusedAccessConfigurationTypeDef definition

class UnusedAccessConfigurationTypeDef(TypedDict):
    unusedAccessAge: NotRequired[int],

StatusReasonTypeDef#

# StatusReasonTypeDef definition

class StatusReasonTypeDef(TypedDict):
    code: ReasonCodeType,  # (1)
  1. See ReasonCodeType

ApplyArchiveRuleRequestRequestTypeDef#

# ApplyArchiveRuleRequestRequestTypeDef definition

class ApplyArchiveRuleRequestRequestTypeDef(TypedDict):
    analyzerArn: str,
    ruleName: str,
    clientToken: NotRequired[str],

CriterionTypeDef#

# CriterionTypeDef definition

class CriterionTypeDef(TypedDict):
    eq: NotRequired[Sequence[str]],
    neq: NotRequired[Sequence[str]],
    contains: NotRequired[Sequence[str]],
    exists: NotRequired[bool],

CancelPolicyGenerationRequestRequestTypeDef#

# CancelPolicyGenerationRequestRequestTypeDef definition

class CancelPolicyGenerationRequestRequestTypeDef(TypedDict):
    jobId: str,

ReasonSummaryTypeDef#

# ReasonSummaryTypeDef definition

class ReasonSummaryTypeDef(TypedDict):
    description: NotRequired[str],
    statementIndex: NotRequired[int],
    statementId: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CheckNoNewAccessRequestRequestTypeDef#

# CheckNoNewAccessRequestRequestTypeDef definition

class CheckNoNewAccessRequestRequestTypeDef(TypedDict):
    newPolicyDocument: str,
    existingPolicyDocument: str,
    policyType: AccessCheckPolicyTypeType,  # (1)
  1. See AccessCheckPolicyTypeType

TrailTypeDef#

# TrailTypeDef definition

class TrailTypeDef(TypedDict):
    cloudTrailArn: str,
    regions: NotRequired[Sequence[str]],
    allRegions: NotRequired[bool],

TrailPropertiesTypeDef#

# TrailPropertiesTypeDef definition

class TrailPropertiesTypeDef(TypedDict):
    cloudTrailArn: str,
    regions: NotRequired[List[str]],
    allRegions: NotRequired[bool],

EbsSnapshotConfigurationTypeDef#

# EbsSnapshotConfigurationTypeDef definition

class EbsSnapshotConfigurationTypeDef(TypedDict):
    userIds: NotRequired[Sequence[str]],
    groups: NotRequired[Sequence[str]],
    kmsKeyId: NotRequired[str],

EcrRepositoryConfigurationTypeDef#

# EcrRepositoryConfigurationTypeDef definition

class EcrRepositoryConfigurationTypeDef(TypedDict):
    repositoryPolicy: NotRequired[str],

EfsFileSystemConfigurationTypeDef#

# EfsFileSystemConfigurationTypeDef definition

class EfsFileSystemConfigurationTypeDef(TypedDict):
    fileSystemPolicy: NotRequired[str],

IamRoleConfigurationTypeDef#

# IamRoleConfigurationTypeDef definition

class IamRoleConfigurationTypeDef(TypedDict):
    trustPolicy: NotRequired[str],

S3ExpressDirectoryBucketConfigurationTypeDef#

# S3ExpressDirectoryBucketConfigurationTypeDef definition

class S3ExpressDirectoryBucketConfigurationTypeDef(TypedDict):
    bucketPolicy: NotRequired[str],

SecretsManagerSecretConfigurationTypeDef#

# SecretsManagerSecretConfigurationTypeDef definition

class SecretsManagerSecretConfigurationTypeDef(TypedDict):
    kmsKeyId: NotRequired[str],
    secretPolicy: NotRequired[str],

SnsTopicConfigurationTypeDef#

# SnsTopicConfigurationTypeDef definition

class SnsTopicConfigurationTypeDef(TypedDict):
    topicPolicy: NotRequired[str],

SqsQueueConfigurationTypeDef#

# SqsQueueConfigurationTypeDef definition

class SqsQueueConfigurationTypeDef(TypedDict):
    queuePolicy: NotRequired[str],

DeleteAnalyzerRequestRequestTypeDef#

# DeleteAnalyzerRequestRequestTypeDef definition

class DeleteAnalyzerRequestRequestTypeDef(TypedDict):
    analyzerName: str,
    clientToken: NotRequired[str],

DeleteArchiveRuleRequestRequestTypeDef#

# DeleteArchiveRuleRequestRequestTypeDef definition

class DeleteArchiveRuleRequestRequestTypeDef(TypedDict):
    analyzerName: str,
    ruleName: str,
    clientToken: NotRequired[str],

UnusedIamRoleDetailsTypeDef#

# UnusedIamRoleDetailsTypeDef definition

class UnusedIamRoleDetailsTypeDef(TypedDict):
    lastAccessed: NotRequired[datetime],

UnusedIamUserAccessKeyDetailsTypeDef#

# UnusedIamUserAccessKeyDetailsTypeDef definition

class UnusedIamUserAccessKeyDetailsTypeDef(TypedDict):
    accessKeyId: str,
    lastAccessed: NotRequired[datetime],

UnusedIamUserPasswordDetailsTypeDef#

# UnusedIamUserPasswordDetailsTypeDef definition

class UnusedIamUserPasswordDetailsTypeDef(TypedDict):
    lastAccessed: NotRequired[datetime],

FindingSourceDetailTypeDef#

# FindingSourceDetailTypeDef definition

class FindingSourceDetailTypeDef(TypedDict):
    accessPointArn: NotRequired[str],
    accessPointAccount: NotRequired[str],

FindingSummaryV2TypeDef#

# FindingSummaryV2TypeDef definition

class FindingSummaryV2TypeDef(TypedDict):
    analyzedAt: datetime,
    createdAt: datetime,
    id: str,
    resourceType: ResourceTypeType,  # (1)
    resourceOwnerAccount: str,
    status: FindingStatusType,  # (2)
    updatedAt: datetime,
    error: NotRequired[str],
    resource: NotRequired[str],
    findingType: NotRequired[FindingTypeType],  # (3)
  1. See ResourceTypeType
  2. See FindingStatusType
  3. See FindingTypeType

GeneratedPolicyTypeDef#

# GeneratedPolicyTypeDef definition

class GeneratedPolicyTypeDef(TypedDict):
    policy: str,

GetAccessPreviewRequestRequestTypeDef#

# GetAccessPreviewRequestRequestTypeDef definition

class GetAccessPreviewRequestRequestTypeDef(TypedDict):
    accessPreviewId: str,
    analyzerArn: str,

GetAnalyzedResourceRequestRequestTypeDef#

# GetAnalyzedResourceRequestRequestTypeDef definition

class GetAnalyzedResourceRequestRequestTypeDef(TypedDict):
    analyzerArn: str,
    resourceArn: str,

GetAnalyzerRequestRequestTypeDef#

# GetAnalyzerRequestRequestTypeDef definition

class GetAnalyzerRequestRequestTypeDef(TypedDict):
    analyzerName: str,

GetArchiveRuleRequestRequestTypeDef#

# GetArchiveRuleRequestRequestTypeDef definition

class GetArchiveRuleRequestRequestTypeDef(TypedDict):
    analyzerName: str,
    ruleName: str,

GetFindingRequestRequestTypeDef#

# GetFindingRequestRequestTypeDef definition

class GetFindingRequestRequestTypeDef(TypedDict):
    analyzerArn: str,
    id: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetFindingV2RequestRequestTypeDef#

# GetFindingV2RequestRequestTypeDef definition

class GetFindingV2RequestRequestTypeDef(TypedDict):
    analyzerArn: str,
    id: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

GetGeneratedPolicyRequestRequestTypeDef#

# GetGeneratedPolicyRequestRequestTypeDef definition

class GetGeneratedPolicyRequestRequestTypeDef(TypedDict):
    jobId: str,
    includeResourcePlaceholders: NotRequired[bool],
    includeServiceLevelTemplate: NotRequired[bool],

JobErrorTypeDef#

# JobErrorTypeDef definition

class JobErrorTypeDef(TypedDict):
    code: JobErrorCodeType,  # (1)
    message: str,
  1. See JobErrorCodeType

KmsGrantConstraintsTypeDef#

# KmsGrantConstraintsTypeDef definition

class KmsGrantConstraintsTypeDef(TypedDict):
    encryptionContextEquals: NotRequired[Mapping[str, str]],
    encryptionContextSubset: NotRequired[Mapping[str, str]],

ListAccessPreviewsRequestRequestTypeDef#

# ListAccessPreviewsRequestRequestTypeDef definition

class ListAccessPreviewsRequestRequestTypeDef(TypedDict):
    analyzerArn: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListAnalyzedResourcesRequestRequestTypeDef#

# ListAnalyzedResourcesRequestRequestTypeDef definition

class ListAnalyzedResourcesRequestRequestTypeDef(TypedDict):
    analyzerArn: str,
    resourceType: NotRequired[ResourceTypeType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See ResourceTypeType

ListAnalyzersRequestRequestTypeDef#

# ListAnalyzersRequestRequestTypeDef definition

class ListAnalyzersRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    type: NotRequired[TypeType],  # (1)
  1. See TypeType

ListArchiveRulesRequestRequestTypeDef#

# ListArchiveRulesRequestRequestTypeDef definition

class ListArchiveRulesRequestRequestTypeDef(TypedDict):
    analyzerName: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

SortCriteriaTypeDef#

# SortCriteriaTypeDef definition

class SortCriteriaTypeDef(TypedDict):
    attributeName: NotRequired[str],
    orderBy: NotRequired[OrderByType],  # (1)
  1. See OrderByType

ListPolicyGenerationsRequestRequestTypeDef#

# ListPolicyGenerationsRequestRequestTypeDef definition

class ListPolicyGenerationsRequestRequestTypeDef(TypedDict):
    principalArn: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

PolicyGenerationTypeDef#

# PolicyGenerationTypeDef definition

class PolicyGenerationTypeDef(TypedDict):
    jobId: str,
    principalArn: str,
    status: JobStatusType,  # (1)
    startedOn: datetime,
    completedOn: NotRequired[datetime],
  1. See JobStatusType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

VpcConfigurationTypeDef#

# VpcConfigurationTypeDef definition

class VpcConfigurationTypeDef(TypedDict):
    vpcId: str,

SubstringTypeDef#

# SubstringTypeDef definition

class SubstringTypeDef(TypedDict):
    start: int,
    length: int,

PolicyGenerationDetailsTypeDef#

# PolicyGenerationDetailsTypeDef definition

class PolicyGenerationDetailsTypeDef(TypedDict):
    principalArn: str,

PositionTypeDef#

# PositionTypeDef definition

class PositionTypeDef(TypedDict):
    line: int,
    column: int,
    offset: int,

RdsDbClusterSnapshotAttributeValueTypeDef#

# RdsDbClusterSnapshotAttributeValueTypeDef definition

class RdsDbClusterSnapshotAttributeValueTypeDef(TypedDict):
    accountIds: NotRequired[Sequence[str]],

RdsDbSnapshotAttributeValueTypeDef#

# RdsDbSnapshotAttributeValueTypeDef definition

class RdsDbSnapshotAttributeValueTypeDef(TypedDict):
    accountIds: NotRequired[Sequence[str]],

S3PublicAccessBlockConfigurationTypeDef#

# S3PublicAccessBlockConfigurationTypeDef definition

class S3PublicAccessBlockConfigurationTypeDef(TypedDict):
    ignorePublicAcls: bool,
    restrictPublicBuckets: bool,

StartResourceScanRequestRequestTypeDef#

# StartResourceScanRequestRequestTypeDef definition

class StartResourceScanRequestRequestTypeDef(TypedDict):
    analyzerArn: str,
    resourceArn: str,
    resourceOwnerAccount: NotRequired[str],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UnusedActionTypeDef#

# UnusedActionTypeDef definition

class UnusedActionTypeDef(TypedDict):
    action: str,
    lastAccessed: NotRequired[datetime],

UpdateFindingsRequestRequestTypeDef#

# UpdateFindingsRequestRequestTypeDef definition

class UpdateFindingsRequestRequestTypeDef(TypedDict):
    analyzerArn: str,
    status: FindingStatusUpdateType,  # (1)
    ids: NotRequired[Sequence[str]],
    resourceArn: NotRequired[str],
    clientToken: NotRequired[str],
  1. See FindingStatusUpdateType

ValidatePolicyRequestRequestTypeDef#

# ValidatePolicyRequestRequestTypeDef definition

class ValidatePolicyRequestRequestTypeDef(TypedDict):
    policyDocument: str,
    policyType: PolicyTypeType,  # (1)
    locale: NotRequired[LocaleType],  # (2)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    validatePolicyResourceType: NotRequired[ValidatePolicyResourceTypeType],  # (3)
  1. See PolicyTypeType
  2. See LocaleType
  3. See ValidatePolicyResourceTypeType

AccessPreviewSummaryTypeDef#

# AccessPreviewSummaryTypeDef definition

class AccessPreviewSummaryTypeDef(TypedDict):
    id: str,
    analyzerArn: str,
    createdAt: datetime,
    status: AccessPreviewStatusType,  # (1)
    statusReason: NotRequired[AccessPreviewStatusReasonTypeDef],  # (2)
  1. See AccessPreviewStatusType
  2. See AccessPreviewStatusReasonTypeDef

CheckAccessNotGrantedRequestRequestTypeDef#

# CheckAccessNotGrantedRequestRequestTypeDef definition

class CheckAccessNotGrantedRequestRequestTypeDef(TypedDict):
    policyDocument: str,
    access: Sequence[AccessTypeDef],  # (1)
    policyType: AccessCheckPolicyTypeType,  # (2)
  1. See AccessTypeDef
  2. See AccessCheckPolicyTypeType

S3BucketAclGrantConfigurationTypeDef#

# S3BucketAclGrantConfigurationTypeDef definition

class S3BucketAclGrantConfigurationTypeDef(TypedDict):
    permission: AclPermissionType,  # (1)
    grantee: AclGranteeTypeDef,  # (2)
  1. See AclPermissionType
  2. See AclGranteeTypeDef

AnalyzerConfigurationTypeDef#

# AnalyzerConfigurationTypeDef definition

class AnalyzerConfigurationTypeDef(TypedDict):
    unusedAccess: NotRequired[UnusedAccessConfigurationTypeDef],  # (1)
  1. See UnusedAccessConfigurationTypeDef

ArchiveRuleSummaryTypeDef#

# ArchiveRuleSummaryTypeDef definition

class ArchiveRuleSummaryTypeDef(TypedDict):
    ruleName: str,
    filter: Dict[str, CriterionTypeDef],  # (1)
    createdAt: datetime,
    updatedAt: datetime,
  1. See CriterionTypeDef

CreateArchiveRuleRequestRequestTypeDef#

# CreateArchiveRuleRequestRequestTypeDef definition

class CreateArchiveRuleRequestRequestTypeDef(TypedDict):
    analyzerName: str,
    ruleName: str,
    filter: Mapping[str, CriterionTypeDef],  # (1)
    clientToken: NotRequired[str],
  1. See CriterionTypeDef

InlineArchiveRuleTypeDef#

# InlineArchiveRuleTypeDef definition

class InlineArchiveRuleTypeDef(TypedDict):
    ruleName: str,
    filter: Mapping[str, CriterionTypeDef],  # (1)
  1. See CriterionTypeDef

ListAccessPreviewFindingsRequestRequestTypeDef#

# ListAccessPreviewFindingsRequestRequestTypeDef definition

class ListAccessPreviewFindingsRequestRequestTypeDef(TypedDict):
    accessPreviewId: str,
    analyzerArn: str,
    filter: NotRequired[Mapping[str, CriterionTypeDef]],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See