delete_key ¶

delete_key(
    kvs_arn: KvsARN,
    key: Key,
    if_match: Etag,
    *,
    config_overrides: Optional[CloudFrontKeyValueStoreClientConfig] = None,
) -> DeleteKeyResponse

Deletes the key value pair specified by the key.

Parameters:

kvs_arn (KvsARN) –

The Amazon Resource Name (ARN) of the Key Value Store.
key (Key) –

The key to delete.
if_match (Etag) –

The current version (ETag) of the Key Value Store that you are deleting keys from, which you can get using DescribeKeyValueStore.

Raises:

AccessDeniedException –

Access denied.
ConflictException –

Resource is not in expected state.
InternalServerException –

Internal server error.
ResourceNotFoundException –

Resource was not found.
ServiceQuotaExceededException –

Limit exceeded.
ValidationException –

Validation failed.
UnknownServiceError –

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

Examples:

Delete 'key1' from the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58'

>>> client.delete_key(key='key1', kvs_arn='arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58', if_match='KV0AB12C3DEF456')

Source code in docs_src/capo_cloudfront_keyvaluestore/_services/cloud_front_key_value_store.py

def delete_key(
    self,
    kvs_arn: "capo_cloudfront_keyvaluestore.types.kvs_arn.KvsARN",
    key: "capo_cloudfront_keyvaluestore.types.key.Key",
    if_match: "capo_cloudfront_keyvaluestore.types.etag.Etag",
    *,
    config_overrides: Optional[CloudFrontKeyValueStoreClientConfig] = None,
) -> "capo_cloudfront_keyvaluestore.types.delete_key_response.DeleteKeyResponse":
    """<p>Deletes the key value pair specified by the key.</p>

    Args:
        kvs_arn: <p>The Amazon Resource Name (ARN) of the Key Value Store.</p>
        key: <p>The key to delete.</p>
        if_match: <p>The current version (ETag) of the Key Value Store that you are deleting keys from, which you can get using DescribeKeyValueStore.</p>

    Raises:
        capo_cloudfront_keyvaluestore.errors.access_denied_exception.AccessDeniedException: <p>Access denied.</p>
        capo_cloudfront_keyvaluestore.errors.conflict_exception.ConflictException: <p>Resource is not in expected state.</p>
        capo_cloudfront_keyvaluestore.errors.internal_server_exception.InternalServerException: <p>Internal server error.</p>
        capo_cloudfront_keyvaluestore.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource was not found.</p>
        capo_cloudfront_keyvaluestore.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Limit exceeded.</p>
        capo_cloudfront_keyvaluestore.errors.validation_exception.ValidationException: <p>Validation failed.</p>
        capo_cloudfront_keyvaluestore.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Delete 'key1' from the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58'

        >>> client.delete_key(key='key1', kvs_arn='arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58', if_match='KV0AB12C3DEF456')
    """

    def _handler(
        req: "OperationRequest[capo_cloudfront_keyvaluestore.types.delete_key_request.DeleteKeyRequest]",
    ) -> OperationResponse[
        "capo_cloudfront_keyvaluestore.types.delete_key_response.DeleteKeyResponse"
    ]:
        import capo_cloudfront_keyvaluestore._operations.cloud_front_key_value_store.delete_key

        output, http_response = (
            capo_cloudfront_keyvaluestore._operations.cloud_front_key_value_store.delete_key.delete_key(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteKey")
    )
    input_: capo_cloudfront_keyvaluestore.types.delete_key_request.DeleteKeyRequest = {
        "kvs_arn": kvs_arn,
        "key": key,
        "if_match": if_match,
    }

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