Package software.amazon.awssdk.services.cloudfrontkeyvaluestore

Interface CloudFrontKeyValueStoreClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface CloudFrontKeyValueStoreClient
extends AwsClient

Service client for accessing Amazon CloudFront KeyValueStore. This can be created using the static builder() method.

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static CloudFrontKeyValueStoreClientBuilder	builder()	Create a builder that can be used to configure and create a CloudFrontKeyValueStoreClient.
static CloudFrontKeyValueStoreClient	create()	Create a CloudFrontKeyValueStoreClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DeleteKeyResponse	deleteKey(Consumer<DeleteKeyRequest.Builder> deleteKeyRequest)	Deletes the key value pair specified by the key.
default DeleteKeyResponse	deleteKey(DeleteKeyRequest deleteKeyRequest)	Deletes the key value pair specified by the key.
default DescribeKeyValueStoreResponse	describeKeyValueStore(Consumer<DescribeKeyValueStoreRequest.Builder> describeKeyValueStoreRequest)	Returns metadata information about Key Value Store.
default DescribeKeyValueStoreResponse	describeKeyValueStore(DescribeKeyValueStoreRequest describeKeyValueStoreRequest)	Returns metadata information about Key Value Store.
default GetKeyResponse	getKey(Consumer<GetKeyRequest.Builder> getKeyRequest)	Returns a key value pair.
default GetKeyResponse	getKey(GetKeyRequest getKeyRequest)	Returns a key value pair.
default ListKeysResponse	listKeys(Consumer<ListKeysRequest.Builder> listKeysRequest)	Returns a list of key value pairs.
default ListKeysResponse	listKeys(ListKeysRequest listKeysRequest)	Returns a list of key value pairs.
default ListKeysIterable	listKeysPaginator(Consumer<ListKeysRequest.Builder> listKeysRequest)	This is a variant of listKeys(software.amazon.awssdk.services.cloudfrontkeyvaluestore.model.ListKeysRequest) operation.
default ListKeysIterable	listKeysPaginator(ListKeysRequest listKeysRequest)	This is a variant of listKeys(software.amazon.awssdk.services.cloudfrontkeyvaluestore.model.ListKeysRequest) operation.
default PutKeyResponse	putKey(Consumer<PutKeyRequest.Builder> putKeyRequest)	Creates a new key value pair or replaces the value of an existing key.
default PutKeyResponse	putKey(PutKeyRequest putKeyRequest)	Creates a new key value pair or replaces the value of an existing key.
default CloudFrontKeyValueStoreServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default UpdateKeysResponse	updateKeys(Consumer<UpdateKeysRequest.Builder> updateKeysRequest)	Puts or Deletes multiple key value pairs in a single, all-or-nothing operation.
default UpdateKeysResponse	updateKeys(UpdateKeysRequest updateKeysRequest)	Puts or Deletes multiple key value pairs in a single, all-or-nothing operation.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

deleteKey

default DeleteKeyResponse deleteKey(DeleteKeyRequest deleteKeyRequest)
                             throws ConflictException,
                                    ValidationException,
                                    InternalServerException,
                                    ServiceQuotaExceededException,
                                    ResourceNotFoundException,
                                    AccessDeniedException,
                                    AwsServiceException,
                                    SdkClientException,
                                    CloudFrontKeyValueStoreException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CloudFrontKeyValueStoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteKey

default DeleteKeyResponse deleteKey(Consumer<DeleteKeyRequest.Builder> deleteKeyRequest)
                             throws ConflictException,
                                    ValidationException,
                                    InternalServerException,
                                    ServiceQuotaExceededException,
                                    ResourceNotFoundException,
                                    AccessDeniedException,
                                    AwsServiceException,
                                    SdkClientException,
                                    CloudFrontKeyValueStoreException

Deletes the key value pair specified by the key.

This is a convenience which creates an instance of the DeleteKeyRequest.Builder avoiding the need to create one manually via DeleteKeyRequest.builder()

Parameters:

deleteKeyRequest - A Consumer that will call methods on DeleteKeyRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CloudFrontKeyValueStoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeKeyValueStore

