CloudFrontKeyValueStore / Client / describe_key_value_store

describe_key_value_store#

CloudFrontKeyValueStore.Client.describe_key_value_store(**kwargs)#

Returns metadata information about Key Value Store.

Request Syntax

response = client.describe_key_value_store(
    KvsARN='string'
)

Parameters:

KvsARN (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ItemCount': 123,
    'TotalSizeInBytes': 123,
    'KvsARN': 'string',
    'Created': datetime(2015, 1, 1),
    'ETag': 'string',
    'LastModified': datetime(2015, 1, 1),
    'Status': 'string',
    'FailureReason': 'string'
}

Response Structure

(dict) –

Metadata information about a Key Value Store.
- ItemCount (integer) –
  
  Number of key value pairs in the Key Value Store.
- TotalSizeInBytes (integer) –
  
  Total size of the Key Value Store in bytes.
- KvsARN (string) –
  
  The Amazon Resource Name (ARN) of the Key Value Store.
- Created (datetime) –
  
  Date and time when the Key Value Store was created.
- ETag (string) –
  
  The version identifier for the current version of the Key Value Store.
- LastModified (datetime) –
  
  Date and time when the key value pairs in the Key Value Store was last modified.
- Status (string) –
  
  The current status of the Key Value Store.
- FailureReason (string) –
  
  The reason for Key Value Store creation failure.

Exceptions

CloudFrontKeyValueStore.Client.exceptions.ConflictException
CloudFrontKeyValueStore.Client.exceptions.InternalServerException
CloudFrontKeyValueStore.Client.exceptions.ResourceNotFoundException
CloudFrontKeyValueStore.Client.exceptions.AccessDeniedException