Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetDictionary

Retrieves information about the specified dictionary.

Request Syntax


GET /v1/dictionary/id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

id

The ID of the dictionary to retrieve.

Length Constraints: Minimum length of 1. Maximum length of 19.

Pattern: [a-zA-Z0-9]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "language": "string",
   "name": "string",
   "references": [ "string" ],
   "status": "string",
   "tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

The ARN of the dictionary.

Type: String

id

The ID of the dictionary.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 19.

Pattern: [a-zA-Z0-9]+

language

The language of the dictionary.

Type: String

Valid Values: eng | fra | ita | deu | spa | por

name

The name of the dictionary.

Type: String

Pattern: [a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?

references

A list of feed IDs that reference this dictionary.

Type: Array of strings

Pattern: [a-z0-9]{19}

status

The current status of the dictionary.

Type: String

Valid Values: CREATING | AVAILABLE | REFERENCED | DELETING | DELETED

tags

The tags associated with the dictionary.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerErrorException

An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the action doesn't exist.

HTTP Status Code: 404

TooManyRequestException

The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.

HTTP Status Code: 400