describe_key ¶

describe_key(
    key_name: ResourceName, *, config_overrides: Optional[LocationClientConfig] = None
) -> DescribeKeyResponse

Retrieves the API key resource details.

For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.

Parameters:

key_name (ResourceName) –

The name of the API key resource.

Raises:

AccessDeniedException –

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
InternalServerException –

The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException –

The resource that you've entered was not found in your AWS account.
ThrottlingException –

The request was denied because of request throttling.
ValidationException –

The input failed to meet the constraints specified by the AWS service.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_location/_services/location.py

def describe_key(
    self,
    key_name: "capo_location.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[LocationClientConfig] = None,
) -> "capo_location.types.describe_key_response.DescribeKeyResponse":
    """<p>Retrieves the API key resource details.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">Use API keys to authenticate</a> in the <i>Amazon Location Service Developer Guide</i>.</p>

    Args:
        key_name: <p>The name of the API key resource.</p>

    Raises:
        capo_location.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
        capo_location.errors.internal_server_exception.InternalServerException: <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
        capo_location.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource that you've entered was not found in your AWS account.</p>
        capo_location.errors.throttling_exception.ThrottlingException: <p>The request was denied because of request throttling.</p>
        capo_location.errors.validation_exception.ValidationException: <p>The input failed to meet the constraints specified by the AWS service. </p>
        capo_location.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_location.types.describe_key_request.DescribeKeyRequest]",
    ) -> OperationResponse[
        "capo_location.types.describe_key_response.DescribeKeyResponse"
    ]:
        import capo_location._operations.location_service.describe_key

        output, http_response = (
            capo_location._operations.location_service.describe_key.describe_key(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_location.types.describe_key_response.DescribeKeyResponse",
    ) -> dict[str, Any]:
        import capo_location.types.describe_key_response

        return capo_location.types.describe_key_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeKey", redact_output=_redact_output),
    )
    input_: capo_location.types.describe_key_request.DescribeKeyRequest = {
        "key_name": key_name
    }

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