Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListCustomEntityTypes

Lists all the custom patterns that have been created.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "Tags": { 
      "string" : "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.

MaxResults

The maximum number of results to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

A paginated token to offset the results.

Type: String

Required: No

Tags

A list of key-value pair tags.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

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

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

Required: No

Response Syntax


{
   "CustomEntityTypes": [ 
      { 
         "ContextWords": [ "string" ],
         "Name": "string",
         "RegexString": "string"
      }
   ],
   "NextToken": "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 custom patterns.

Type: Array of CustomEntityType objects

NextToken

A pagination token, if more results are available.

Type: String

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