Skip to content

get_scope async

get_scope(
    scope_id: ScopeId,
    *,
    config_overrides: Optional[AsyncNetworkFlowMonitorClientConfig] = None,
) -> GetScopeOutput

Gets information about a scope, including the name, status, tags, and target details. The scope in Network Flow Monitor is an account.

Parameters:

  • scope_id (ScopeId) –

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a CreateScope API call.

Raises:

Source code in docs_src/capo_networkflowmonitor/_services/async_network_flow_monitor.py
async def get_scope(
    self,
    scope_id: "capo_networkflowmonitor.types.scope_id.ScopeId",
    *,
    config_overrides: Optional[AsyncNetworkFlowMonitorClientConfig] = None,
) -> "capo_networkflowmonitor.types.get_scope_output.GetScopeOutput":
    """<p>Gets information about a scope, including the name, status, tags, and target details. The scope in Network Flow Monitor is an account.</p>

    Args:
        scope_id: <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a <code>CreateScope</code> API call.</p>

    Raises:
        capo_networkflowmonitor.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permission to perform this action.</p>
        capo_networkflowmonitor.errors.internal_server_exception.InternalServerException: <p>An internal error occurred.</p>
        capo_networkflowmonitor.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request specifies a resource that doesn't exist.</p>
        capo_networkflowmonitor.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request exceeded a service quota.</p>
        capo_networkflowmonitor.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_networkflowmonitor.errors.validation_exception.ValidationException: <p>Invalid request.</p>
        capo_networkflowmonitor.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_networkflowmonitor.types.get_scope_input.GetScopeInput]",
    ) -> AsyncOperationResponse[
        "capo_networkflowmonitor.types.get_scope_output.GetScopeOutput"
    ]:
        import capo_networkflowmonitor._operations.network_flow_monitor.get_scope

        (
            output,
            http_response,
        ) = await capo_networkflowmonitor._operations.network_flow_monitor.get_scope.async_get_scope(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetScope")
    )
    input_: capo_networkflowmonitor.types.get_scope_input.GetScopeInput = {
        "scope_id": scope_id
    }

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