Skip to content

get_analysis_report_results async

get_analysis_report_results(
    analysis_report_id: AnalysisReportId,
    *,
    config_overrides: Optional[AsyncNetworkFirewallClientConfig] = None,
    firewall_name: Optional[ResourceName] = None,
    firewall_arn: Optional[ResourceArn] = None,
    next_token: Optional[AnalysisReportNextToken] = None,
    max_results: Optional[PaginationMaxResults] = None,
) -> GetAnalysisReportResultsResponse

The results of a COMPLETED analysis report generated with StartAnalysisReport.

For more information, see AnalysisTypeReportResult.

Parameters:

  • firewall_name (Optional[ResourceName], default: None ) –

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • analysis_report_id (AnalysisReportId) –

    The unique ID of the query that ran when you requested an analysis report.

  • firewall_arn (Optional[ResourceArn], default: None ) –

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • next_token (Optional[AnalysisReportNextToken], default: None ) –

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • max_results (Optional[PaginationMaxResults], default: None ) –

    The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Raises:

  • InternalServerError –

    Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

  • InvalidRequestException –

    The operation failed because of a problem with your request. Examples include:

    • You specified an unsupported parameter name or value.

    • You tried to update a property with a value that isn't among the available types.

    • Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

  • ResourceNotFoundException –

    Unable to locate a resource using the parameters that you provided.

  • ThrottlingException –

    Unable to process the request due to throttling limitations.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_network_firewall/_services/async_network_firewall.py
async def get_analysis_report_results(
    self,
    analysis_report_id: "capo_network_firewall.types.analysis_report_id.AnalysisReportId",
    *,
    config_overrides: Optional[AsyncNetworkFirewallClientConfig] = None,
    firewall_name: Optional[
        "capo_network_firewall.types.resource_name.ResourceName"
    ] = None,
    firewall_arn: Optional[
        "capo_network_firewall.types.resource_arn.ResourceArn"
    ] = None,
    next_token: Optional[
        "capo_network_firewall.types.analysis_report_next_token.AnalysisReportNextToken"
    ] = None,
    max_results: Optional[
        "capo_network_firewall.types.pagination_max_results.PaginationMaxResults"
    ] = None,
) -> "capo_network_firewall.types.get_analysis_report_results_response.GetAnalysisReportResultsResponse":
    """<p>The results of a <code>COMPLETED</code> analysis report generated with <a>StartAnalysisReport</a>.</p> <p>For more information, see <a>AnalysisTypeReportResult</a>. </p>

    Args:
        firewall_name: <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        analysis_report_id: <p>The unique ID of the query that ran when you requested an analysis report. </p>
        firewall_arn: <p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        next_token: <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
        max_results: <p>The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>

    Raises:
        capo_network_firewall.errors.internal_server_error.InternalServerError: <p>Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request. </p>
        capo_network_firewall.errors.invalid_request_exception.InvalidRequestException: <p>The operation failed because of a problem with your request. Examples include: </p> <ul> <li> <p>You specified an unsupported parameter name or value.</p> </li> <li> <p>You tried to update a property with a value that isn't among the available types.</p> </li> <li> <p>Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.</p> </li> </ul>
        capo_network_firewall.errors.resource_not_found_exception.ResourceNotFoundException: <p>Unable to locate a resource using the parameters that you provided.</p>
        capo_network_firewall.errors.throttling_exception.ThrottlingException: <p>Unable to process the request due to throttling limitations.</p>
        capo_network_firewall.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_network_firewall.types.get_analysis_report_results_request.GetAnalysisReportResultsRequest]",
    ) -> AsyncOperationResponse[
        "capo_network_firewall.types.get_analysis_report_results_response.GetAnalysisReportResultsResponse"
    ]:
        import capo_network_firewall._operations.network_firewall_20201112.get_analysis_report_results

        (
            output,
            http_response,
        ) = await capo_network_firewall._operations.network_firewall_20201112.get_analysis_report_results.async_get_analysis_report_results(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAnalysisReportResults")
    )
    input_: capo_network_firewall.types.get_analysis_report_results_request.GetAnalysisReportResultsRequest = {
        "analysis_report_id": analysis_report_id
    }
    if firewall_name is not None:
        input_["firewall_name"] = firewall_name
    if firewall_arn is not None:
        input_["firewall_arn"] = firewall_arn
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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