Skip to content

get_link 

get_link(
    gateway_id: GatewayId,
    link_id: LinkId,
    *,
    config_overrides: Optional[RTBFabricClientConfig] = None,
) -> GetLinkResponse

Retrieves information about a link between gateways.

Returns detailed information about the link configuration, status, and associated gateways.

Parameters:

  • gateway_id (GatewayId) –

    The unique identifier of the gateway.

  • link_id (LinkId) –

    The unique identifier of the link.

Raises:

  • AccessDeniedException –

    The request could not be completed because you do not have sufficient access to perform this action.

  • ConflictException –

    The request could not be completed because of a conflict in the current state of the resource.

  • InternalServerException –

    The request could not be completed because of an internal server error. Try your call again.

  • ResourceNotFoundException –

    The request could not be completed because the resource does not exist.

  • ThrottlingException –

    The request was denied due to request throttling.

  • ValidationException –

    The request could not be completed because it fails satisfy the constraints specified by the service.

  • UnknownServiceError –

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

Examples:

Get link details Retrieves details of a specific link

>>> client.get_link(gateway_id='rtb-gw-12345678', link_id='link-87654321')
Source code in docs_src/capo_rtbfabric/_services/rtb_fabric.py 
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
def get_link(
    self,
    gateway_id: "capo_rtbfabric.types.gateway_id.GatewayId",
    link_id: "capo_rtbfabric.types.link_id.LinkId",
    *,
    config_overrides: Optional[RTBFabricClientConfig] = None,
) -> "capo_rtbfabric.types.get_link_response.GetLinkResponse":
    """<p>Retrieves information about a link between gateways.</p> <p>Returns detailed information about the link configuration, status, and associated gateways.</p>

    Args:
        gateway_id: <p>The unique identifier of the gateway.</p>
        link_id: <p>The unique identifier of the link.</p>

    Raises:
        capo_rtbfabric.errors.access_denied_exception.AccessDeniedException: <p>The request could not be completed because you do not have sufficient access to perform this action.</p>
        capo_rtbfabric.errors.conflict_exception.ConflictException: <p>The request could not be completed because of a conflict in the current state of the resource.</p>
        capo_rtbfabric.errors.internal_server_exception.InternalServerException: <p>The request could not be completed because of an internal server error. Try your call again.</p>
        capo_rtbfabric.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request could not be completed because the resource does not exist.</p>
        capo_rtbfabric.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_rtbfabric.errors.validation_exception.ValidationException: <p>The request could not be completed because it fails satisfy the constraints specified by the service.</p>
        capo_rtbfabric.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get link details
        Retrieves details of a specific link

        >>> client.get_link(gateway_id='rtb-gw-12345678', link_id='link-87654321')
    """

    def _handler(
        req: "OperationRequest[capo_rtbfabric.types.get_link_request.GetLinkRequest]",
    ) -> OperationResponse[
        "capo_rtbfabric.types.get_link_response.GetLinkResponse"
    ]:
        import capo_rtbfabric._operations.rtb_fabric.get_link

        output, http_response = (
            capo_rtbfabric._operations.rtb_fabric.get_link.get_link(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetLink")
    )
    input_: capo_rtbfabric.types.get_link_request.GetLinkRequest = {
        "gateway_id": gateway_id,
        "link_id": link_id,
    }

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