default DescribeKeyValueStoreResponse describeKeyValueStore(DescribeKeyValueStoreRequest describeKeyValueStoreRequest)
                                                     throws ConflictException,
                                                            InternalServerException,
                                                            ResourceNotFoundException,
                                                            AccessDeniedException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            CloudFrontKeyValueStoreException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CloudFrontKeyValueStoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeKeyValueStore

default DescribeKeyValueStoreResponse describeKeyValueStore(Consumer<DescribeKeyValueStoreRequest.Builder> describeKeyValueStoreRequest)
                                                     throws ConflictException,
                                                            InternalServerException,
                                                            ResourceNotFoundException,
                                                            AccessDeniedException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            CloudFrontKeyValueStoreException

Returns metadata information about Key Value Store.

This is a convenience which creates an instance of the DescribeKeyValueStoreRequest.Builder avoiding the need to create one manually via DescribeKeyValueStoreRequest.builder()

Parameters:

describeKeyValueStoreRequest - A Consumer that will call methods on DescribeKeyValueStoreRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CloudFrontKeyValueStoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getKey

default GetKeyResponse getKey(GetKeyRequest getKeyRequest)
                       throws ConflictException,
                              InternalServerException,
                              ResourceNotFoundException,
                              AccessDeniedException,
                              AwsServiceException,
                              SdkClientException,
                              CloudFrontKeyValueStoreException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CloudFrontKeyValueStoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getKey

default GetKeyResponse getKey(Consumer<GetKeyRequest.Builder> getKeyRequest)
                       throws ConflictException,
                              InternalServerException,
                              ResourceNotFoundException,
                              AccessDeniedException,
                              AwsServiceException,
                              SdkClientException,
                              CloudFrontKeyValueStoreException

Returns a key value pair.

This is a convenience which creates an instance of the GetKeyRequest.Builder avoiding the need to create one manually via GetKeyRequest.builder()

Parameters:

getKeyRequest - A Consumer that will call methods on GetKeyRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CloudFrontKeyValueStoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listKeys

default ListKeysResponse listKeys(ListKeysRequest listKeysRequest)
                           throws ConflictException,
                                  ValidationException,
                                  InternalServerException,
                                  ResourceNotFoundException,
                                  AccessDeniedException,
                                  AwsServiceException,
                                  SdkClientException,
                                  CloudFrontKeyValueStoreException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CloudFrontKeyValueStoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listKeys

default ListKeysResponse listKeys(Consumer<ListKeysRequest.Builder> listKeysRequest)
                           throws ConflictException,
                                  ValidationException,
                                  InternalServerException,
                                  ResourceNotFoundException,
                                  AccessDeniedException,
                                  AwsServiceException,
                                  SdkClientException,
                                  CloudFrontKeyValueStoreException

Returns a list of key value pairs.

This is a convenience which creates an instance of the ListKeysRequest.Builder avoiding the need to create one manually via ListKeysRequest.builder()

Parameters:

listKeysRequest - A Consumer that will call methods on ListKeysRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CloudFrontKeyValueStoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listKeysPaginator

default ListKeysIterable listKeysPaginator(ListKeysRequest listKeysRequest)
                                    throws ConflictException,
                                           ValidationException,
                                           InternalServerException,
                                           ResourceNotFoundException,
                                           AccessDeniedException,
                                           AwsServiceException,
                                           SdkClientException,
                                           CloudFrontKeyValueStoreException

