Skip to content

get_access_preview async

get_access_preview(
    access_preview_id: AccessPreviewId,
    analyzer_arn: AnalyzerArn,
    *,
    config_overrides: Optional[AsyncAccessAnalyzerClientConfig] = None,
) -> GetAccessPreviewResponse

Retrieves information about an access preview for the specified analyzer.

Parameters:

Raises:

Source code in docs_src/capo_accessanalyzer/_services/async_access_analyzer.py
async def get_access_preview(
    self,
    access_preview_id: "capo_accessanalyzer.types.access_preview_id.AccessPreviewId",
    analyzer_arn: "capo_accessanalyzer.types.analyzer_arn.AnalyzerArn",
    *,
    config_overrides: Optional[AsyncAccessAnalyzerClientConfig] = None,
) -> (
    "capo_accessanalyzer.types.get_access_preview_response.GetAccessPreviewResponse"
):
    """<p>Retrieves information about an access preview for the specified analyzer.</p>

    Args:
        access_preview_id: <p>The unique ID for the access preview.</p>
        analyzer_arn: <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources">ARN of the analyzer</a> used to generate the access preview.</p>

    Raises:
        capo_accessanalyzer.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_accessanalyzer.errors.internal_server_exception.InternalServerException: <p>Internal server error.</p>
        capo_accessanalyzer.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found.</p>
        capo_accessanalyzer.errors.throttling_exception.ThrottlingException: <p>Throttling limit exceeded error.</p>
        capo_accessanalyzer.errors.validation_exception.ValidationException: <p>Validation exception error.</p>
        capo_accessanalyzer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_accessanalyzer.types.get_access_preview_request.GetAccessPreviewRequest]",
    ) -> AsyncOperationResponse[
        "capo_accessanalyzer.types.get_access_preview_response.GetAccessPreviewResponse"
    ]:
        import capo_accessanalyzer._operations.access_analyzer.get_access_preview

        (
            output,
            http_response,
        ) = await capo_accessanalyzer._operations.access_analyzer.get_access_preview.async_get_access_preview(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAccessPreview")
    )
    input_: capo_accessanalyzer.types.get_access_preview_request.GetAccessPreviewRequest = {
        "access_preview_id": access_preview_id,
        "analyzer_arn": analyzer_arn,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output