Skip to content

get_sol_network_instance

get_sol_network_instance(
    ns_instance_id: NsInstanceId, *, config_overrides: Optional[tnbClientConfig] = None
) -> GetSolNetworkInstanceOutput

Gets the details of the network instance.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

Parameters:

  • ns_instance_id (NsInstanceId) –

    ID of the network instance.

Raises:

Examples:

Get a Sol Network Instance details

>>> client.get_sol_network_instance(ns_instance_id='ni-07aa863e53460a2a6')
Source code in docs_src/capo_tnb/_services/tnb.py
def get_sol_network_instance(
    self,
    ns_instance_id: "capo_tnb.types.ns_instance_id.NsInstanceId",
    *,
    config_overrides: Optional[tnbClientConfig] = None,
) -> "capo_tnb.types.get_sol_network_instance_output.GetSolNetworkInstanceOutput":
    """<p>Gets the details of the network instance.</p> <p>A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.</p>

    Args:
        ns_instance_id: <p>ID of the network instance.</p>

    Raises:
        capo_tnb.errors.access_denied_exception.AccessDeniedException: <p>Insufficient permissions to make request.</p>
        capo_tnb.errors.internal_server_exception.InternalServerException: <p>Unexpected error occurred. Problem on the server.</p>
        capo_tnb.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource that doesn't exist.</p>
        capo_tnb.errors.throttling_exception.ThrottlingException: <p>Exception caused by throttling.</p>
        capo_tnb.errors.validation_exception.ValidationException: <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
        capo_tnb.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get a Sol Network Instance details

        >>> client.get_sol_network_instance(ns_instance_id='ni-07aa863e53460a2a6')
    """

    def _handler(
        req: "OperationRequest[capo_tnb.types.get_sol_network_instance_input.GetSolNetworkInstanceInput]",
    ) -> OperationResponse[
        "capo_tnb.types.get_sol_network_instance_output.GetSolNetworkInstanceOutput"
    ]:
        import capo_tnb._operations.tnb.get_sol_network_instance

        output, http_response = (
            capo_tnb._operations.tnb.get_sol_network_instance.get_sol_network_instance(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_tnb.types.get_sol_network_instance_output.GetSolNetworkInstanceOutput",
    ) -> dict[str, Any]:
        import capo_tnb.types.get_sol_network_instance_output

        return capo_tnb.types.get_sol_network_instance_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetSolNetworkInstance", redact_output=_redact_output),
    )
    input_: capo_tnb.types.get_sol_network_instance_input.GetSolNetworkInstanceInput = {
        "ns_instance_id": ns_instance_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output