Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
", "DescribeResourcePolicy": "Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
", "DescribeSentimentDetectionJob": "Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
", + "DescribeTargetedSentimentDetectionJob": "Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
", "DescribeTopicsDetectionJob": "Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
", "DetectDominantLanguage": "Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
", "DetectEntities": "Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.
", @@ -48,6 +49,7 @@ "ListPiiEntitiesDetectionJobs": "Gets a list of the PII entity detection jobs that you have submitted.
", "ListSentimentDetectionJobs": "Gets a list of sentiment detection jobs that you have submitted.
", "ListTagsForResource": "Lists all tags associated with a given Amazon Comprehend resource.
", + "ListTargetedSentimentDetectionJobs": "Gets a list of targeted sentiment detection jobs that you have submitted.
", "ListTopicsDetectionJobs": "Gets a list of the topic detection jobs that you have submitted.
", "PutResourcePolicy": "Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another AWS account to import the custom model, which replicates it in Amazon Comprehend in their account.
", "StartDocumentClassificationJob": "Starts an asynchronous document classification job. Use the operation to track the progress of the job.
", @@ -56,7 +58,8 @@ "StartEventsDetectionJob": "Starts an asynchronous event detection job for a collection of documents.
", "StartKeyPhrasesDetectionJob": "Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
", "StartPiiEntitiesDetectionJob": "Starts an asynchronous PII entity detection job for a collection of documents.
", - "StartSentimentDetectionJob": "Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.
", + "StartSentimentDetectionJob": "Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.
", + "StartTargetedSentimentDetectionJob": "Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the operation to track the status of a job.
", "StartTopicsDetectionJob": "Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.
Stops a dominant language detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
", "StopEntitiesDetectionJob": "Stops an entities detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
", @@ -64,6 +67,7 @@ "StopKeyPhrasesDetectionJob": "Stops a key phrases detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
", "StopPiiEntitiesDetectionJob": "Stops a PII entities detection job in progress.
", "StopSentimentDetectionJob": "Stops a sentiment detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
", + "StopTargetedSentimentDetectionJob": "Stops a targeted sentiment detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
", "StopTrainingDocumentClassifier": "Stops a document classifier training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.
Stops an entity recognizer training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.
Associates a specific tag with an Amazon Comprehend resource. 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.
", @@ -85,6 +89,7 @@ "KeyPhrasesDetectionJobProperties$Message": "A description of the status of a job.
", "PiiEntitiesDetectionJobProperties$Message": "A description of the status of a job.
", "SentimentDetectionJobProperties$Message": "A description of the status of a job.
", + "TargetedSentimentDetectionJobProperties$Message": "A description of the status of a job.
", "TopicsDetectionJobProperties$Message": "A description for the status of a job.
" } }, @@ -249,6 +254,7 @@ "StartKeyPhrasesDetectionJobRequest$ClientRequestToken": "A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
", "StartPiiEntitiesDetectionJobRequest$ClientRequestToken": "A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
", "StartSentimentDetectionJobRequest$ClientRequestToken": "A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
", + "StartTargetedSentimentDetectionJobRequest$ClientRequestToken": "A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
", "StartTopicsDetectionJobRequest$ClientRequestToken": "A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
" } }, @@ -271,8 +277,10 @@ "StartKeyPhrasesDetectionJobResponse$JobArn": "The Amazon Resource Name (ARN) of the key phrase detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags.
", + "TargetedSentimentDetectionJobProperties$JobArn": "The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags.
" } @@ -537,6 +545,16 @@ "refs": { } }, + "DescribeTargetedSentimentDetectionJobRequest": { + "base": null, + "refs": { + } + }, + "DescribeTargetedSentimentDetectionJobResponse": { + "base": null, + "refs": { + } + }, "DescribeTopicsDetectionJobRequest": { "base": null, "refs": { @@ -783,7 +801,7 @@ "ClassifierEvaluationMetrics$HammingLoss": "Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.
", "EntityRecognizerEvaluationMetrics$Precision": "A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
", "EntityRecognizerEvaluationMetrics$Recall": "A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.
", - "EntityRecognizerEvaluationMetrics$F1Score": "A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.
A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100, where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1, where 1 is the best score.
A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
", "EntityTypesEvaluationMetrics$Recall": "A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.
", "EntityTypesEvaluationMetrics$F1Score": "A measure of how accurate the recognizer results are for a specific entity type in the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
", "StartPiiEntitiesDetectionJobRequest$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
", "StartSentimentDetectionJobRequest$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
", + "StartTargetedSentimentDetectionJobRequest$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
", "StartTopicsDetectionJobRequest$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
", + "TargetedSentimentDetectionJobProperties$DataAccessRoleArn": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
", "TopicsDetectionJobProperties$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
", "UpdateEndpointRequest$DesiredDataAccessRoleArn": "Data access role ARN to use in case the new model is encrypted with a customer CMK.
" } @@ -1095,7 +1115,9 @@ "StartKeyPhrasesDetectionJobRequest$InputDataConfig": "Specifies the format and location of the input data for the job.
", "StartPiiEntitiesDetectionJobRequest$InputDataConfig": "The input properties for a PII entities detection job.
", "StartSentimentDetectionJobRequest$InputDataConfig": "Specifies the format and location of the input data for the job.
", + "StartTargetedSentimentDetectionJobRequest$InputDataConfig": null, "StartTopicsDetectionJobRequest$InputDataConfig": "Specifies the format and location of the input data for the job.
", + "TargetedSentimentDetectionJobProperties$InputDataConfig": null, "TopicsDetectionJobProperties$InputDataConfig": "The input data configuration supplied when you created the topic detection job.
" } }, @@ -1160,6 +1182,7 @@ "DescribeKeyPhrasesDetectionJobRequest$JobId": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
", "DescribePiiEntitiesDetectionJobRequest$JobId": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
", "DescribeSentimentDetectionJobRequest$JobId": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
", + "DescribeTargetedSentimentDetectionJobRequest$JobId": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
", "DescribeTopicsDetectionJobRequest$JobId": "The identifier assigned by the user to the detection job.
", "DocumentClassificationJobProperties$JobId": "The identifier assigned to the document classification job.
", "DominantLanguageDetectionJobProperties$JobId": "The identifier assigned to the dominant language detection job.
", @@ -1175,6 +1198,7 @@ "StartKeyPhrasesDetectionJobResponse$JobId": "The identifier generated for the job. To get the status of a job, use this identifier with the operation.
", "StartPiiEntitiesDetectionJobResponse$JobId": "The identifier generated for the job.
", "StartSentimentDetectionJobResponse$JobId": "The identifier generated for the job. To get the status of a job, use this identifier with the operation.
", + "StartTargetedSentimentDetectionJobResponse$JobId": "The identifier generated for the job. To get the status of a job, use this identifier with the operation.
", "StartTopicsDetectionJobResponse$JobId": "The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.
The identifier of the dominant language detection job to stop.
", "StopDominantLanguageDetectionJobResponse$JobId": "The identifier of the dominant language detection job to stop.
", @@ -1188,6 +1212,9 @@ "StopPiiEntitiesDetectionJobResponse$JobId": "The identifier of the PII entities detection job to stop.
", "StopSentimentDetectionJobRequest$JobId": "The identifier of the sentiment detection job to stop.
", "StopSentimentDetectionJobResponse$JobId": "The identifier of the sentiment detection job to stop.
", + "StopTargetedSentimentDetectionJobRequest$JobId": "The identifier of the targeted sentiment detection job to stop.
", + "StopTargetedSentimentDetectionJobResponse$JobId": "The identifier of the targeted sentiment detection job to stop.
", + "TargetedSentimentDetectionJobProperties$JobId": "The identifier assigned to the targeted sentiment detection job.
", "TopicsDetectionJobProperties$JobId": "The identifier assigned to the topic detection job.
" } }, @@ -1215,7 +1242,10 @@ "StartKeyPhrasesDetectionJobRequest$JobName": "The identifier of the job.
", "StartPiiEntitiesDetectionJobRequest$JobName": "The identifier of the job.
", "StartSentimentDetectionJobRequest$JobName": "The identifier of the job.
", + "StartTargetedSentimentDetectionJobRequest$JobName": "The identifier of the job.
", "StartTopicsDetectionJobRequest$JobName": "The identifier of the job.
", + "TargetedSentimentDetectionJobFilter$JobName": "Filters on the name of the job.
", + "TargetedSentimentDetectionJobProperties$JobName": "The name that you assigned to the targeted sentiment detection job.
", "TopicsDetectionJobFilter$JobName": "", "TopicsDetectionJobProperties$JobName": "The name of the topic detection job.
" } @@ -1249,6 +1279,7 @@ "StartKeyPhrasesDetectionJobResponse$JobStatus": "The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the operation.
The status of the job.
", "StartSentimentDetectionJobResponse$JobStatus": "The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the operation.
The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the operation.
The status of the job:
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation.
Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopDominantLanguageDetectionJob operation.
Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopEntitiesDetectionJob operation.
Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopKeyPhrasesDetectionJob operation.
The status of the PII entities detection job.
", "StopSentimentDetectionJobResponse$JobStatus": "Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.
Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
", + "TargetedSentimentDetectionJobProperties$JobStatus": "The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.
Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.
", "TopicsDetectionJobProperties$JobStatus": "The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
ID for the AWS 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:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
ID for the AWS 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:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
ID for the AWS 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:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
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:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
ID for the AWS 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:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
ID for the AWS 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 targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
ID for the AWS 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:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
The language code of the input documents.
", "StartKeyPhrasesDetectionJobRequest$LanguageCode": "The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
", "StartPiiEntitiesDetectionJobRequest$LanguageCode": "The language of the input documents.
", - "StartSentimentDetectionJobRequest$LanguageCode": "The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
" + "StartSentimentDetectionJobRequest$LanguageCode": "The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
", + "StartTargetedSentimentDetectionJobRequest$LanguageCode": "The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
", + "TargetedSentimentDetectionJobProperties$LanguageCode": "The language code of the input documents.
" } }, "ListDocumentClassificationJobsRequest": { @@ -1576,6 +1614,16 @@ "refs": { } }, + "ListTargetedSentimentDetectionJobsRequest": { + "base": null, + "refs": { + } + }, + "ListTargetedSentimentDetectionJobsResponse": { + "base": null, + "refs": { + } + }, "ListTopicsDetectionJobsRequest": { "base": null, "refs": { @@ -1607,6 +1655,7 @@ "ListKeyPhrasesDetectionJobsRequest$MaxResults": "The maximum number of results to return in each page. The default is 100.
", "ListPiiEntitiesDetectionJobsRequest$MaxResults": "The maximum number of results to return in each page.
", "ListSentimentDetectionJobsRequest$MaxResults": "The maximum number of results to return in each page. The default is 100.
", + "ListTargetedSentimentDetectionJobsRequest$MaxResults": "The maximum number of results to return in each page. The default is 100.
", "ListTopicsDetectionJobsRequest$MaxResults": "The maximum number of results to return in each page. The default is 100.
" } }, @@ -1628,7 +1677,7 @@ } }, "OutputDataConfig": { - "base": "Provides configuration parameters for the output of topic detection jobs.
", + "base": "Provides configuration parameters for the output of inference jobs.
", "refs": { "DocumentClassificationJobProperties$OutputDataConfig": "The output data configuration that you supplied when you created the document classification job.
", "DominantLanguageDetectionJobProperties$OutputDataConfig": "The output data configuration that you supplied when you created the dominant language detection job.
", @@ -1643,7 +1692,9 @@ "StartKeyPhrasesDetectionJobRequest$OutputDataConfig": "Specifies where to send the output files.
", "StartPiiEntitiesDetectionJobRequest$OutputDataConfig": "Provides configuration parameters for the output of PII entity detection jobs.
", "StartSentimentDetectionJobRequest$OutputDataConfig": "Specifies where to send the output files.
", + "StartTargetedSentimentDetectionJobRequest$OutputDataConfig": "Specifies where to send the output files.
", "StartTopicsDetectionJobRequest$OutputDataConfig": "Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic
The output data configuration supplied when you created the topic detection job.
" } }, @@ -1781,8 +1832,8 @@ "EntityRecognizerDocuments$TestS3Uri": "Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
", "EntityRecognizerEntityList$S3Uri": "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.
", "InputDataConfig$S3Uri": "The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.
For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.
When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.
When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.
When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
Identifies the next page of results to return.
", "ListSentimentDetectionJobsRequest$NextToken": "Identifies the next page of results to return.
", "ListSentimentDetectionJobsResponse$NextToken": "Identifies the next page of results to return.
", + "ListTargetedSentimentDetectionJobsRequest$NextToken": "Identifies the next page of results to return.
", + "ListTargetedSentimentDetectionJobsResponse$NextToken": "Identifies the next page of results to return.
", "ListTopicsDetectionJobsRequest$NextToken": "Identifies the next page of results to return.
", "ListTopicsDetectionJobsResponse$NextToken": "Identifies the next page of results to return.
", "ResourceInUseException$Message": null, @@ -2112,6 +2185,7 @@ "StartKeyPhrasesDetectionJobRequest$Tags": "Tags to be associated with the key phrases 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.
", "StartPiiEntitiesDetectionJobRequest$Tags": "Tags to be associated with the PII entities 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.
", "StartSentimentDetectionJobRequest$Tags": "Tags to be associated with the 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.
", + "StartTargetedSentimentDetectionJobRequest$Tags": "Tags to be associated 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.
", "StartTopicsDetectionJobRequest$Tags": "Tags to be associated with the topics 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.
", "TagResourceRequest$Tags": "Tags being associated with a specific Amazon Comprehend resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.
" } @@ -2139,6 +2213,25 @@ "StartEventsDetectionJobRequest$TargetEventTypes": "The types of events to detect in the input documents.
" } }, + "TargetedSentimentDetectionJobFilter": { + "base": "Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
", + "refs": { + "ListTargetedSentimentDetectionJobsRequest$Filter": "Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
" + } + }, + "TargetedSentimentDetectionJobProperties": { + "base": "Provides information about a targeted sentiment detection job.
", + "refs": { + "DescribeTargetedSentimentDetectionJobResponse$TargetedSentimentDetectionJobProperties": "An object that contains the properties associated with a targeted sentiment detection job.
", + "TargetedSentimentDetectionJobPropertiesList$member": null + } + }, + "TargetedSentimentDetectionJobPropertiesList": { + "base": null, + "refs": { + "ListTargetedSentimentDetectionJobsResponse$TargetedSentimentDetectionJobPropertiesList": "A list containing the properties of each job that is returned.
" + } + }, "TextSizeLimitExceededException": { "base": "The size of the input text exceeds the limit. Use a smaller document.
", "refs": { @@ -2195,6 +2288,10 @@ "SentimentDetectionJobFilter$SubmitTimeAfter": "Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
", "SentimentDetectionJobProperties$SubmitTime": "The time that the sentiment detection job was submitted for processing.
", "SentimentDetectionJobProperties$EndTime": "The time that the sentiment detection job ended.
", + "TargetedSentimentDetectionJobFilter$SubmitTimeBefore": "Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
", + "TargetedSentimentDetectionJobFilter$SubmitTimeAfter": "Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
", + "TargetedSentimentDetectionJobProperties$SubmitTime": "The time that the targeted sentiment detection job was submitted for processing.
", + "TargetedSentimentDetectionJobProperties$EndTime": "The time that the targeted sentiment detection job ended.
", "TopicsDetectionJobFilter$SubmitTimeBefore": "Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.
", "TopicsDetectionJobFilter$SubmitTimeAfter": "Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.
", "TopicsDetectionJobProperties$SubmitTime": "The time that the topic detection job was submitted for processing.
", @@ -2289,7 +2386,9 @@ "StartEntitiesDetectionJobRequest$VpcConfig": "Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
", "StartKeyPhrasesDetectionJobRequest$VpcConfig": "Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.
", "StartSentimentDetectionJobRequest$VpcConfig": "Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.
", + "StartTargetedSentimentDetectionJobRequest$VpcConfig": null, "StartTopicsDetectionJobRequest$VpcConfig": "Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
", + "TargetedSentimentDetectionJobProperties$VpcConfig": null, "TopicsDetectionJobProperties$VpcConfig": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
" } } diff --git a/models/apis/comprehend/2017-11-27/paginators-1.json b/models/apis/comprehend/2017-11-27/paginators-1.json index b22def315c..a1567d485d 100644 --- a/models/apis/comprehend/2017-11-27/paginators-1.json +++ b/models/apis/comprehend/2017-11-27/paginators-1.json @@ -50,6 +50,11 @@ "output_token": "NextToken", "limit_key": "MaxResults" }, + "ListTargetedSentimentDetectionJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, "ListTopicsDetectionJobs": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 02f5de6f14..db69de0b1c 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -6485,6 +6485,10 @@ }, "ivs" : { "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "eu-central-1" : { }, "eu-west-1" : { }, "us-east-1" : { }, "us-west-2" : { } diff --git a/service/comprehend/api.go b/service/comprehend/api.go index 860a18fc0a..fc694c993f 100644 --- a/service/comprehend/api.go +++ b/service/comprehend/api.go @@ -2365,6 +2365,95 @@ func (c *Comprehend) DescribeSentimentDetectionJobWithContext(ctx aws.Context, i return out, req.Send() } +const opDescribeTargetedSentimentDetectionJob = "DescribeTargetedSentimentDetectionJob" + +// DescribeTargetedSentimentDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribeTargetedSentimentDetectionJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeTargetedSentimentDetectionJob for more information on using the DescribeTargetedSentimentDetectionJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeTargetedSentimentDetectionJobRequest method. +// req, resp := client.DescribeTargetedSentimentDetectionJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJob +func (c *Comprehend) DescribeTargetedSentimentDetectionJobRequest(input *DescribeTargetedSentimentDetectionJobInput) (req *request.Request, output *DescribeTargetedSentimentDetectionJobOutput) { + op := &request.Operation{ + Name: opDescribeTargetedSentimentDetectionJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeTargetedSentimentDetectionJobInput{} + } + + output = &DescribeTargetedSentimentDetectionJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeTargetedSentimentDetectionJob API operation for Amazon Comprehend. +// +// Gets the properties associated with a targeted sentiment detection job. Use +// this operation to get the status of the job. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Comprehend's +// API operation DescribeTargetedSentimentDetectionJob for usage and error information. +// +// Returned Error Types: +// * InvalidRequestException +// The request is invalid. +// +// * JobNotFoundException +// The specified job was not found. Check the job ID and try again. +// +// * TooManyRequestsException +// The number of requests exceeds the limit. Resubmit your request later. +// +// * InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJob +func (c *Comprehend) DescribeTargetedSentimentDetectionJob(input *DescribeTargetedSentimentDetectionJobInput) (*DescribeTargetedSentimentDetectionJobOutput, error) { + req, out := c.DescribeTargetedSentimentDetectionJobRequest(input) + return out, req.Send() +} + +// DescribeTargetedSentimentDetectionJobWithContext is the same as DescribeTargetedSentimentDetectionJob with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeTargetedSentimentDetectionJob for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Comprehend) DescribeTargetedSentimentDetectionJobWithContext(ctx aws.Context, input *DescribeTargetedSentimentDetectionJobInput, opts ...request.Option) (*DescribeTargetedSentimentDetectionJobOutput, error) { + req, out := c.DescribeTargetedSentimentDetectionJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeTopicsDetectionJob = "DescribeTopicsDetectionJob" // DescribeTopicsDetectionJobRequest generates a "aws/request.Request" representing the @@ -4836,6 +4925,152 @@ func (c *Comprehend) ListTagsForResourceWithContext(ctx aws.Context, input *List return out, req.Send() } +const opListTargetedSentimentDetectionJobs = "ListTargetedSentimentDetectionJobs" + +// ListTargetedSentimentDetectionJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListTargetedSentimentDetectionJobs operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListTargetedSentimentDetectionJobs for more information on using the ListTargetedSentimentDetectionJobs +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListTargetedSentimentDetectionJobsRequest method. +// req, resp := client.ListTargetedSentimentDetectionJobsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs +func (c *Comprehend) ListTargetedSentimentDetectionJobsRequest(input *ListTargetedSentimentDetectionJobsInput) (req *request.Request, output *ListTargetedSentimentDetectionJobsOutput) { + op := &request.Operation{ + Name: opListTargetedSentimentDetectionJobs, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListTargetedSentimentDetectionJobsInput{} + } + + output = &ListTargetedSentimentDetectionJobsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListTargetedSentimentDetectionJobs API operation for Amazon Comprehend. +// +// Gets a list of targeted sentiment detection jobs that you have submitted. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Comprehend's +// API operation ListTargetedSentimentDetectionJobs for usage and error information. +// +// Returned Error Types: +// * InvalidRequestException +// The request is invalid. +// +// * TooManyRequestsException +// The number of requests exceeds the limit. Resubmit your request later. +// +// * InvalidFilterException +// The filter specified for the operation is invalid. Specify a different filter. +// +// * InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs +func (c *Comprehend) ListTargetedSentimentDetectionJobs(input *ListTargetedSentimentDetectionJobsInput) (*ListTargetedSentimentDetectionJobsOutput, error) { + req, out := c.ListTargetedSentimentDetectionJobsRequest(input) + return out, req.Send() +} + +// ListTargetedSentimentDetectionJobsWithContext is the same as ListTargetedSentimentDetectionJobs with the addition of +// the ability to pass a context and additional request options. +// +// See ListTargetedSentimentDetectionJobs for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Comprehend) ListTargetedSentimentDetectionJobsWithContext(ctx aws.Context, input *ListTargetedSentimentDetectionJobsInput, opts ...request.Option) (*ListTargetedSentimentDetectionJobsOutput, error) { + req, out := c.ListTargetedSentimentDetectionJobsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListTargetedSentimentDetectionJobsPages iterates over the pages of a ListTargetedSentimentDetectionJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListTargetedSentimentDetectionJobs method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListTargetedSentimentDetectionJobs operation. +// pageNum := 0 +// err := client.ListTargetedSentimentDetectionJobsPages(params, +// func(page *comprehend.ListTargetedSentimentDetectionJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Comprehend) ListTargetedSentimentDetectionJobsPages(input *ListTargetedSentimentDetectionJobsInput, fn func(*ListTargetedSentimentDetectionJobsOutput, bool) bool) error { + return c.ListTargetedSentimentDetectionJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListTargetedSentimentDetectionJobsPagesWithContext same as ListTargetedSentimentDetectionJobsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Comprehend) ListTargetedSentimentDetectionJobsPagesWithContext(ctx aws.Context, input *ListTargetedSentimentDetectionJobsInput, fn func(*ListTargetedSentimentDetectionJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListTargetedSentimentDetectionJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListTargetedSentimentDetectionJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListTargetedSentimentDetectionJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListTopicsDetectionJobs = "ListTopicsDetectionJobs" // ListTopicsDetectionJobsRequest generates a "aws/request.Request" representing the @@ -5704,7 +5939,7 @@ func (c *Comprehend) StartSentimentDetectionJobRequest(input *StartSentimentDete // StartSentimentDetectionJob API operation for Amazon Comprehend. // // Starts an asynchronous sentiment detection job for a collection of documents. -// use the operation to track the status of a job. +// Use the operation to track the status of a job. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5754,6 +5989,101 @@ func (c *Comprehend) StartSentimentDetectionJobWithContext(ctx aws.Context, inpu return out, req.Send() } +const opStartTargetedSentimentDetectionJob = "StartTargetedSentimentDetectionJob" + +// StartTargetedSentimentDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StartTargetedSentimentDetectionJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See StartTargetedSentimentDetectionJob for more information on using the StartTargetedSentimentDetectionJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the StartTargetedSentimentDetectionJobRequest method. +// req, resp := client.StartTargetedSentimentDetectionJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJob +func (c *Comprehend) StartTargetedSentimentDetectionJobRequest(input *StartTargetedSentimentDetectionJobInput) (req *request.Request, output *StartTargetedSentimentDetectionJobOutput) { + op := &request.Operation{ + Name: opStartTargetedSentimentDetectionJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &StartTargetedSentimentDetectionJobInput{} + } + + output = &StartTargetedSentimentDetectionJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartTargetedSentimentDetectionJob API operation for Amazon Comprehend. +// +// Starts an asynchronous targeted sentiment detection job for a collection +// of documents. Use the operation to track the status of a job. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Comprehend's +// API operation StartTargetedSentimentDetectionJob for usage and error information. +// +// Returned Error Types: +// * InvalidRequestException +// The request is invalid. +// +// * TooManyRequestsException +// The number of requests exceeds the limit. Resubmit your request later. +// +// * KmsKeyValidationException +// The KMS customer managed key (CMK) entered cannot be validated. Verify the +// key and re-enter it. +// +// * TooManyTagsException +// The request contains more tags than can be associated with a resource (50 +// tags per resource). The maximum number of tags includes both existing tags +// and those included in your current request. +// +// * InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJob +func (c *Comprehend) StartTargetedSentimentDetectionJob(input *StartTargetedSentimentDetectionJobInput) (*StartTargetedSentimentDetectionJobOutput, error) { + req, out := c.StartTargetedSentimentDetectionJobRequest(input) + return out, req.Send() +} + +// StartTargetedSentimentDetectionJobWithContext is the same as StartTargetedSentimentDetectionJob with the addition of +// the ability to pass a context and additional request options. +// +// See StartTargetedSentimentDetectionJob for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Comprehend) StartTargetedSentimentDetectionJobWithContext(ctx aws.Context, input *StartTargetedSentimentDetectionJobInput, opts ...request.Option) (*StartTargetedSentimentDetectionJobOutput, error) { + req, out := c.StartTargetedSentimentDetectionJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opStartTopicsDetectionJob = "StartTopicsDetectionJob" // StartTopicsDetectionJobRequest generates a "aws/request.Request" representing the @@ -6403,9 +6733,105 @@ func (c *Comprehend) StopSentimentDetectionJobWithContext(ctx aws.Context, input return out, req.Send() } -const opStopTrainingDocumentClassifier = "StopTrainingDocumentClassifier" +const opStopTargetedSentimentDetectionJob = "StopTargetedSentimentDetectionJob" -// StopTrainingDocumentClassifierRequest generates a "aws/request.Request" representing the +// StopTargetedSentimentDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StopTargetedSentimentDetectionJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See StopTargetedSentimentDetectionJob for more information on using the StopTargetedSentimentDetectionJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the StopTargetedSentimentDetectionJobRequest method. +// req, resp := client.StopTargetedSentimentDetectionJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTargetedSentimentDetectionJob +func (c *Comprehend) StopTargetedSentimentDetectionJobRequest(input *StopTargetedSentimentDetectionJobInput) (req *request.Request, output *StopTargetedSentimentDetectionJobOutput) { + op := &request.Operation{ + Name: opStopTargetedSentimentDetectionJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &StopTargetedSentimentDetectionJobInput{} + } + + output = &StopTargetedSentimentDetectionJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// StopTargetedSentimentDetectionJob API operation for Amazon Comprehend. +// +// Stops a targeted sentiment detection job in progress. +// +// If the job state is IN_PROGRESS the job is marked for termination and put +// into the STOP_REQUESTED state. If the job completes before it can be stopped, +// it is put into the COMPLETED state; otherwise the job is be stopped and put +// into the STOPPED state. +// +// If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob +// operation, the operation returns a 400 Internal Request Exception. +// +// When a job is stopped, any documents already processed are written to the +// output location. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Comprehend's +// API operation StopTargetedSentimentDetectionJob for usage and error information. +// +// Returned Error Types: +// * InvalidRequestException +// The request is invalid. +// +// * JobNotFoundException +// The specified job was not found. Check the job ID and try again. +// +// * InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTargetedSentimentDetectionJob +func (c *Comprehend) StopTargetedSentimentDetectionJob(input *StopTargetedSentimentDetectionJobInput) (*StopTargetedSentimentDetectionJobOutput, error) { + req, out := c.StopTargetedSentimentDetectionJobRequest(input) + return out, req.Send() +} + +// StopTargetedSentimentDetectionJobWithContext is the same as StopTargetedSentimentDetectionJob with the addition of +// the ability to pass a context and additional request options. +// +// See StopTargetedSentimentDetectionJob for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Comprehend) StopTargetedSentimentDetectionJobWithContext(ctx aws.Context, input *StopTargetedSentimentDetectionJobInput, opts ...request.Option) (*StopTargetedSentimentDetectionJobOutput, error) { + req, out := c.StopTargetedSentimentDetectionJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opStopTrainingDocumentClassifier = "StopTrainingDocumentClassifier" + +// StopTrainingDocumentClassifierRequest generates a "aws/request.Request" representing the // client's request for the StopTrainingDocumentClassifier operation. The "output" return // value will be populated with the request's response once the request completes // successfully. @@ -10263,6 +10689,88 @@ func (s *DescribeSentimentDetectionJobOutput) SetSentimentDetectionJobProperties return s } +type DescribeTargetedSentimentDetectionJobInput struct { + _ struct{} `type:"structure"` + + // The identifier that Amazon Comprehend generated for the job. The operation + // returns this identifier in its response. + // + // JobId is a required field + JobId *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeTargetedSentimentDetectionJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeTargetedSentimentDetectionJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeTargetedSentimentDetectionJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeTargetedSentimentDetectionJobInput"} + if s.JobId == nil { + invalidParams.Add(request.NewErrParamRequired("JobId")) + } + if s.JobId != nil && len(*s.JobId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJobId sets the JobId field's value. +func (s *DescribeTargetedSentimentDetectionJobInput) SetJobId(v string) *DescribeTargetedSentimentDetectionJobInput { + s.JobId = &v + return s +} + +type DescribeTargetedSentimentDetectionJobOutput struct { + _ struct{} `type:"structure"` + + // An object that contains the properties associated with a targeted sentiment + // detection job. + TargetedSentimentDetectionJobProperties *TargetedSentimentDetectionJobProperties `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeTargetedSentimentDetectionJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeTargetedSentimentDetectionJobOutput) GoString() string { + return s.String() +} + +// SetTargetedSentimentDetectionJobProperties sets the TargetedSentimentDetectionJobProperties field's value. +func (s *DescribeTargetedSentimentDetectionJobOutput) SetTargetedSentimentDetectionJobProperties(v *TargetedSentimentDetectionJobProperties) *DescribeTargetedSentimentDetectionJobOutput { + s.TargetedSentimentDetectionJobProperties = v + return s +} + type DescribeTopicsDetectionJobInput struct { _ struct{} `type:"structure"` @@ -12929,8 +13437,9 @@ type EntityRecognizerEvaluationMetrics struct { // A measure of how accurate the recognizer results are for the test data. It // is derived from the Precision and Recall values. The F1Score is the harmonic - // average of the two scores. The highest score is 1, and the worst score is - // 0. + // average of the two scores. For plain text entity recognizer models, the range + // is 0 to 100, where 100 is the best score. For PDF/Word entity recognizer + // models, the range is 0 to 1, where 1 is the best score. F1Score *float64 `type:"double"` // A measure of the usefulness of the recognizer results in the test data. High @@ -16159,6 +16668,118 @@ func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput return s } +type ListTargetedSentimentDetectionJobsInput struct { + _ struct{} `type:"structure"` + + // Filters the jobs that are returned. You can filter jobs on their name, status, + // or the date and time that they were submitted. You can only set one filter + // at a time. + Filter *TargetedSentimentDetectionJobFilter `type:"structure"` + + // The maximum number of results to return in each page. The default is 100. + MaxResults *int64 `min:"1" type:"integer"` + + // Identifies the next page of results to return. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTargetedSentimentDetectionJobsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTargetedSentimentDetectionJobsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTargetedSentimentDetectionJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTargetedSentimentDetectionJobsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.Filter != nil { + if err := s.Filter.Validate(); err != nil { + invalidParams.AddNested("Filter", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFilter sets the Filter field's value. +func (s *ListTargetedSentimentDetectionJobsInput) SetFilter(v *TargetedSentimentDetectionJobFilter) *ListTargetedSentimentDetectionJobsInput { + s.Filter = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListTargetedSentimentDetectionJobsInput) SetMaxResults(v int64) *ListTargetedSentimentDetectionJobsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListTargetedSentimentDetectionJobsInput) SetNextToken(v string) *ListTargetedSentimentDetectionJobsInput { + s.NextToken = &v + return s +} + +type ListTargetedSentimentDetectionJobsOutput struct { + _ struct{} `type:"structure"` + + // Identifies the next page of results to return. + NextToken *string `min:"1" type:"string"` + + // A list containing the properties of each job that is returned. + TargetedSentimentDetectionJobPropertiesList []*TargetedSentimentDetectionJobProperties `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTargetedSentimentDetectionJobsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTargetedSentimentDetectionJobsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListTargetedSentimentDetectionJobsOutput) SetNextToken(v string) *ListTargetedSentimentDetectionJobsOutput { + s.NextToken = &v + return s +} + +// SetTargetedSentimentDetectionJobPropertiesList sets the TargetedSentimentDetectionJobPropertiesList field's value. +func (s *ListTargetedSentimentDetectionJobsOutput) SetTargetedSentimentDetectionJobPropertiesList(v []*TargetedSentimentDetectionJobProperties) *ListTargetedSentimentDetectionJobsOutput { + s.TargetedSentimentDetectionJobPropertiesList = v + return s +} + type ListTopicsDetectionJobsInput struct { _ struct{} `type:"structure"` @@ -16271,7 +16892,7 @@ func (s *ListTopicsDetectionJobsOutput) SetTopicsDetectionJobPropertiesList(v [] return s } -// Provides configuration parameters for the output of topic detection jobs. +// Provides configuration parameters for the output of inference jobs. type OutputDataConfig struct { _ struct{} `type:"structure"` @@ -16299,6 +16920,10 @@ type OutputDataConfig struct { // of the output file, called output.tar.gz. It is a compressed archive that // contains the ouput of the operation. // + // For a PII entity detection job, the output file is plain text, not a compressed + // archive. The output file name is the same as the input file, with .out appended + // at the end. + // // S3Uri is a required field S3Uri *string `type:"string" required:"true"` } @@ -16703,6 +17328,10 @@ type PiiOutputDataConfig struct { // When you use the PiiOutputDataConfig object with asynchronous operations, // you specify the Amazon S3 location where you want to write the output data. // + // For a PII entity detection job, the output file is plain text, not a compressed + // archive. The output file name is the same as the input file, with .out appended + // at the end. + // // S3Uri is a required field S3Uri *string `type:"string" required:"true"` } @@ -19202,22 +19831,21 @@ func (s *StartSentimentDetectionJobOutput) SetJobStatus(v string) *StartSentimen return s } -type StartTopicsDetectionJobInput struct { +type StartTargetedSentimentDetectionJobInput struct { _ struct{} `type:"structure"` - // A unique identifier for the request. If you do not set the client request + // A unique identifier for the request. If you don't set the client request // token, Amazon Comprehend generates one. ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` // The Amazon Resource Name (ARN) of the AWS Identity and Access Management // (IAM) role that grants Amazon Comprehend read access to your input data. - // For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions - // (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions). + // For more information, see Role-based permissions (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions). // // DataAccessRoleArn is a required field DataAccessRoleArn *string `min:"20" type:"string" required:"true"` - // Specifies the format and location of the input data for the job. + // The input properties for an inference job. // // InputDataConfig is a required field InputDataConfig *InputDataConfig `type:"structure" required:"true"` @@ -19225,12 +19853,261 @@ type StartTopicsDetectionJobInput struct { // The identifier of the job. JobName *string `min:"1" type:"string"` - // The number of topics to detect. - NumberOfTopics *int64 `min:"1" type:"integer"` - - // Specifies where to send the output files. The output is a compressed archive - // with two files, topic-terms.csv that lists the terms associated with each - // topic, and doc-topics.csv that lists the documents associated with each topic + // The language of the input documents. You can specify any of the primary languages + // supported by Amazon Comprehend. All documents must be in the same language. + // + // LanguageCode is a required field + LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` + + // Specifies where to send the output files. + // + // OutputDataConfig is a required field + OutputDataConfig *OutputDataConfig `type:"structure" required:"true"` + + // Tags to be associated 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. + Tags []*Tag `type:"list"` + + // 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: + // + // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // + // * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + VolumeKmsKeyId *string `type:"string"` + + // Configuration parameters for an optional private Virtual Private Cloud (VPC) + // containing the resources you are using for the job. For more information, + // see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + VpcConfig *VpcConfig `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartTargetedSentimentDetectionJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartTargetedSentimentDetectionJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartTargetedSentimentDetectionJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartTargetedSentimentDetectionJobInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) + } + if s.DataAccessRoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("DataAccessRoleArn")) + } + if s.DataAccessRoleArn != nil && len(*s.DataAccessRoleArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("DataAccessRoleArn", 20)) + } + if s.InputDataConfig == nil { + invalidParams.Add(request.NewErrParamRequired("InputDataConfig")) + } + if s.JobName != nil && len(*s.JobName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobName", 1)) + } + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) + } + if s.OutputDataConfig == nil { + invalidParams.Add(request.NewErrParamRequired("OutputDataConfig")) + } + if s.InputDataConfig != nil { + if err := s.InputDataConfig.Validate(); err != nil { + invalidParams.AddNested("InputDataConfig", err.(request.ErrInvalidParams)) + } + } + if s.OutputDataConfig != nil { + if err := s.OutputDataConfig.Validate(); err != nil { + invalidParams.AddNested("OutputDataConfig", err.(request.ErrInvalidParams)) + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + if s.VpcConfig != nil { + if err := s.VpcConfig.Validate(); err != nil { + invalidParams.AddNested("VpcConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *StartTargetedSentimentDetectionJobInput) SetClientRequestToken(v string) *StartTargetedSentimentDetectionJobInput { + s.ClientRequestToken = &v + return s +} + +// SetDataAccessRoleArn sets the DataAccessRoleArn field's value. +func (s *StartTargetedSentimentDetectionJobInput) SetDataAccessRoleArn(v string) *StartTargetedSentimentDetectionJobInput { + s.DataAccessRoleArn = &v + return s +} + +// SetInputDataConfig sets the InputDataConfig field's value. +func (s *StartTargetedSentimentDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartTargetedSentimentDetectionJobInput { + s.InputDataConfig = v + return s +} + +// SetJobName sets the JobName field's value. +func (s *StartTargetedSentimentDetectionJobInput) SetJobName(v string) *StartTargetedSentimentDetectionJobInput { + s.JobName = &v + return s +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *StartTargetedSentimentDetectionJobInput) SetLanguageCode(v string) *StartTargetedSentimentDetectionJobInput { + s.LanguageCode = &v + return s +} + +// SetOutputDataConfig sets the OutputDataConfig field's value. +func (s *StartTargetedSentimentDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartTargetedSentimentDetectionJobInput { + s.OutputDataConfig = v + return s +} + +// SetTags sets the Tags field's value. +func (s *StartTargetedSentimentDetectionJobInput) SetTags(v []*Tag) *StartTargetedSentimentDetectionJobInput { + s.Tags = v + return s +} + +// SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value. +func (s *StartTargetedSentimentDetectionJobInput) SetVolumeKmsKeyId(v string) *StartTargetedSentimentDetectionJobInput { + s.VolumeKmsKeyId = &v + return s +} + +// SetVpcConfig sets the VpcConfig field's value. +func (s *StartTargetedSentimentDetectionJobInput) SetVpcConfig(v *VpcConfig) *StartTargetedSentimentDetectionJobInput { + s.VpcConfig = v + return s +} + +type StartTargetedSentimentDetectionJobOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the targeted sentiment detection job. It + // is a unique, fully qualified identifier for the job. It includes the AWS + // account, Region, and the job ID. The format of the ARN is as follows: + // + // arn: