Skip to content

list_links 

list_links(
    gateway_id: GatewayId,
    *,
    config_overrides: Optional[RTBFabricClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> ListLinksResponse

Lists links associated with gateways.

Returns a list of all links for the specified gateways, including their status and configuration details.

Parameters:

  • gateway_id (GatewayId) –

    The unique identifier of the gateway.

  • next_token (Optional[str], default: None ) –

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • max_results (Optional[int], default: None ) –

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Raises:

  • AccessDeniedException –

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

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

List links for a gateway Lists all links for the specified gateway

>>> client.list_links(gateway_id='rtb-gw-12345678', max_results=10)
Source code in docs_src/capo_rtbfabric/_services/rtb_fabric.py 
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
def list_links(
    self,
    gateway_id: "capo_rtbfabric.types.gateway_id.GatewayId",
    *,
    config_overrides: Optional[RTBFabricClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> "capo_rtbfabric.types.list_links_response.ListLinksResponse":
    """<p>Lists links associated with gateways.</p> <p>Returns a list of all links for the specified gateways, including their status and configuration details.</p>

    Args:
        gateway_id: <p>The unique identifier of the gateway.</p>
        next_token: <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken error</i>.</p>
        max_results: <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.</p> <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</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.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:
        List links for a gateway
        Lists all links for the specified gateway

        >>> client.list_links(gateway_id='rtb-gw-12345678', max_results=10)
    """

    def _handler(
        req: "OperationRequest[capo_rtbfabric.types.list_links_request.ListLinksRequest]",
    ) -> OperationResponse[
        "capo_rtbfabric.types.list_links_response.ListLinksResponse"
    ]:
        import capo_rtbfabric._operations.rtb_fabric.list_links

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListLinks")
    )
    input_: capo_rtbfabric.types.list_links_request.ListLinksRequest = {
        "gateway_id": gateway_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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