Lists reponder gateways.
Parameters:
-
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.
-
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.
Raises:
-
InternalServerException
–
The request could not be completed because of an internal server error. Try your call again.
-
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 responder gateways with default pagination
Lists responder gateways using default pagination settings
>>> client.list_responder_gateways(max_results=10)
List responder gateways with pagination token
Lists responder gateways using a pagination token to get the next page
>>> client.list_responder_gateways(max_results=3, next_token='eyJsYXN0RXZhbHVhdGVkS2V5Ijp7ImlkIjp7IlMiOiJydGJhcHAtcmVzcC01NDMyMSJ9fX0=')
Source code in docs_src/capo_rtbfabric/_services/rtb_fabric.py
| def list_responder_gateways(
self,
*,
config_overrides: Optional[RTBFabricClientConfig] = None,
max_results: Optional[int] = None,
next_token: Optional[str] = None,
) -> "capo_rtbfabric.types.list_responder_gateways_response.ListResponderGatewaysResponse":
"""<p>Lists reponder gateways.</p>
Args:
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>
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>
Raises:
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.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 responder gateways with default pagination
Lists responder gateways using default pagination settings
>>> client.list_responder_gateways(max_results=10)
List responder gateways with pagination token
Lists responder gateways using a pagination token to get the next page
>>> client.list_responder_gateways(max_results=3, next_token='eyJsYXN0RXZhbHVhdGVkS2V5Ijp7ImlkIjp7IlMiOiJydGJhcHAtcmVzcC01NDMyMSJ9fX0=')
"""
def _handler(
req: "OperationRequest[capo_rtbfabric.types.list_responder_gateways_request.ListResponderGatewaysRequest]",
) -> OperationResponse[
"capo_rtbfabric.types.list_responder_gateways_response.ListResponderGatewaysResponse"
]:
import capo_rtbfabric._operations.rtb_fabric.list_responder_gateways
output, http_response = (
capo_rtbfabric._operations.rtb_fabric.list_responder_gateways.list_responder_gateways(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListResponderGateways")
)
input_: capo_rtbfabric.types.list_responder_gateways_request.ListResponderGatewaysRequest = {}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|