Machine-LearningNatural Language ProcessingNLPText Analysis
StartTargetedSentimentDetectionJobRequest is a JSON Structure definition published by Amazon Comprehend, describing 9 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-structure/openapi.yml-start-targeted-sentiment-detection-job-request-structure.json",
"name": "StartTargetedSentimentDetectionJobRequest",
"description": "StartTargetedSentimentDetectionJobRequest schema",
"type": "object",
"properties": {
"InputDataConfig": {
"$ref": "#/components/schemas/InputDataConfig"
},
"OutputDataConfig": {
"allOf": [
{
"$ref": "#/components/schemas/OutputDataConfig"
},
{
"description": "Specifies where to send the output files. "
}
]
},
"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. For more information, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions\">Role-based permissions</a>."
}
]
},
"JobName": {
"allOf": [
{
"$ref": "#/components/schemas/JobName"
},
{
"description": "The identifier of the job."
}
]
},
"LanguageCode": {
"allOf": [
{
"$ref": "#/components/schemas/LanguageCode"
},
{
"description": "The language of the input documents. Currently, English is the only supported language."
}
]
},
"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."
}
]
},
"VolumeKmsKeyId": {
"allOf": [
{
"$ref": "#/components/schemas/KmsKeyId"
},
{
"description": "<p>ID for the 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": {
"$ref": "#/components/schemas/VpcConfig"
},
"Tags": {
"allOf": [
{
"$ref": "#/components/schemas/TagList"
},
{
"description": "Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that adds 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."
}
]
}
},
"required": [
"InputDataConfig",
"OutputDataConfig",
"DataAccessRoleArn",
"LanguageCode"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.