get_api_key ¶

get_api_key(
    api_key: String,
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    include_value: Optional[NullableBoolean] = None,
) -> ApiKey

Gets information about the current ApiKey resource.

Parameters:

api_key (String) –

The identifier of the ApiKey resource.
include_value (Optional[NullableBoolean], default: None ) –

A boolean flag to specify whether (true) or not (false) the result contains the key value.

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_api_key(
    self,
    api_key: "capo_api_gateway.types.string.String",
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    include_value: Optional[
        "capo_api_gateway.types.nullable_boolean.NullableBoolean"
    ] = None,
) -> "capo_api_gateway.types.api_key.ApiKey":
    """<p>Gets information about the current ApiKey resource.</p>

    Args:
        api_key: <p>The identifier of the ApiKey resource.</p>
        include_value: <p>A boolean flag to specify whether (<code>true</code>) or not (<code>false</code>) the result contains the key value.</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_api_key_request.GetApiKeyRequest]",
    ) -> OperationResponse["capo_api_gateway.types.api_key.ApiKey"]:
        import capo_api_gateway._operations.backplane_control_service.get_api_key

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetApiKey")
    )
    input_: capo_api_gateway.types.get_api_key_request.GetApiKeyRequest = {
        "api_key": api_key
    }
    if include_value is not None:
        input_["include_value"] = include_value

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