get_usage_plan_key ¶

get_usage_plan_key(
    usage_plan_id: String,
    key_id: String,
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
) -> UsagePlanKey

Gets a usage plan key of a given key identifier.

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.
key_id (String) –

The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

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_key(
    self,
    usage_plan_id: "capo_api_gateway.types.string.String",
    key_id: "capo_api_gateway.types.string.String",
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
) -> "capo_api_gateway.types.usage_plan_key.UsagePlanKey":
    """<p>Gets a usage plan key of a given key identifier.</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>
        key_id: <p>The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.</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_key_request.GetUsagePlanKeyRequest]",
    ) -> OperationResponse["capo_api_gateway.types.usage_plan_key.UsagePlanKey"]:
        import capo_api_gateway._operations.backplane_control_service.get_usage_plan_key

        output, http_response = (
            capo_api_gateway._operations.backplane_control_service.get_usage_plan_key.get_usage_plan_key(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetUsagePlanKey")
    )
    input_: capo_api_gateway.types.get_usage_plan_key_request.GetUsagePlanKeyRequest = {
        "usage_plan_id": usage_plan_id,
        "key_id": key_id,
    }

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