Skip to content

AccessPreview

Source code in docs_src/capo_accessanalyzer/types/access_preview.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class AccessPreview(TypedDict, closed=True):
    id: "capo_accessanalyzer.types.access_preview_id.AccessPreviewId"
    """<p>The unique ID for the access preview.</p>"""
    analyzer_arn: "capo_accessanalyzer.types.analyzer_arn.AnalyzerArn"
    """<p>The ARN of the analyzer used to generate the access preview.</p>"""
    configurations: "capo_accessanalyzer.types.configurations_map.ConfigurationsMap"
    """<p>A map of resource ARNs for the proposed resource configuration.</p>"""
    created_at: "capo_accessanalyzer.types.timestamp.Timestamp"
    """<p>The time at which the access preview was created.</p>"""
    status: "capo_accessanalyzer.types.access_preview_status.AccessPreviewStatus"
    """<p>The status of the access preview.</p> <ul> <li> <p> <code>Creating</code> - The access preview creation is in progress.</p> </li> <li> <p> <code>Completed</code> - The access preview is complete. You can preview findings for external access to the resource.</p> </li> <li> <p> <code>Failed</code> - The access preview creation has failed.</p> </li> </ul>"""
    status_reason: NotRequired[
        "capo_accessanalyzer.types.access_preview_status_reason.AccessPreviewStatusReason"
    ]
    """<p>Provides more details about the current status of the access preview.</p> <p>For example, if the creation of the access preview fails, a <code>Failed</code> status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource configuration.</p>"""

analyzer_arn instance-attribute 

analyzer_arn: AnalyzerArn

The ARN of the analyzer used to generate the access preview.

configurations instance-attribute 

configurations: ConfigurationsMap

A map of resource ARNs for the proposed resource configuration.

created_at instance-attribute 

created_at: Timestamp

The time at which the access preview was created.

id instance-attribute 

id: AccessPreviewId

The unique ID for the access preview.

status instance-attribute 

status: AccessPreviewStatus

The status of the access preview.

  • Creating - The access preview creation is in progress.

  • Completed - The access preview is complete. You can preview findings for external access to the resource.

  • Failed - The access preview creation has failed.

status_reason instance-attribute 

status_reason: NotRequired[AccessPreviewStatusReason]

Provides more details about the current status of the access preview.

For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource configuration.