com.amazonaws.services.cloudfrontkeyvaluestore

Class AmazonCloudFrontKeyValueStoreClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cloudfrontkeyvaluestore.AmazonCloudFrontKeyValueStoreClient

All Implemented Interfaces:

AmazonCloudFrontKeyValueStore

Direct Known Subclasses:

AmazonCloudFrontKeyValueStoreAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonCloudFrontKeyValueStoreClient
extends AmazonWebServiceClient
implements AmazonCloudFrontKeyValueStore

Client for accessing Amazon CloudFront KeyValueStore. All service calls made using this client are blocking, and will not return until the service call completes.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.cloudfrontkeyvaluestore.AmazonCloudFrontKeyValueStore

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonCloudFrontKeyValueStoreClientBuilder	builder()
DeleteKeyResult	deleteKey(DeleteKeyRequest request) Deletes the key value pair specified by the key.
DescribeKeyValueStoreResult	describeKeyValueStore(DescribeKeyValueStoreRequest request) 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 request) Returns a key value pair.
ListKeysResult	listKeys(ListKeysRequest request) Returns a list of key value pairs.
PutKeyResult	putKey(PutKeyRequest request) 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 request) Puts or Deletes multiple key value pairs in a single, all-or-nothing operation.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonCloudFrontKeyValueStoreClientBuilder builder()

deleteKey

public DeleteKeyResult deleteKey(DeleteKeyRequest request)

Deletes the key value pair specified by the key.

Specified by:

deleteKey in interface AmazonCloudFrontKeyValueStore

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

public DescribeKeyValueStoreResult describeKeyValueStore(DescribeKeyValueStoreRequest request)

Returns metadata information about Key Value Store.

Specified by:

describeKeyValueStore in interface AmazonCloudFrontKeyValueStore

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

public GetKeyResult getKey(GetKeyRequest request)

Returns a key value pair.

Specified by:

getKey in interface AmazonCloudFrontKeyValueStore

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

public ListKeysResult listKeys(ListKeysRequest request)

Returns a list of key value pairs.

Specified by:

listKeys in interface AmazonCloudFrontKeyValueStore

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

public PutKeyResult putKey(PutKeyRequest request)

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

Specified by:

putKey in interface AmazonCloudFrontKeyValueStore

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

public UpdateKeysResult updateKeys(UpdateKeysRequest request)

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

Specified by:

updateKeys in interface AmazonCloudFrontKeyValueStore

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonCloudFrontKeyValueStore

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from interface: AmazonCloudFrontKeyValueStore

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.

Specified by:

shutdown in interface AmazonCloudFrontKeyValueStore

Overrides:

shutdown in class AmazonWebServiceClient