Definitions for @turbot/aws-comprehend

comprehend

{
"allOf": [
{
"$ref": "turbot#/definitions/service"
},
{
"type": "object",
"properties": {
"name": {
"const": "Comprehend"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/comprehendAka"
}
},
"title": {
"const": "Comprehend"
},
"custom": {
"type": "object",
"properties": {
"aws": {
"$ref": "aws#/definitions/awsMetadata"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "All data are valid",
"input": {
"name": "Comprehend",
"turbot": {
"akas": [
"arn:aws:comprehend:us-east-1:123123123123"
],
"title": "Comprehend",
"custom": {
"aws": {
"accountId": 123456789012,
"regionName": "us-east-1"
}
}
}
}
}
]
}
],
".turbot": {
"uri": "tmod:@turbot/aws-comprehend#/definitions/comprehend",
"modUri": "tmod:@turbot/aws-comprehend"
}
}

comprehendAka

{
"type": "string",
"pattern": "^arn:aws(-us-gov|-cn)?:comprehend:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}",
"tests": [
{
"description": "base",
"input": "arn:aws:comprehend:us-east-1:123123123123"
},
{
"description": "invalid service name",
"input": "arn:aws:comprehend12121:us-east-1:123123123123",
"expected": false
},
{
"description": "invalid region name",
"input": "arn:aws:comprehend:us-eastdk-74381:123456786354",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-comprehend#/definitions/comprehendAka",
"modUri": "tmod:@turbot/aws-comprehend"
}
}

comprehendSupportedRegions

{
"type": "array",
"items": {
"type": "string",
"enum": [
"ap-northeast-1",
"ap-northeast-2",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ca-central-1",
"eu-central-1",
"eu-west-1",
"eu-west-2",
"us-east-1",
"us-east-2",
"us-gov-west-1",
"us-west-2"
],
"tests": [
{
"input": "us-east-1"
},
{
"description": "invalid - usea1",
"input": "usea1",
"expected": false
},
{
"description": "invalid - au-north-1",
"input": "au-north-1",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-comprehend#/definitions/regionName",
"modUri": "tmod:@turbot/aws-comprehend"
}
},
"minItems": 1,
"example": [
[
"eu-west-1",
"us-west-2"
]
],
"default": [
"ap-northeast-1",
"ap-northeast-2",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ca-central-1",
"eu-central-1",
"eu-west-1",
"eu-west-2",
"us-east-1",
"us-east-2",
"us-gov-west-1",
"us-west-2"
],
"tests": [
{
"description": "one region",
"input": [
"us-east-1"
]
},
{
"description": "all supported regions",
"input": [
"ap-northeast-1",
"ap-northeast-2",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ca-central-1",
"eu-central-1",
"eu-west-1",
"eu-west-2",
"us-east-1",
"us-east-2",
"us-gov-west-1",
"us-west-2"
]
},
{
"description": "invalid - no regions",
"input": [],
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-comprehend#/definitions/comprehendSupportedRegions",
"modUri": "tmod:@turbot/aws-comprehend"
}
}

regionName

{
"type": "string",
"enum": [
"ap-northeast-1",
"ap-northeast-2",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ca-central-1",
"eu-central-1",
"eu-west-1",
"eu-west-2",
"us-east-1",
"us-east-2",
"us-gov-west-1",
"us-west-2"
],
"tests": [
{
"input": "us-east-1"
},
{
"description": "invalid - usea1",
"input": "usea1",
"expected": false
},
{
"description": "invalid - au-north-1",
"input": "au-north-1",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-comprehend#/definitions/regionName",
"modUri": "tmod:@turbot/aws-comprehend"
}
}