Skip to content

describe_network_insights_access_scope_analyses async

describe_network_insights_access_scope_analyses(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    network_insights_access_scope_analysis_ids: Optional[
        NetworkInsightsAccessScopeAnalysisIdList
    ] = None,
    network_insights_access_scope_id: Optional[NetworkInsightsAccessScopeId] = None,
    analysis_start_time_begin: Optional[MillisecondDateTime] = None,
    analysis_start_time_end: Optional[MillisecondDateTime] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[NetworkInsightsMaxResults] = None,
    dry_run: Optional[Boolean] = None,
    next_token: Optional[NextToken] = None,
) -> DescribeNetworkInsightsAccessScopeAnalysesResult

Describes the specified Network Access Scope analyses.

Parameters:

  • network_insights_access_scope_analysis_ids (Optional[NetworkInsightsAccessScopeAnalysisIdList], default: None ) –

    The IDs of the Network Access Scope analyses.

  • network_insights_access_scope_id (Optional[NetworkInsightsAccessScopeId], default: None ) –

    The ID of the Network Access Scope.

  • analysis_start_time_begin (Optional[MillisecondDateTime], default: None ) –

    Filters the results based on the start time. The analysis must have started on or after this time.

  • analysis_start_time_end (Optional[MillisecondDateTime], default: None ) –

    Filters the results based on the start time. The analysis must have started on or before this time.

  • filters (Optional[FilterList], default: None ) –

    There are no supported filters.

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

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • dry_run (Optional[Boolean], default: None ) –

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

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

    The token for the next page of results.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def describe_network_insights_access_scope_analyses(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    network_insights_access_scope_analysis_ids: Optional[
        "capo_ec2.types.network_insights_access_scope_analysis_id_list.NetworkInsightsAccessScopeAnalysisIdList"
    ] = None,
    network_insights_access_scope_id: Optional[
        "capo_ec2.types.network_insights_access_scope_id.NetworkInsightsAccessScopeId"
    ] = None,
    analysis_start_time_begin: Optional[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ] = None,
    analysis_start_time_end: Optional[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.network_insights_max_results.NetworkInsightsMaxResults"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
) -> "capo_ec2.types.describe_network_insights_access_scope_analyses_result.DescribeNetworkInsightsAccessScopeAnalysesResult":
    """<p>Describes the specified Network Access Scope analyses.</p>

    Args:
        network_insights_access_scope_analysis_ids: <p>The IDs of the Network Access Scope analyses.</p>
        network_insights_access_scope_id: <p>The ID of the Network Access Scope.</p>
        analysis_start_time_begin: <p>Filters the results based on the start time. The analysis must have started on or after this time.</p>
        analysis_start_time_end: <p>Filters the results based on the start time. The analysis must have started on or before this time.</p>
        filters: <p>There are no supported filters.</p>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        next_token: <p>The token for the next page of results.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.describe_network_insights_access_scope_analyses_request.DescribeNetworkInsightsAccessScopeAnalysesRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_network_insights_access_scope_analyses_result.DescribeNetworkInsightsAccessScopeAnalysesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_network_insights_access_scope_analyses

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.describe_network_insights_access_scope_analyses.async_describe_network_insights_access_scope_analyses(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeNetworkInsightsAccessScopeAnalyses"),
    )
    input_: capo_ec2.types.describe_network_insights_access_scope_analyses_request.DescribeNetworkInsightsAccessScopeAnalysesRequest = {}
    if network_insights_access_scope_analysis_ids is not None:
        input_["network_insights_access_scope_analysis_ids"] = (
            network_insights_access_scope_analysis_ids
        )
    if network_insights_access_scope_id is not None:
        input_["network_insights_access_scope_id"] = (
            network_insights_access_scope_id
        )
    if analysis_start_time_begin is not None:
        input_["analysis_start_time_begin"] = analysis_start_time_begin
    if analysis_start_time_end is not None:
        input_["analysis_start_time_end"] = analysis_start_time_end
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if next_token is not None:
        input_["next_token"] = next_token

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