Skip to content

AccessPreviewFinding

Source code in docs_src/capo_accessanalyzer/types/access_preview_finding.py
class AccessPreviewFinding(TypedDict, closed=True):
    id: "capo_accessanalyzer.types.access_preview_finding_id.AccessPreviewFindingId"
    """<p>The ID of the access preview finding. This ID uniquely identifies the element in the list of access preview findings and is not related to the finding ID in Access Analyzer.</p>"""
    existing_finding_id: NotRequired["capo_accessanalyzer.types.finding_id.FindingId"]
    """<p>The existing ID of the finding in IAM Access Analyzer, provided only for existing findings.</p>"""
    existing_finding_status: NotRequired[
        "capo_accessanalyzer.types.finding_status.FindingStatus"
    ]
    """<p>The existing status of the finding, provided only for existing findings.</p>"""
    principal: NotRequired["capo_accessanalyzer.types.principal_map.PrincipalMap"]
    """<p>The external principal that has access to a resource within the zone of trust.</p>"""
    action: NotRequired["capo_accessanalyzer.types.action_list.ActionList"]
    """<p>The action in the analyzed policy statement that an external principal has permission to perform.</p>"""
    condition: NotRequired[
        "capo_accessanalyzer.types.condition_key_map.ConditionKeyMap"
    ]
    """<p>The condition in the analyzed policy statement that resulted in a finding.</p>"""
    resource: NotRequired["str"]
    """<p>The resource that an external principal has access to. This is the resource associated with the access preview.</p>"""
    is_public: NotRequired["bool"]
    """<p>Indicates whether the policy that generated the finding allows public access to the resource.</p>"""
    resource_type: "capo_accessanalyzer.types.resource_type.ResourceType"
    """<p>The type of the resource that can be accessed in the finding.</p>"""
    created_at: "capo_accessanalyzer.types.timestamp.Timestamp"
    """<p>The time at which the access preview finding was created.</p>"""
    change_type: "capo_accessanalyzer.types.finding_change_type.FindingChangeType"
    """<p>Provides context on how the access preview finding compares to existing access identified in IAM Access Analyzer.</p> <ul> <li> <p> <code>New</code> - The finding is for newly-introduced access.</p> </li> <li> <p> <code>Unchanged</code> - The preview finding is an existing finding that would remain unchanged.</p> </li> <li> <p> <code>Changed</code> - The preview finding is an existing finding with a change in status.</p> </li> </ul> <p>For example, a <code>Changed</code> finding with preview status <code>Resolved</code> and existing status <code>Active</code> indicates the existing <code>Active</code> finding would become <code>Resolved</code> as a result of the proposed permissions change.</p>"""
    status: "capo_accessanalyzer.types.finding_status.FindingStatus"
    """<p>The preview status of the finding. This is what the status of the finding would be after permissions deployment. For example, a <code>Changed</code> finding with preview status <code>Resolved</code> and existing status <code>Active</code> indicates the existing <code>Active</code> finding would become <code>Resolved</code> as a result of the proposed permissions change.</p>"""
    resource_owner_account: "str"
    """<p>The Amazon Web Services account ID that owns the resource. For most Amazon Web Services resources, the owning account is the account in which the resource was created.</p>"""
    error: NotRequired["str"]
    """<p>An error.</p>"""
    sources: NotRequired[
        "capo_accessanalyzer.types.finding_source_list.FindingSourceList"
    ]
    """<p>The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.</p>"""
    resource_control_policy_restriction: NotRequired[
        "capo_accessanalyzer.types.resource_control_policy_restriction.ResourceControlPolicyRestriction"
    ]
    """<p>The type of restriction applied to the finding by the resource owner with an Organizations resource control policy (RCP).</p>"""

action instance-attribute

action: NotRequired[ActionList]

The action in the analyzed policy statement that an external principal has permission to perform.

change_type instance-attribute

change_type: FindingChangeType

Provides context on how the access preview finding compares to existing access identified in IAM Access Analyzer.

  • New - The finding is for newly-introduced access.

  • Unchanged - The preview finding is an existing finding that would remain unchanged.

  • Changed - The preview finding is an existing finding with a change in status.

For example, a Changed finding with preview status Resolved and existing status Active indicates the existing Active finding would become Resolved as a result of the proposed permissions change.

condition instance-attribute

condition: NotRequired[ConditionKeyMap]

The condition in the analyzed policy statement that resulted in a finding.

created_at instance-attribute

created_at: Timestamp

The time at which the access preview finding was created.

error instance-attribute

error: NotRequired[str]

An error.

existing_finding_id instance-attribute

existing_finding_id: NotRequired[FindingId]

The existing ID of the finding in IAM Access Analyzer, provided only for existing findings.

existing_finding_status instance-attribute

existing_finding_status: NotRequired[FindingStatus]

The existing status of the finding, provided only for existing findings.

id instance-attribute

The ID of the access preview finding. This ID uniquely identifies the element in the list of access preview findings and is not related to the finding ID in Access Analyzer.

is_public instance-attribute

is_public: NotRequired[bool]

Indicates whether the policy that generated the finding allows public access to the resource.

principal instance-attribute

principal: NotRequired[PrincipalMap]

The external principal that has access to a resource within the zone of trust.

resource instance-attribute

resource: NotRequired[str]

The resource that an external principal has access to. This is the resource associated with the access preview.

resource_control_policy_restriction instance-attribute

resource_control_policy_restriction: NotRequired[ResourceControlPolicyRestriction]

The type of restriction applied to the finding by the resource owner with an Organizations resource control policy (RCP).

resource_owner_account instance-attribute

resource_owner_account: str

The Amazon Web Services account ID that owns the resource. For most Amazon Web Services resources, the owning account is the account in which the resource was created.

resource_type instance-attribute

resource_type: ResourceType

The type of the resource that can be accessed in the finding.

sources instance-attribute

sources: NotRequired[FindingSourceList]

The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.

status instance-attribute

status: FindingStatus

The preview status of the finding. This is what the status of the finding would be after permissions deployment. For example, a Changed finding with preview status Resolved and existing status Active indicates the existing Active finding would become Resolved as a result of the proposed permissions change.