This is a variant of listKeys(software.amazon.awssdk.services.cloudfrontkeyvaluestore.model.ListKeysRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudfrontkeyvaluestore.paginators.ListKeysIterable responses = client.listKeysPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudfrontkeyvaluestore.paginators.ListKeysIterable responses = client
             .listKeysPaginator(request);
     for (software.amazon.awssdk.services.cloudfrontkeyvaluestore.model.ListKeysResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudfrontkeyvaluestore.paginators.ListKeysIterable responses = client.listKeysPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listKeys(software.amazon.awssdk.services.cloudfrontkeyvaluestore.model.ListKeysRequest) operation.

Parameters:

listKeysRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ConflictException - Resource is not in expected state.

ValidationException - Validation failed.

InternalServerException - Internal server error.

ResourceNotFoundException - Resource was not found.

AccessDeniedException - Access denied.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CloudFrontKeyValueStoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listKeysPaginator

default ListKeysIterable listKeysPaginator(Consumer<ListKeysRequest.Builder> listKeysRequest)
                                    throws ConflictException,
                                           ValidationException,
                                           InternalServerException,
                                           ResourceNotFoundException,
                                           AccessDeniedException,
                                           AwsServiceException,
                                           SdkClientException,
                                           CloudFrontKeyValueStoreException

This is a variant of listKeys(software.amazon.awssdk.services.cloudfrontkeyvaluestore.model.ListKeysRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudfrontkeyvaluestore.paginators.ListKeysIterable responses = client.listKeysPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudfrontkeyvaluestore.paginators.ListKeysIterable responses = client
             .listKeysPaginator(request);
     for (software.amazon.awssdk.services.cloudfrontkeyvaluestore.model.ListKeysResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudfrontkeyvaluestore.paginators.ListKeysIterable responses = client.listKeysPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listKeys(software.amazon.awssdk.services.cloudfrontkeyvaluestore.model.ListKeysRequest) operation.

This is a convenience which creates an instance of the ListKeysRequest.Builder avoiding the need to create one manually via ListKeysRequest.builder()

Parameters:

listKeysRequest - A Consumer that will call methods on ListKeysRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ConflictException - Resource is not in expected state.

ValidationException - Validation failed.

InternalServerException - Internal server error.

ResourceNotFoundException - Resource was not found.

AccessDeniedException - Access denied.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CloudFrontKeyValueStoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putKey

default PutKeyResponse putKey(PutKeyRequest putKeyRequest)
                       throws ConflictException,
                              ValidationException,
                              InternalServerException,
                              ServiceQuotaExceededException,
                              ResourceNotFoundException,
                              AccessDeniedException,
                              AwsServiceException,
                              SdkClientException,
                              CloudFrontKeyValueStoreException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CloudFrontKeyValueStoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putKey

default PutKeyResponse putKey(Consumer<PutKeyRequest.Builder> putKeyRequest)
                       throws ConflictException,
                              ValidationException,
                              InternalServerException,
                              ServiceQuotaExceededException,
                              ResourceNotFoundException,
                              AccessDeniedException,
                              AwsServiceException,
                              SdkClientException,
                              CloudFrontKeyValueStoreException

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

This is a convenience which creates an instance of the PutKeyRequest.Builder avoiding the need to create one manually via PutKeyRequest.builder()

Parameters:

putKeyRequest - A Consumer that will call methods on PutKeyRequest.Builder to create a request. 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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CloudFrontKeyValueStoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateKeys

default UpdateKeysResponse updateKeys(UpdateKeysRequest updateKeysRequest)
                               throws ConflictException,
                                      ValidationException,
                                      InternalServerException,
                                      ServiceQuotaExceededException,
                                      ResourceNotFoundException,
                                      AccessDeniedException,
                                      AwsServiceException,
                                      SdkClientException,
                                      CloudFrontKeyValueStoreException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CloudFrontKeyValueStoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateKeys

default UpdateKeysResponse updateKeys(Consumer<UpdateKeysRequest.Builder> updateKeysRequest)
                               throws ConflictException,
                                      ValidationException,
                                      InternalServerException,
                                      ServiceQuotaExceededException,
                                      ResourceNotFoundException,
                                      AccessDeniedException,
                                      AwsServiceException,
                                      SdkClientException,
                                      CloudFrontKeyValueStoreException

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

This is a convenience which creates an instance of the UpdateKeysRequest.Builder avoiding the need to create one manually via UpdateKeysRequest.builder()

Parameters:

updateKeysRequest - A Consumer that will call methods on UpdateKeysRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

CloudFrontKeyValueStoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static CloudFrontKeyValueStoreClient create()

Create a CloudFrontKeyValueStoreClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CloudFrontKeyValueStoreClientBuilder builder()

Create a builder that can be used to configure and create a CloudFrontKeyValueStoreClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default CloudFrontKeyValueStoreServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient