openapi: 3.0.0
info:
version: '2017-11-27'
x-release: v4
title: 'Amazon Comprehend #X Amz Target=Comprehend 20171127.BatchDetectDominantLanguage #X Amz Target=Comprehend 20171127.BatchDetectDominantLanguage #X Amz Target=Comprehend 20171127.CreateEntityRecognizer API'
description: Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: comprehend
x-aws-signingName: comprehend
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/comprehend-2017-11-27.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://comprehend.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Comprehend multi-region endpoint
- url: https://comprehend.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Comprehend multi-region endpoint
- url: http://comprehend.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Comprehend endpoint for China (Beijing) and China (Ningxia)
- url: https://comprehend.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Comprehend endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=Comprehend 20171127.CreateEntityRecognizer'
paths:
/#X-Amz-Target=Comprehend_20171127.CreateEntityRecognizer:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateEntityRecognizer
description: 'Creates an entity recognizer using submitted files. After your <code>CreateEntityRecognizer</code> request is submitted, you can check job status using the <code>DescribeEntityRecognizer</code> API. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEntityRecognizerResponse'
examples:
CreateEntityRecognizer200Example:
summary: Default CreateEntityRecognizer 200
x-microcks-default: true
value:
EntityRecognizerArn: example
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
examples:
CreateEntityRecognizer480Example:
summary: Default CreateEntityRecognizer 480
x-microcks-default: true
value: example
'481':
description: ResourceInUseException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceInUseException'
examples:
CreateEntityRecognizer481Example:
summary: Default CreateEntityRecognizer 481
x-microcks-default: true
value: example
'482':
description: TooManyTagsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyTagsException'
examples:
CreateEntityRecognizer482Example:
summary: Default CreateEntityRecognizer 482
x-microcks-default: true
value: example
'483':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
CreateEntityRecognizer483Example:
summary: Default CreateEntityRecognizer 483
x-microcks-default: true
value: example
'484':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
examples:
CreateEntityRecognizer484Example:
summary: Default CreateEntityRecognizer 484
x-microcks-default: true
value: example
'485':
description: UnsupportedLanguageException
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedLanguageException'
examples:
CreateEntityRecognizer485Example:
summary: Default CreateEntityRecognizer 485
x-microcks-default: true
value: example
'486':
description: KmsKeyValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/KmsKeyValidationException'
examples:
CreateEntityRecognizer486Example:
summary: Default CreateEntityRecognizer 486
x-microcks-default: true
value: example
'487':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
CreateEntityRecognizer487Example:
summary: Default CreateEntityRecognizer 487
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEntityRecognizerRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Comprehend_20171127.CreateEntityRecognizer
summary: Amazon Comprehend Create Entity Recognizer
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=Comprehend 20171127.CreateEntityRecognizer'
components:
schemas:
IamRoleArn:
type: string
pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
minLength: 20
maxLength: 2048
LanguageCode:
type: string
enum:
- en
- es
- fr
- de
- it
- pt
- ar
- hi
- ja
- ko
- zh
- zh-TW
SecurityGroupId:
type: string
pattern: '[-0-9a-zA-Z]+'
minLength: 1
maxLength: 32
EntityTypesListItem:
type: object
required:
- Type
properties:
Type:
allOf:
- $ref: '#/components/schemas/EntityTypeName'
- description: '<p>An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.</p> <p>Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break, \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).</p>'
description: An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
KmsKeyValidationException: {}
EntityTypeName:
type: string
pattern: ^(?![^\n\r\t,]*\\n|\\r|\\t)[^\n\r\t,]+$
maxLength: 64
SubnetId:
type: string
pattern: '[-0-9a-zA-Z]+'
minLength: 1
maxLength: 32
AugmentedManifestsListItem:
type: object
required:
- S3Uri
- AttributeNames
properties:
S3Uri:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: The Amazon S3 location of the augmented manifest file.
Split:
allOf:
- $ref: '#/components/schemas/Split'
- description: <p>The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.</p> <p>TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.</p> <p> TEST - all of the documents in the manifest will be used for testing.</p>
AttributeNames:
allOf:
- $ref: '#/components/schemas/AttributeNamesList'
- description: <p>The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.</p> <p>If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.</p> <p>If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.</p>
AnnotationDataS3Uri:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: The S3 prefix to the annotation files that are referred in the augmented manifest file.
SourceDocumentsS3Uri:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
DocumentType:
allOf:
- $ref: '#/components/schemas/AugmentedManifestsDocumentTypeFormat'
- description: <p>The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument. </p> <ul> <li> <p> <code>PLAIN_TEXT_DOCUMENT</code> A document type that represents any unicode text that is encoded in UTF-8.</p> </li> <li> <p> <code>SEMI_STRUCTURED_DOCUMENT</code> A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.</p> </li> </ul>
description: An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
EntityRecognizerEntityList:
type: object
required:
- S3Uri
properties:
S3Uri:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: Specifies the Amazon S3 location where the entity list is located. The URI must be in the same Region as the API endpoint that you are calling.
description: Describes the entity list submitted with an entity recognizer.
ClientRequestTokenString:
type: string
pattern: ^[a-zA-Z0-9-]+$
minLength: 1
maxLength: 64
TooManyTagsException: {}
ResourceLimitExceededException: {}
UnsupportedLanguageException: {}
VersionName:
type: string
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
maxLength: 63
EntityTypesList:
type: array
items:
$ref: '#/components/schemas/EntityTypesListItem'
KmsKeyId:
type: string
pattern: ^\p{ASCII}+$
maxLength: 2048
EntityRecognizerAugmentedManifestsList:
type: array
items:
$ref: '#/components/schemas/AugmentedManifestsListItem'
EntityRecognizerAnnotations:
type: object
required:
- S3Uri
properties:
S3Uri:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: ' Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.'
TestS3Uri:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: ' Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.'
description: Describes the annotations associated with a entity recognizer.
S3Uri:
type: string
pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
maxLength: 1024
Subnets:
type: array
items:
$ref: '#/components/schemas/SubnetId'
minItems: 1
maxItems: 16
InputFormat:
type: string
enum:
- ONE_DOC_PER_FILE
- ONE_DOC_PER_LINE
Split:
type: string
enum:
- TRAIN
- TEST
AttributeNamesListItem:
type: string
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
minLength: 1
maxLength: 63
AttributeNamesList:
type: array
items:
$ref: '#/components/schemas/AttributeNamesListItem'
CreateEntityRecognizerRequest:
type: object
required:
- RecognizerName
- DataAccessRoleArn
- InputDataConfig
- LanguageCode
title: CreateEntityRecognizerRequest
properties:
RecognizerName:
allOf:
- $ref: '#/components/schemas/ComprehendArnName'
- description: The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/Region.
VersionName:
allOf:
- $ref: '#/components/schemas/VersionName'
- description: The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/Region.
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: 'Tags to associate with the entity recognizer. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. '
InputDataConfig:
allOf:
- $ref: '#/components/schemas/EntityRecognizerInputDataConfig'
- description: 'Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same Region as the entity recognizer being created. '
ClientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestTokenString'
- description: ' A unique identifier for the request. If you don''t set the client request token, Amazon Comprehend generates one.'
LanguageCode:
allOf:
- $ref: '#/components/schemas/LanguageCode'
- description: ' You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.'
VolumeKmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- description: '<p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:</p> <ul> <li> <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> <li> <p>Amazon Resource Name (ARN) of a KMS Key: <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> </ul>'
VpcConfig:
allOf:
- $ref: '#/components/schemas/VpcConfig'
- description: 'Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html">Amazon VPC</a>. '
ModelKmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- description: '<p>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:</p> <ul> <li> <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> <li> <p>Amazon Resource Name (ARN) of a KMS Key: <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> </ul>'
ModelPolicy:
allOf:
- $ref: '#/components/schemas/Policy'
- description: '<p>The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another Amazon Web Services account to import your custom model.</p> <p>Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:</p> <p> <code>"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"</code> </p> <p>To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:</p> <p> <code>''{"attribute": "value", "attribute": ["value"]}''</code> </p>'
CreateEntityRecognizerResponse:
type: object
properties:
EntityRecognizerArn:
allOf:
- $ref: '#/components/schemas/EntityRecognizerArn'
- description: The Amazon Resource Name (ARN) that identifies the entity recognizer.
InvalidRequestException: {}
EntityRecognizerInputDataConfig:
type: object
required:
- EntityTypes
properties:
DataFormat:
allOf:
- $ref: '#/components/schemas/EntityRecognizerDataFormat'
- description: '<p>The format of your training data:</p> <ul> <li> <p> <code>COMPREHEND_CSV</code>: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.</p> <p>If you use this value, you must provide your CSV file by using either the <code>Annotations</code> or <code>EntityList</code> parameters. You must provide your training documents by using the <code>Documents</code> parameter.</p> </li> <li> <p> <code>AUGMENTED_MANIFEST</code>: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document. </p> <p>If you use this value, you must provide the <code>AugmentedManifests</code> parameter in your request.</p> </li> </ul> <p>If you don''t specify a value, Amazon Comprehend uses <code>COMPREHEND_CSV</code> as the default.</p>'
EntityTypes:
allOf:
- $ref: '#/components/schemas/EntityTypesList'
- description: '<p>The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don''t specify are ignored.</p> <p>A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break), \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma). </p>'
Documents:
allOf:
- $ref: '#/components/schemas/EntityRecognizerDocuments'
- description: <p>The S3 location of the folder that contains the training documents for your custom entity recognizer.</p> <p>This parameter is required if you set <code>DataFormat</code> to <code>COMPREHEND_CSV</code>.</p>
Annotations:
allOf:
- $ref: '#/components/schemas/EntityRecognizerAnnotations'
- description: The S3 location of the CSV file that annotates your training documents.
EntityList:
allOf:
- $ref: '#/components/schemas/EntityRecognizerEntityList'
- description: The S3 location of the CSV file that has the entity list for your custom entity recognizer.
AugmentedManifests:
allOf:
- $ref: '#/components/schemas/EntityRecognizerAugmentedManifestsList'
- description: <p>A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.</p> <p>This parameter is required if you set <code>DataFormat</code> to <code>AUGMENTED_MANIFEST</code>.</p>
description: Specifies the format and location of the input data.
SecurityGroupIds:
type: array
items:
$ref: '#/components/schemas/SecurityGroupId'
minItems: 1
maxItems: 5
ResourceInUseException: {}
TagKey:
type: string
minLength: 1
maxLength: 128
EntityRecognizerDocuments:
type: object
required:
- S3Uri
properties:
S3Uri:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: ' Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.'
TestS3Uri:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: ' Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.'
InputFormat:
allOf:
- $ref: '#/components/schemas/InputFormat'
- description: ' Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.'
description: Describes the training documents submitted with an entity recognizer.
EntityRecognizerArn:
type: string
pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
maxLength: 256
TooManyRequestsException: {}
VpcConfig:
type: object
required:
- SecurityGroupIds
- Subnets
properties:
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/SecurityGroupIds'
- description: 'The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html">Security Groups for your VPC</a>. '
Subnets:
allOf:
- $ref: '#/components/schemas/Subnets'
- description: 'The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">VPCs and Subnets</a>. '
description: ' Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html">Amazon VPC</a>. '
TagValue:
type: string
minLength: 0
maxLength: 256
Policy:
type: string
pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+'
minLength: 1
maxLength: 20000
InternalServerException: {}
EntityRecognizerDataFormat:
type: string
enum:
- COMPREHEND_CSV
- AUGMENTED_MANIFEST
ComprehendArnName:
type: string
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
maxLength: 63
AugmentedManifestsDocumentTypeFormat:
type: string
enum:
- PLAIN_TEXT_DOCUMENT
- SEMI_STRUCTURED_DOCUMENT
Tag:
type: object
required:
- Key
properties:
Key:
allOf:
- $ref: '#/components/schemas/TagKey'
- description: 'The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.” '
Value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: ' The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department. '
description: 'A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department. '
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
parameters:
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/comprehend/
x-hasEquivalentPaths: true