SchemaDefinition
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
Contents
- type
-
The type of the schema definition. This field specifies the data type of the schema.
Type: String
Valid Values:
string | number | object | array | boolean | integerRequired: Yes
- description
-
The description of the schema definition. This description provides information about the purpose and usage of the schema.
Type: String
Required: No
- items
-
The items in the schema definition. This field is used for array types to define the structure of the array elements.
Type: SchemaDefinition object
Required: No
- properties
-
The properties of the schema definition. These properties define the fields in the schema.
Type: String to SchemaDefinition object map
Required: No
- required
-
The required fields in the schema definition. These fields must be provided when using the schema.
Type: Array of strings
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
