DescribeKeyValueStore
Specifies the key value store and its configuration.
Request Syntax
GET /2020-05-31/key-value-store/Name
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- Name
-
The name of the key value store.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9-_]{1,64}
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<KeyValueStore>
<ARN>string</ARN>
<Comment>string</Comment>
<Id>string</Id>
<LastModifiedTime>timestamp</LastModifiedTime>
<Name>string</Name>
<Status>string</Status>
</KeyValueStore>
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
- KeyValueStore
-
Root level tag for the KeyValueStore parameters.
Required: Yes
- ARN
-
The Amazon Resource Name (ARN) of the key value store.
Type: String
- Comment
-
A comment for the key value store.
Type: String
- Id
-
The unique Id for the key value store.
Type: String
- LastModifiedTime
-
The last-modified time of the key value store.
Type: Timestamp
- Name
-
The name of the key value store.
Type: String
- Status
-
The status of the key value store.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDenied
-
Access denied.
HTTP Status Code: 403
- EntityNotFound
-
The entity was not found.
HTTP Status Code: 404
- InvalidArgument
-
An argument is invalid.
HTTP Status Code: 400
- UnsupportedOperation
-
This operation is not supported in this region.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: