SDK for PHP 3.x

Amazon CloudFront KeyValueStore 2022-07-26

Client: Aws\CloudFrontKeyValueStore\CloudFrontKeyValueStoreClient
Service ID: cloudfront-keyvaluestore
Version: 2022-07-26

This page describes the parameters and results for the operations of the Amazon CloudFront KeyValueStore (2022-07-26), and shows how to use the Aws\CloudFrontKeyValueStore\CloudFrontKeyValueStoreClient object to call the described operations. This documentation is specific to the 2022-07-26 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

DeleteKey ( array $params = [] )
Deletes the key value pair specified by the key.
DescribeKeyValueStore ( array $params = [] )
Returns metadata information about Key Value Store.
GetKey ( array $params = [] )
Returns a key value pair.
ListKeys ( array $params = [] )
Returns a list of key value pairs.
PutKey ( array $params = [] )
Creates a new key value pair or replaces the value of an existing key.
UpdateKeys ( array $params = [] )
Puts or Deletes multiple key value pairs in a single, all-or-nothing operation.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListKeys

Operations

DeleteKey 

$result = $client->deleteKey([/* ... */]);
$promise = $client->deleteKeyAsync([/* ... */]);

Deletes the key value pair specified by the key.

Parameter Syntax

$result = $client->deleteKey([
    'IfMatch' => '<string>', // REQUIRED
    'Key' => '<string>', // REQUIRED
    'KvsARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
IfMatch
Required: Yes
Type: string

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

Key
Required: Yes
Type: string

The key to delete.

KvsARN
Required: Yes
Type: string

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

Result Syntax

[
    'ETag' => '<string>',
    'ItemCount' => <integer>,
    'TotalSizeInBytes' => <integer>,
]

Result Details

Members
ETag
Required: Yes
Type: string

The current version identifier of the Key Value Store after the successful delete.

ItemCount
Required: Yes
Type: int

Number of key value pairs in the Key Value Store after the successful delete.

TotalSizeInBytes
Required: Yes
Type: long (int|float)

Total size of the Key Value Store after the successful delete, in bytes.

Errors

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.

DescribeKeyValueStore 

$result = $client->describeKeyValueStore([/* ... */]);
$promise = $client->describeKeyValueStoreAsync([/* ... */]);

Returns metadata information about Key Value Store.

Parameter Syntax

$result = $client->describeKeyValueStore([
    'KvsARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
KvsARN
Required: Yes
Type: string

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

Result Syntax

[
    'Created' => <DateTime>,
    'ETag' => '<string>',
    'FailureReason' => '<string>',
    'ItemCount' => <integer>,
    'KvsARN' => '<string>',
    'LastModified' => <DateTime>,
    'Status' => '<string>',
    'TotalSizeInBytes' => <integer>,
]

Result Details

Members
Created
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Date and time when the Key Value Store was created.

ETag
Required: Yes
Type: string

The version identifier for the current version of the Key Value Store.

FailureReason
Type: string

The reason for Key Value Store creation failure.

ItemCount
Required: Yes
Type: int

Number of key value pairs in the Key Value Store.

KvsARN
Required: Yes
Type: string

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

LastModified
Type: timestamp (string|DateTime or anything parsable by strtotime)

Date and time when the key value pairs in the Key Value Store was last modified.

Status
Type: string

The current status of the Key Value Store.

TotalSizeInBytes
Required: Yes
Type: long (int|float)

Total size of the Key Value Store in bytes.

Errors

ConflictException:

Resource is not in expected state.

InternalServerException:

Internal server error.

ResourceNotFoundException:

Resource was not found.

AccessDeniedException:

Access denied.

GetKey 

$result = $client->getKey([/* ... */]);
$promise = $client->getKeyAsync([/* ... */]);

Returns a key value pair.

Parameter Syntax

$result = $client->getKey([
    'Key' => '<string>', // REQUIRED
    'KvsARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
Key
Required: Yes
Type: string

The key to get.

KvsARN
Required: Yes
Type: string

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

Result Syntax

[
    'ItemCount' => <integer>,
    'Key' => '<string>',
    'TotalSizeInBytes' => <integer>,
    'Value' => '<string>',
]

Result Details

Members
ItemCount
Required: Yes
Type: int

Number of key value pairs in the Key Value Store.

Key
Required: Yes
Type: string

The key of the key value pair.

TotalSizeInBytes
Required: Yes
Type: long (int|float)

Total size of the Key Value Store in bytes.

Value
Required: Yes
Type: string

The value of the key value pair.

Errors

ConflictException:

Resource is not in expected state.

InternalServerException:

Internal server error.

ResourceNotFoundException:

Resource was not found.

AccessDeniedException:

Access denied.

ListKeys 

$result = $client->listKeys([/* ... */]);
$promise = $client->listKeysAsync([/* ... */]);

Returns a list of key value pairs.

Parameter Syntax

$result = $client->listKeys([
    'KvsARN' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
KvsARN
Required: Yes
Type: string

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

MaxResults
Type: int

Maximum number of results that are returned per call. The default is 10 and maximum allowed page is 50.

NextToken
Type: string

If nextToken is returned in the response, there are more results available. Make the next call using the returned token to retrieve the next page.

Result Syntax

[
    'Items' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Items
Type: Array of ListKeysResponseListItem structures

Key value pairs

NextToken
Type: string

If nextToken is returned in the response, there are more results available. Make the next call using the returned token to retrieve the next page.

Errors

ConflictException:

Resource is not in expected state.

ValidationException:

Validation failed.

InternalServerException:

Internal server error.

ResourceNotFoundException:

Resource was not found.

AccessDeniedException:

Access denied.

PutKey 

$result = $client->putKey([/* ... */]);
$promise = $client->putKeyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->putKey([
    'IfMatch' => '<string>', // REQUIRED
    'Key' => '<string>', // REQUIRED
    'KvsARN' => '<string>', // REQUIRED
    'Value' => '<string>', // REQUIRED
]);

Parameter Details

Members
IfMatch
Required: Yes
Type: string

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

Key
Required: Yes
Type: string

The key to put.

KvsARN
Required: Yes
Type: string

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

Value
Required: Yes
Type: string

The value to put.

Result Syntax

[
    'ETag' => '<string>',
    'ItemCount' => <integer>,
    'TotalSizeInBytes' => <integer>,
]

Result Details

Members
ETag
Required: Yes
Type: string

The current version identifier of the Key Value Store after the successful put.

ItemCount
Required: Yes
Type: int

Number of key value pairs in the Key Value Store after the successful put.

TotalSizeInBytes
Required: Yes
Type: long (int|float)

Total size of the Key Value Store after the successful put, in bytes.

Errors

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.

UpdateKeys 

$result = $client->updateKeys([/* ... */]);
$promise = $client->updateKeysAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateKeys([
    'Deletes' => [
        [
            'Key' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'IfMatch' => '<string>', // REQUIRED
    'KvsARN' => '<string>', // REQUIRED
    'Puts' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
Deletes
Type: Array of DeleteKeyRequestListItem structures

List of keys to delete.

IfMatch
Required: Yes
Type: string

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

KvsARN
Required: Yes
Type: string

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

Puts
Type: Array of PutKeyRequestListItem structures

List of key value pairs to put.

Result Syntax

[
    'ETag' => '<string>',
    'ItemCount' => <integer>,
    'TotalSizeInBytes' => <integer>,
]

Result Details

Members
ETag
Required: Yes
Type: string

The current version identifier of the Key Value Store after the successful update.

ItemCount
Required: Yes
Type: int

Number of key value pairs in the Key Value Store after the successful update.

TotalSizeInBytes
Required: Yes
Type: long (int|float)

Total size of the Key Value Store after the successful update, in bytes.

Errors

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.

Shapes

AccessDeniedException

Description

Access denied.

Members
Message
Type: string

ConflictException

Description

Resource is not in expected state.

Members
Message
Type: string

DeleteKeyRequestListItem

Description

List item for keys to delete.

Members
Key
Required: Yes
Type: string

The key of the key value pair to be deleted.

InternalServerException

Description

Internal server error.

Members
Message
Type: string

ListKeysResponseListItem

Description

A key value pair.

Members
Key
Required: Yes
Type: string

The key of the key value pair.

Value
Required: Yes
Type: string

The value of the key value pair.

PutKeyRequestListItem

Description

List item for key value pair to put.

Members
Key
Required: Yes
Type: string

The key of the key value pair list item to put.

Value
Required: Yes
Type: string

The value for the key value pair to put.

ResourceNotFoundException

Description

Resource was not found.

Members
Message
Type: string

ServiceQuotaExceededException

Description

Limit exceeded.

Members
Message
Type: string

ValidationException

Description

Validation failed.

Members
Message
Type: string