com.amazonaws.services.cloudfrontkeyvaluestore

Interface AmazonCloudFrontKeyValueStore

All Known Subinterfaces:

AmazonCloudFrontKeyValueStoreAsync

All Known Implementing Classes:

AbstractAmazonCloudFrontKeyValueStore, AbstractAmazonCloudFrontKeyValueStoreAsync, AmazonCloudFrontKeyValueStoreAsyncClient, AmazonCloudFrontKeyValueStoreClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCloudFrontKeyValueStore

Interface for accessing Amazon CloudFront KeyValueStore.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonCloudFrontKeyValueStore instead.

Amazon CloudFront KeyValueStore Service to View and Update Data in a KVS Resource

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
DeleteKeyResult	deleteKey(DeleteKeyRequest deleteKeyRequest) Deletes the key value pair specified by the key.
DescribeKeyValueStoreResult	describeKeyValueStore(DescribeKeyValueStoreRequest describeKeyValueStoreRequest) Returns metadata information about Key Value Store.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetKeyResult	getKey(GetKeyRequest getKeyRequest) Returns a key value pair.
ListKeysResult	listKeys(ListKeysRequest listKeysRequest) Returns a list of key value pairs.
PutKeyResult	putKey(PutKeyRequest putKeyRequest) Creates a new key value pair or replaces the value of an existing key.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateKeysResult	updateKeys(UpdateKeysRequest updateKeysRequest) Puts or Deletes multiple key value pairs in a single, all-or-nothing operation.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

deleteKey

DeleteKeyResult deleteKey(DeleteKeyRequest deleteKeyRequest)

Deletes the key value pair specified by the key.

Parameters:

deleteKeyRequest -

Returns:

Result of the DeleteKey operation returned by the service.

Throws:

ConflictException - Resource is not in expected state.

ValidationException - Validation failed.

InternalServerException - Internal server error.

ServiceQuotaExceededException - Limit exceeded.

ResourceNotFoundException - Resource was not found.

AccessDeniedException - Access denied.

See Also:

AWS API Documentation

describeKeyValueStore

DescribeKeyValueStoreResult describeKeyValueStore(DescribeKeyValueStoreRequest describeKeyValueStoreRequest)

Returns metadata information about Key Value Store.

Parameters:

describeKeyValueStoreRequest -

Returns:

Result of the DescribeKeyValueStore operation returned by the service.

Throws:

ConflictException - Resource is not in expected state.

InternalServerException - Internal server error.

ResourceNotFoundException - Resource was not found.

AccessDeniedException - Access denied.

See Also:

AWS API Documentation

getKey

GetKeyResult getKey(GetKeyRequest getKeyRequest)

Returns a key value pair.

Parameters:

getKeyRequest -

Returns:

Result of the GetKey operation returned by the service.

Throws:

ConflictException - Resource is not in expected state.

InternalServerException - Internal server error.

ResourceNotFoundException - Resource was not found.

AccessDeniedException - Access denied.

See Also:

AWS API Documentation

listKeys

ListKeysResult listKeys(ListKeysRequest listKeysRequest)

Returns a list of key value pairs.

Parameters:

listKeysRequest -

Returns:

Result of the ListKeys operation returned by the service.

Throws:

ConflictException - Resource is not in expected state.

ValidationException - Validation failed.

InternalServerException - Internal server error.

ResourceNotFoundException - Resource was not found.

AccessDeniedException - Access denied.

See Also:

AWS API Documentation

putKey

PutKeyResult putKey(PutKeyRequest putKeyRequest)

Creates a new key value pair or replaces the value of an existing key.

Parameters:

putKeyRequest - A key value pair.

Returns:

Result of the PutKey operation returned by the service.

Throws:

ConflictException - Resource is not in expected state.

ValidationException - Validation failed.

InternalServerException - Internal server error.

ServiceQuotaExceededException - Limit exceeded.

ResourceNotFoundException - Resource was not found.

AccessDeniedException - Access denied.

See Also:

AWS API Documentation

updateKeys

UpdateKeysResult updateKeys(UpdateKeysRequest updateKeysRequest)

Puts or Deletes multiple key value pairs in a single, all-or-nothing operation.

Parameters:

updateKeysRequest -

Returns:

Result of the UpdateKeys operation returned by the service.

Throws:

ConflictException - Resource is not in expected state.

ValidationException - Validation failed.

InternalServerException - Internal server error.

ServiceQuotaExceededException - Limit exceeded.

ResourceNotFoundException - Resource was not found.

AccessDeniedException - Access denied.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.