get_odb_network ¶

get_odb_network(
    odb_network_id: ResourceIdOrArn,
    *,
    config_overrides: Optional[odbClientConfig] = None,
) -> GetOdbNetworkOutput

Returns information about the specified ODB network.

Parameters:

odb_network_id (ResourceIdOrArn) –

The unique identifier of the ODB network.

Raises:

AccessDeniedException –

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.
InternalServerException –

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.
ResourceNotFoundException –

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The request has failed validation because it is missing required fields or has invalid inputs.
UnknownServiceError –

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

Source code in docs_src/capo_odb/_services/odb.py

def get_odb_network(
    self,
    odb_network_id: "capo_odb.types.resource_id_or_arn.ResourceIdOrArn",
    *,
    config_overrides: Optional[odbClientConfig] = None,
) -> "capo_odb.types.get_odb_network_output.GetOdbNetworkOutput":
    """<p>Returns information about the specified ODB network.</p>

    Args:
        odb_network_id: <p>The unique identifier of the ODB network.</p>

    Raises:
        capo_odb.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.</p>
        capo_odb.errors.internal_server_exception.InternalServerException: <p>Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.</p>
        capo_odb.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.</p>
        capo_odb.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_odb.errors.validation_exception.ValidationException: <p>The request has failed validation because it is missing required fields or has invalid inputs.</p>
        capo_odb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_odb.types.get_odb_network_input.GetOdbNetworkInput]",
    ) -> OperationResponse[
        "capo_odb.types.get_odb_network_output.GetOdbNetworkOutput"
    ]:
        import capo_odb._operations.odb.get_odb_network

        output, http_response = (
            capo_odb._operations.odb.get_odb_network.get_odb_network(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetOdbNetwork")
    )
    input_: capo_odb.types.get_odb_network_input.GetOdbNetworkInput = {
        "odb_network_id": odb_network_id
    }

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