DescribeKeyValueStore
Returns metadata information about the key value store.
Request Syntax
GET /key-value-stores/KvsARN HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- KvsARN
-
The Amazon Resource Name (ARN) of the key value store.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
ETag: ETag
Content-type: application/json
{
"Created": number,
"FailureReason": "string",
"ItemCount": number,
"KvsARN": "string",
"LastModified": number,
"Status": "string",
"TotalSizeInBytes": number
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
- ETag
-
The version identifier for the current version of the key value store.
The following data is returned in JSON format by the service.
- Created
-
Date and time when the key value store was created.
Type: Timestamp
- FailureReason
-
The reason why the key value store wasn't created.
Type: String
- ItemCount
-
Number of key-value pairs in the key value store.
Type: Integer
- KvsARN
-
The Amazon Resource Name (ARN) of the key value store.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
- LastModified
-
Date and time when the key-value pairs in the key value store was last modified.
Type: Timestamp
- Status
-
The current status of the key value store.
Type: String
- TotalSizeInBytes
-
Total size of the key value store in bytes.
Type: Long
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access denied.
HTTP Status Code: 403
- ConflictException
-
Resource is not in expected state.
HTTP Status Code: 409
- InternalServerException
-
Internal server error.
HTTP Status Code: 500
- ResourceNotFoundException
-
Resource was not found.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
