Gets all the usage plan keys representing the API keys added to a specified usage plan.
Parameters:
-
usage_plan_id
(String)
–
The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
-
position
(Optional[String], default:
None
)
–
The current pagination position in the paged result set.
-
limit
(Optional[NullableInteger], default:
None
)
–
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
-
name_query
(Optional[String], default:
None
)
–
A query parameter specifying the name of the to-be-returned usage plan keys.
Raises:
-
BadRequestException
–
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
NotFoundException
–
The requested resource is not found. Make sure that the request URI is correct.
-
TooManyRequestsException
–
The request has reached its throttling limit. Retry after the specified time period.
-
UnauthorizedException
–
The request is denied because the caller has insufficient permissions.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_api_gateway/_services/api_gateway.py
| def get_usage_plan_keys(
self,
usage_plan_id: "capo_api_gateway.types.string.String",
*,
config_overrides: Optional[APIGatewayClientConfig] = None,
position: Optional["capo_api_gateway.types.string.String"] = None,
limit: Optional[
"capo_api_gateway.types.nullable_integer.NullableInteger"
] = None,
name_query: Optional["capo_api_gateway.types.string.String"] = None,
) -> "capo_api_gateway.types.usage_plan_keys.UsagePlanKeys":
"""<p>Gets all the usage plan keys representing the API keys added to a specified usage plan.</p>
Args:
usage_plan_id: <p>The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.</p>
position: <p>The current pagination position in the paged result set.</p>
limit: <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
name_query: <p>A query parameter specifying the name of the to-be-returned usage plan keys.</p>
Raises:
capo_api_gateway.errors.bad_request_exception.BadRequestException: <p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
capo_api_gateway.errors.not_found_exception.NotFoundException: <p>The requested resource is not found. Make sure that the request URI is correct.</p>
capo_api_gateway.errors.too_many_requests_exception.TooManyRequestsException: <p>The request has reached its throttling limit. Retry after the specified time period.</p>
capo_api_gateway.errors.unauthorized_exception.UnauthorizedException: <p>The request is denied because the caller has insufficient permissions.</p>
capo_api_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_api_gateway.types.get_usage_plan_keys_request.GetUsagePlanKeysRequest]",
) -> OperationResponse["capo_api_gateway.types.usage_plan_keys.UsagePlanKeys"]:
import capo_api_gateway._operations.backplane_control_service.get_usage_plan_keys
output, http_response = (
capo_api_gateway._operations.backplane_control_service.get_usage_plan_keys.get_usage_plan_keys(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetUsagePlanKeys")
)
input_: capo_api_gateway.types.get_usage_plan_keys_request.GetUsagePlanKeysRequest = {
"usage_plan_id": usage_plan_id
}
if position is not None:
input_["position"] = position
if limit is not None:
input_["limit"] = limit
if name_query is not None:
input_["name_query"] = name_query
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|