BatchGetCustomEntityTypes
Retrieves the details for the custom patterns specified by a list of names.
Request Syntax
{
"Names": [ "string
" ]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Names
-
A list of names of the custom patterns that you want to retrieve.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: Yes
Response Syntax
{
"CustomEntityTypes": [
{
"ContextWords": [ "string" ],
"Name": "string",
"RegexString": "string"
}
],
"CustomEntityTypesNotFound": [ "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.
- CustomEntityTypes
-
A list of
CustomEntityType
objects representing the custom patterns that have been created.Type: Array of CustomEntityType objects
- CustomEntityTypesNotFound
-
A list of the names of custom patterns that were not found.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
- OperationTimeoutException
-
The operation timed out.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: