Skip to content

start_network_insights_access_scope_analysis async

start_network_insights_access_scope_analysis(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    network_insights_access_scope_id: Optional[NetworkInsightsAccessScopeId] = None,
    dry_run: Optional[Boolean] = None,
    tag_specifications: Optional[TagSpecificationList] = None,
    client_token: Optional[String] = None,
) -> StartNetworkInsightsAccessScopeAnalysisResult

Starts analyzing the specified Network Access Scope.

Parameters:

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

    The ID of the Network Access Scope.

  • 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.

  • tag_specifications (Optional[TagSpecificationList], default: None ) –

    The tags to apply.

  • client_token (Optional[String], default: None ) –

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def start_network_insights_access_scope_analysis(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    network_insights_access_scope_id: Optional[
        "capo_ec2.types.network_insights_access_scope_id.NetworkInsightsAccessScopeId"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
    client_token: Optional["capo_ec2.types.string.String"] = None,
) -> "capo_ec2.types.start_network_insights_access_scope_analysis_result.StartNetworkInsightsAccessScopeAnalysisResult":
    """<p>Starts analyzing the specified Network Access Scope.</p>

    Args:
        network_insights_access_scope_id: <p>The ID of the Network Access Scope.</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>
        tag_specifications: <p>The tags to apply.</p>
        client_token: <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">How to ensure idempotency</a>.</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.start_network_insights_access_scope_analysis_request.StartNetworkInsightsAccessScopeAnalysisRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.start_network_insights_access_scope_analysis_result.StartNetworkInsightsAccessScopeAnalysisResult"
    ]:
        import capo_ec2._operations.amazon_ec2.start_network_insights_access_scope_analysis

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

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("StartNetworkInsightsAccessScopeAnalysis"),
    )
    input_: capo_ec2.types.start_network_insights_access_scope_analysis_request.StartNetworkInsightsAccessScopeAnalysisRequest = {}
    if network_insights_access_scope_id is not None:
        input_["network_insights_access_scope_id"] = (
            network_insights_access_scope_id
        )
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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