iam-floyd
Version:
AWS IAM policy statement generator with fluent interface
1,271 lines • 161 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Comprehend = void 0;
const shared_1 = require("../../shared");
/**
* Statement provider for service [comprehend](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazoncomprehend.html).
*
* @param sid [SID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) of the statement
*/
class Comprehend extends shared_1.PolicyStatement {
/**
* Statement provider for service [comprehend](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazoncomprehend.html).
*
* @param sid [SID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) of the statement
*/
constructor(sid) {
super(sid);
this.servicePrefix = 'comprehend';
this.accessLevelList = {
Read: [
'BatchDetectDominantLanguage',
'BatchDetectEntities',
'BatchDetectKeyPhrases',
'BatchDetectSentiment',
'BatchDetectSyntax',
'BatchDetectTargetedSentiment',
'ClassifyDocument',
'ContainsPiiEntities',
'DescribeDataset',
'DescribeDocumentClassificationJob',
'DescribeDocumentClassifier',
'DescribeDominantLanguageDetectionJob',
'DescribeEndpoint',
'DescribeEntitiesDetectionJob',
'DescribeEntityRecognizer',
'DescribeEventsDetectionJob',
'DescribeFlywheel',
'DescribeFlywheelIteration',
'DescribeKeyPhrasesDetectionJob',
'DescribePiiEntitiesDetectionJob',
'DescribeResourcePolicy',
'DescribeSentimentDetectionJob',
'DescribeTargetedSentimentDetectionJob',
'DescribeTopicsDetectionJob',
'DetectDominantLanguage',
'DetectEntities',
'DetectKeyPhrases',
'DetectPiiEntities',
'DetectSentiment',
'DetectSyntax',
'DetectTargetedSentiment',
'DetectToxicContent',
'ListDatasets',
'ListDocumentClassificationJobs',
'ListDocumentClassifierSummaries',
'ListDocumentClassifiers',
'ListDominantLanguageDetectionJobs',
'ListEndpoints',
'ListEntitiesDetectionJobs',
'ListEntityRecognizerSummaries',
'ListEntityRecognizers',
'ListEventsDetectionJobs',
'ListFlywheelIterationHistory',
'ListFlywheels',
'ListKeyPhrasesDetectionJobs',
'ListPiiEntitiesDetectionJobs',
'ListSentimentDetectionJobs',
'ListTagsForResource',
'ListTargetedSentimentDetectionJobs',
'ListTopicsDetectionJobs'
],
Write: [
'CreateDataset',
'CreateDocumentClassifier',
'CreateEndpoint',
'CreateEntityRecognizer',
'CreateFlywheel',
'DeleteDocumentClassifier',
'DeleteEndpoint',
'DeleteEntityRecognizer',
'DeleteFlywheel',
'DeleteResourcePolicy',
'ImportModel',
'PutResourcePolicy',
'StartDocumentClassificationJob',
'StartDominantLanguageDetectionJob',
'StartEntitiesDetectionJob',
'StartEventsDetectionJob',
'StartFlywheelIteration',
'StartKeyPhrasesDetectionJob',
'StartPiiEntitiesDetectionJob',
'StartSentimentDetectionJob',
'StartTargetedSentimentDetectionJob',
'StartTopicsDetectionJob',
'StopDominantLanguageDetectionJob',
'StopEntitiesDetectionJob',
'StopEventsDetectionJob',
'StopKeyPhrasesDetectionJob',
'StopPiiEntitiesDetectionJob',
'StopSentimentDetectionJob',
'StopTargetedSentimentDetectionJob',
'StopTrainingDocumentClassifier',
'StopTrainingEntityRecognizer',
'UpdateEndpoint',
'UpdateFlywheel'
],
Tagging: [
'TagResource',
'UntagResource'
]
};
}
/**
* Grants permission to detect the language or languages present in the list of text documents
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectDominantLanguage.html
*/
toBatchDetectDominantLanguage() {
return this.to('BatchDetectDominantLanguage');
}
/**
* Grants permission to detect the named entities ("People", "Places", "Locations", etc) within the given list of text documents
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectEntities.html
*/
toBatchDetectEntities() {
return this.to('BatchDetectEntities');
}
/**
* Grants permission to detect the phrases in the list of text documents that are most indicative of the content
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectKeyPhrases.html
*/
toBatchDetectKeyPhrases() {
return this.to('BatchDetectKeyPhrases');
}
/**
* Grants permission to detect the sentiment of a text in the list of documents (Positive, Negative, Neutral, or Mixed)
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectSentiment.html
*/
toBatchDetectSentiment() {
return this.to('BatchDetectSentiment');
}
/**
* Grants permission to detect syntactic information (like Part of Speech, Tokens) in a list of text documents
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectSyntax.html
*/
toBatchDetectSyntax() {
return this.to('BatchDetectSyntax');
}
/**
* Grants permission to detect the sentiments associated with specific entities (such as brands or products) within the given list of text documents
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectTargetedSentiment.html
*/
toBatchDetectTargetedSentiment() {
return this.to('BatchDetectTargetedSentiment');
}
/**
* Grants permission to create a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ClassifyDocument.html
*/
toClassifyDocument() {
return this.to('ClassifyDocument');
}
/**
* Grants permission to classify the personally identifiable information within given documents in real-time
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ContainsPiiEntities.html
*/
toContainsPiiEntities() {
return this.to('ContainsPiiEntities');
}
/**
* Grants permission to create a new dataset within a flywheel
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_CreateDataset.html
*/
toCreateDataset() {
return this.to('CreateDataset');
}
/**
* Grants permission to create a new document classifier that you can use to categorize documents
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
* - .ifVolumeKmsKey()
* - .ifModelKmsKey()
* - .ifOutputKmsKey()
* - .ifVpcSecurityGroupIds()
* - .ifVpcSubnets()
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_CreateDocumentClassifier.html
*/
toCreateDocumentClassifier() {
return this.to('CreateDocumentClassifier');
}
/**
* Grants permission to create a model-specific endpoint for synchronous inference for a previously trained custom model
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_CreateEndpoint.html
*/
toCreateEndpoint() {
return this.to('CreateEndpoint');
}
/**
* Grants permission to create an entity recognizer using submitted files
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
* - .ifVolumeKmsKey()
* - .ifModelKmsKey()
* - .ifVpcSecurityGroupIds()
* - .ifVpcSubnets()
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_CreateEntityRecognizer.html
*/
toCreateEntityRecognizer() {
return this.to('CreateEntityRecognizer');
}
/**
* Grants permission to create a new flywheel that you can use to train model versions
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_CreateFlywheel.html
*/
toCreateFlywheel() {
return this.to('CreateFlywheel');
}
/**
* Grants permission to delete a previously created document classifier
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DeleteDocumentClassifier.html
*/
toDeleteDocumentClassifier() {
return this.to('DeleteDocumentClassifier');
}
/**
* Grants permission to delete a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DeleteEndpoint.html
*/
toDeleteEndpoint() {
return this.to('DeleteEndpoint');
}
/**
* Grants permission to delete a submitted entity recognizer
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DeleteEntityRecognizer.html
*/
toDeleteEntityRecognizer() {
return this.to('DeleteEntityRecognizer');
}
/**
* Grants permission to Delete a flywheel
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DeleteFlywheel.html
*/
toDeleteFlywheel() {
return this.to('DeleteFlywheel');
}
/**
* Grants permission to remove policy on resource
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DeleteResourcePolicy.html
*/
toDeleteResourcePolicy() {
return this.to('DeleteResourcePolicy');
}
/**
* Grants permission to get the properties associated with a dataset
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeDataset.html
*/
toDescribeDataset() {
return this.to('DescribeDataset');
}
/**
* Grants permission to get the properties associated with a document classification job
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeDocumentClassificationJob.html
*/
toDescribeDocumentClassificationJob() {
return this.to('DescribeDocumentClassificationJob');
}
/**
* Grants permission to get the properties associated with a document classifier
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeDocumentClassifier.html
*/
toDescribeDocumentClassifier() {
return this.to('DescribeDocumentClassifier');
}
/**
* Grants permission to get the properties associated with a dominant language detection job
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeDominantLanguageDetectionJob.html
*/
toDescribeDominantLanguageDetectionJob() {
return this.to('DescribeDominantLanguageDetectionJob');
}
/**
* Grants permission to get the properties associated with a specific endpoint. Use this operation to get the status of an endpoint
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeEndpoint.html
*/
toDescribeEndpoint() {
return this.to('DescribeEndpoint');
}
/**
* Grants permission to get the properties associated with an entities detection job
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeEntitiesDetectionJob.html
*/
toDescribeEntitiesDetectionJob() {
return this.to('DescribeEntitiesDetectionJob');
}
/**
* Grants permission to provide details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeEntityRecognizer.html
*/
toDescribeEntityRecognizer() {
return this.to('DescribeEntityRecognizer');
}
/**
* Grants permission to get the properties associated with an Events detection job
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeEventsDetectionJob.html
*/
toDescribeEventsDetectionJob() {
return this.to('DescribeEventsDetectionJob');
}
/**
* Grants permission to get the properties associated with a flywheel
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeFlywheel.html
*/
toDescribeFlywheel() {
return this.to('DescribeFlywheel');
}
/**
* Grants permission to get the properties associated with a flywheel iteration for a flywheel
*
* Access Level: Read
*
* Possible conditions:
* - .ifFlywheelIterationId()
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeFlywheelIteration.html
*/
toDescribeFlywheelIteration() {
return this.to('DescribeFlywheelIteration');
}
/**
* Grants permission to get the properties associated with a key phrases detection job
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeKeyPhrasesDetectionJob.html
*/
toDescribeKeyPhrasesDetectionJob() {
return this.to('DescribeKeyPhrasesDetectionJob');
}
/**
* Grants permission to get the properties associated with a PII entities detection job
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribePiiEntitiesDetectionJob.html
*/
toDescribePiiEntitiesDetectionJob() {
return this.to('DescribePiiEntitiesDetectionJob');
}
/**
* Grants permission to read attached policy on resource
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeResourcePolicy.html
*/
toDescribeResourcePolicy() {
return this.to('DescribeResourcePolicy');
}
/**
* Grants permission to get the properties associated with a sentiment detection job
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeSentimentDetectionJob.html
*/
toDescribeSentimentDetectionJob() {
return this.to('DescribeSentimentDetectionJob');
}
/**
* Grants permission to get the properties associated with a targeted sentiment detection job
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeTargetedSentimentDetectionJob.html
*/
toDescribeTargetedSentimentDetectionJob() {
return this.to('DescribeTargetedSentimentDetectionJob');
}
/**
* Grants permission to get the properties associated with a topic detection job
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeTopicsDetectionJob.html
*/
toDescribeTopicsDetectionJob() {
return this.to('DescribeTopicsDetectionJob');
}
/**
* Grants permission to detect the language or languages present in the text
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectDominantLanguage.html
*/
toDetectDominantLanguage() {
return this.to('DetectDominantLanguage');
}
/**
* Grants permission to detect the named entities ("People", "Places", "Locations", etc) within the given text document
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectEntities.html
*/
toDetectEntities() {
return this.to('DetectEntities');
}
/**
* Grants permission to detect the phrases in the text that are most indicative of the content
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectKeyPhrases.html
*/
toDetectKeyPhrases() {
return this.to('DetectKeyPhrases');
}
/**
* Grants permission to detect the personally identifiable information entities ("Name", "SSN", "PIN", etc) within the given text document
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectPiiEntities.html
*/
toDetectPiiEntities() {
return this.to('DetectPiiEntities');
}
/**
* Grants permission to detect the sentiment of a text in a document (Positive, Negative, Neutral, or Mixed)
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectSentiment.html
*/
toDetectSentiment() {
return this.to('DetectSentiment');
}
/**
* Grants permission to detect syntactic information (like Part of Speech, Tokens) in a text document
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectSyntax.html
*/
toDetectSyntax() {
return this.to('DetectSyntax');
}
/**
* Grants permission to detect the sentiments associated with specific entities (such as brands or products) in a document
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectTargetedSentiment.html
*/
toDetectTargetedSentiment() {
return this.to('DetectTargetedSentiment');
}
/**
* Grants permission to detect toxic content within the given list of text segments
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectToxicContent.html
*/
toDetectToxicContent() {
return this.to('DetectToxicContent');
}
/**
* Grants permission to import a trained Comprehend model
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
* - .ifModelKmsKey()
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ImportModel.html
*/
toImportModel() {
return this.to('ImportModel');
}
/**
* Grants permission to get a list of the Datasets associated with a flywheel
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListDatasets.html
*/
toListDatasets() {
return this.to('ListDatasets');
}
/**
* Grants permission to get a list of the document classification jobs that you have submitted
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListDocumentClassificationJobs.html
*/
toListDocumentClassificationJobs() {
return this.to('ListDocumentClassificationJobs');
}
/**
* Grants permission to get a list of summaries of the document classifiers that you have created
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListDocumentClassifierSummaries.html
*/
toListDocumentClassifierSummaries() {
return this.to('ListDocumentClassifierSummaries');
}
/**
* Grants permission to get a list of the document classifiers that you have created
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListDocumentClassifiers.html
*/
toListDocumentClassifiers() {
return this.to('ListDocumentClassifiers');
}
/**
* Grants permission to get a list of the dominant language detection jobs that you have submitted
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListDominantLanguageDetectionJobs.html
*/
toListDominantLanguageDetectionJobs() {
return this.to('ListDominantLanguageDetectionJobs');
}
/**
* Grants permission to get a list of all existing endpoints that you've created
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListEndpoints.html
*/
toListEndpoints() {
return this.to('ListEndpoints');
}
/**
* Grants permission to get a list of the entity detection jobs that you have submitted
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListEntitiesDetectionJobs.html
*/
toListEntitiesDetectionJobs() {
return this.to('ListEntitiesDetectionJobs');
}
/**
* Grants permission to get a list of summaries for the entity recognizers that you have created
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListEntityRecognizerSummaries.html
*/
toListEntityRecognizerSummaries() {
return this.to('ListEntityRecognizerSummaries');
}
/**
* Grants permission to get a list of the properties of all entity recognizers that you created, including recognizers currently in training
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListEntityRecognizers.html
*/
toListEntityRecognizers() {
return this.to('ListEntityRecognizers');
}
/**
* Grants permission to get a list of Events detection jobs that you have submitted
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListEventsDetectionJobs.html
*/
toListEventsDetectionJobs() {
return this.to('ListEventsDetectionJobs');
}
/**
* Grants permission to get a list of iterations associated for a flywheel
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListFlywheelIterationHistory.html
*/
toListFlywheelIterationHistory() {
return this.to('ListFlywheelIterationHistory');
}
/**
* Grants permission to get a list of the flywheels that you have created
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListFlywheels.html
*/
toListFlywheels() {
return this.to('ListFlywheels');
}
/**
* Grants permission to get a list of key phrase detection jobs that you have submitted
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListKeyPhrasesDetectionJobs.html
*/
toListKeyPhrasesDetectionJobs() {
return this.to('ListKeyPhrasesDetectionJobs');
}
/**
* Grants permission to get a list of PII entities detection jobs that you have submitted
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListPiiEntitiesDetectionJobs.html
*/
toListPiiEntitiesDetectionJobs() {
return this.to('ListPiiEntitiesDetectionJobs');
}
/**
* Grants permission to get a list of sentiment detection jobs that you have submitted
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListSentimentDetectionJobs.html
*/
toListSentimentDetectionJobs() {
return this.to('ListSentimentDetectionJobs');
}
/**
* Grants permission to list tags for a resource
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListTagsForResource.html
*/
toListTagsForResource() {
return this.to('ListTagsForResource');
}
/**
* Grants permission to get a list of targeted sentiment detection jobs that you have submitted
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListTargetedSentimentDetectionJobs.html
*/
toListTargetedSentimentDetectionJobs() {
return this.to('ListTargetedSentimentDetectionJobs');
}
/**
* Grants permission to get a list of the topic detection jobs that you have submitted
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListTopicsDetectionJobs.html
*/
toListTopicsDetectionJobs() {
return this.to('ListTopicsDetectionJobs');
}
/**
* Grants permission to attach policy to resource
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_PutResourcePolicy.html
*/
toPutResourcePolicy() {
return this.to('PutResourcePolicy');
}
/**
* Grants permission to start an asynchronous document classification job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartDocumentClassificationJob.html
*/
toStartDocumentClassificationJob() {
return this.to('StartDocumentClassificationJob');
}
/**
* Grants permission to start an asynchronous dominant language detection job for a collection of documents
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
* - .ifVolumeKmsKey()
* - .ifOutputKmsKey()
* - .ifVpcSecurityGroupIds()
* - .ifVpcSubnets()
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartDominantLanguageDetectionJob.html
*/
toStartDominantLanguageDetectionJob() {
return this.to('StartDominantLanguageDetectionJob');
}
/**
* Grants permission to start an asynchronous entity detection job for a collection of documents
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartEntitiesDetectionJob.html
*/
toStartEntitiesDetectionJob() {
return this.to('StartEntitiesDetectionJob');
}
/**
* Grants permission to start an asynchronous Events detection job for a collection of documents
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
* - .ifOutputKmsKey()
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartEventsDetectionJob.html
*/
toStartEventsDetectionJob() {
return this.to('StartEventsDetectionJob');
}
/**
* Grants permission to start a flywheel iteration for a flywheel
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartFlywheelIteration.html
*/
toStartFlywheelIteration() {
return this.to('StartFlywheelIteration');
}
/**
* Grants permission to start an asynchronous key phrase detection job for a collection of documents
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
* - .ifVolumeKmsKey()
* - .ifOutputKmsKey()
* - .ifVpcSecurityGroupIds()
* - .ifVpcSubnets()
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartKeyPhrasesDetectionJob.html
*/
toStartKeyPhrasesDetectionJob() {
return this.to('StartKeyPhrasesDetectionJob');
}
/**
* Grants permission to start an asynchronous PII entities detection job for a collection of documents
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
* - .ifOutputKmsKey()
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartPiiEntitiesDetectionJob.html
*/
toStartPiiEntitiesDetectionJob() {
return this.to('StartPiiEntitiesDetectionJob');
}
/**
* Grants permission to start an asynchronous sentiment detection job for a collection of documents
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
* - .ifVolumeKmsKey()
* - .ifOutputKmsKey()
* - .ifVpcSecurityGroupIds()
* - .ifVpcSubnets()
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartSentimentDetectionJob.html
*/
toStartSentimentDetectionJob() {
return this.to('StartSentimentDetectionJob');
}
/**
* Grants permission to start an asynchronous targeted sentiment detection job for a collection of documents
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
* - .ifVolumeKmsKey()
* - .ifOutputKmsKey()
* - .ifVpcSecurityGroupIds()
* - .ifVpcSubnets()
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartTargetedSentimentDetectionJob.html
*/
toStartTargetedSentimentDetectionJob() {
return this.to('StartTargetedSentimentDetectionJob');
}
/**
* Grants permission to start an asynchronous job to detect the most common topics in the collection of documents and the phrases associated with each topic
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
* - .ifVolumeKmsKey()
* - .ifOutputKmsKey()
* - .ifVpcSecurityGroupIds()
* - .ifVpcSubnets()
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartTopicsDetectionJob.html
*/
toStartTopicsDetectionJob() {
return this.to('StartTopicsDetectionJob');
}
/**
* Grants permission to stop a dominant language detection job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopDominantLanguageDetectionJob.html
*/
toStopDominantLanguageDetectionJob() {
return this.to('StopDominantLanguageDetectionJob');
}
/**
* Grants permission to stop an entity detection job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopEntitiesDetectionJob.html
*/
toStopEntitiesDetectionJob() {
return this.to('StopEntitiesDetectionJob');
}
/**
* Grants permission to stop an Events detection job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopEventsDetectionJob.html
*/
toStopEventsDetectionJob() {
return this.to('StopEventsDetectionJob');
}
/**
* Grants permission to stop a key phrase detection job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopKeyPhrasesDetectionJob.html
*/
toStopKeyPhrasesDetectionJob() {
return this.to('StopKeyPhrasesDetectionJob');
}
/**
* Grants permission to stop a PII entities detection job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopPiiEntitiesDetectionJob.html
*/
toStopPiiEntitiesDetectionJob() {
return this.to('StopPiiEntitiesDetectionJob');
}
/**
* Grants permission to stop a sentiment detection job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopSentimentDetectionJob.html
*/
toStopSentimentDetectionJob() {
return this.to('StopSentimentDetectionJob');
}
/**
* Grants permission to stop a targeted sentiment detection job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopTargetedSentimentDetectionJob.html
*/
toStopTargetedSentimentDetectionJob() {
return this.to('StopTargetedSentimentDetectionJob');
}
/**
* Grants permission to stop a previously created document classifier training job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopTrainingDocumentClassifier.html
*/
toStopTrainingDocumentClassifier() {
return this.to('StopTrainingDocumentClassifier');
}
/**
* Grants permission to stop a previously created entity recognizer training job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopTrainingEntityRecognizer.html
*/
toStopTrainingEntityRecognizer() {
return this.to('StopTrainingEntityRecognizer');
}
/**
* Grants permission to tag a resource with given key value pairs
*
* Access Level: Tagging
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_TagResource.html
*/
toTagResource() {
return this.to('TagResource');
}
/**
* Grants permission to untag a resource with given key
*
* Access Level: Tagging
*
* Possible conditions:
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_UntagResource.html
*/
toUntagResource() {
return this.to('UntagResource');
}
/**
* Grants permission to update information about the specified endpoint
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_UpdateEndpoint.html
*/
toUpdateEndpoint() {
return this.to('UpdateEndpoint');
}
/**
* Grants permission to Update a flywheel's configuration
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_UpdateFlywheel.html
*/
toUpdateFlywheel() {
return this.to('UpdateFlywheel');
}
/**
* Adds a resource of type targeted-sentiment-detection-job to the statement
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartTargetedSentimentDetectionJob.html
*
* @param jobId - Identifier for the jobId.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*
* Possible conditions:
* - .ifAwsResourceTag()
*/
onTargetedSentimentDetectionJob(jobId, account, region, partition) {
return this.on(`arn:${partition ?? this.defaultPartition}:comprehend:${region ?? this.defaultRegion}:${account ?? this.defaultAccount}:targeted-sentiment-detection-job/${jobId}`);
}
/**
* Adds a resource of type document-classifier to the statement
*
* https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification-training.html
*
* @param documentClassifierName - Identifier for the documentClassifierName.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*
* Possible conditions:
* - .ifAwsResourceTag()
*/
onDocumentClassifier(documentClassifierName, account, region, partition) {
return this.on(`arn:${partition ?? this.defaultPartition}:comprehend:${region ?? this.defaultRegion}:${account ?? this.defaultAccount}:document-classifier/${documentClassifierName}`);
}
/**
* Adds a resource of type document-classifier-endpoint to the statement
*
* https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
*
* @param documentClassifierEndpointName - Identifier for the documentClassifierEndpointName.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*
* Possible conditions:
* - .ifAwsResourceTag()
*/
onDocumentClassifierEndpoint(documentClassifierEndpointName, account, region, partition) {
return this.on(`arn:${partition ?? this.defaultPartition}:comprehend:${region ?? this.defaultRegion}:${account ?? this.defaultAccount}:document-classifier-endpoint/${documentClassifierEndpointName}`);
}
/**
* Adds a resource of type entity-recognizer to the statement
*
* https://docs.aws.amazon.com/comprehend/latest/dg/training-recognizers.html
*
* @param entityRecognizerName - Identifier for the entityRecognizerName.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*
* Possible conditions:
* - .ifAwsResourceTag()
*/
onEntityRecognizer(entityRecognizerName, account, region, partition) {
return this.on(`arn:${partition ?? this.defaultPartition}:comprehend:${region ?? this.defaultRegion}:${account ?? this.defaultAccount}:entity-recognizer/${entityRecognizerName}`);
}
/**
* Adds a resource of type entity-recognizer-endpoint to the statement
*
* https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
*
* @param entityRecognizerEndpointName - Identifier for the entityRecognizerEndpointName.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*
* Possible conditions:
* - .ifAwsResourceTag()
*/
onEntityRecognizerEndpoint(entityRecognizerEndpointName, account, region, partition) {
return this.on(`arn:${partition ?? this.defaultPartition}:comprehend:${region ?? this.defaultRegion}:${account ?? this.defaultAccount}:entity-recognizer-endpoint/${entityRecognizerEndpointName}`);
}
/**
* Adds a resource of type dominant-language-detection-job to the statement
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartDominantLanguageDetectionJob.html
*
* @param jobId - Identifier for the jobId.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*
* Possible conditions:
* - .ifAwsResourceTag()
*/
onDominantLanguageDetectionJob(jobId, account, region, partition) {
return this.on(`arn:${partition ?? this.defaultPartition}:comprehend:${region ?? this.defaultRegion}:${account ?? this.defaultAccount}:dominant-language-detection-job/${jobId}`);
}
/**
* Adds a resource of type entities-detection-job to the statement
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartEntitiesDetectionJob.html
*
* @param jobId - Identifier for the jobId.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*
* Possible conditions:
* - .ifAwsResourceTag()
*/
onEntitiesDetectionJob(jobId, account, region, partition) {
return this.on(`arn:${partition ?? this.defaultPartition}:comprehend:${region ?? this.defaultRegion}:${account ?? this.defaultAccount}:entities-detection-job/${jobId}`);
}
/**
* Adds a resource of type pii-entities-detection-job to the statement
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartPiiEntitiesDetectionJob.html
*
* @param jobId - Identifier for the jobId.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*
* Possible conditions:
* - .ifAwsResourceTag()
*/
onPiiEntitiesDetectionJob(jobId, account, region, partition) {
return this.on(`arn:${partition ?? this.defaultPartition}:comprehend:${region ?? this.defaultRegion}:${account ?? this.defaultAccount}:pii-entities-detection-job/${jobId}`);
}
/**
* Adds a resource of type events-detection-job to the statement
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartEventsDetectionJob.html
*
* @param jobId - Identifier for the jobId.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*
* Possible conditions:
* - .ifAwsResourceTag()
*/
onEventsDetectionJob(jobId, account, region, partition) {
return this.on(`arn:${partition ?? this.defaultPartition}:comprehend:${region ?? this.defaultRegion}:${account ?? this.defaultAccount}:events-detection-job/${jobId}`);
}
/**
* Adds a resource of type key-phrases-detection-job to the statement
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartKeyPhrasesDetectionJob.html
*
* @param jobId - Identifier for the jobId.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*
* Possible conditions:
* - .ifAwsResourceTag()
*/
onKeyPhrasesDetectionJob(jobId, account, region, partition) {
return this.on(`arn:${partition ?? this.defaultPartition}:comprehend:${region ?? this.defaultRegion}:${account ?? this.defaultAccount}:key-phrases-detection-job/${jobId}`);
}
/**
* Adds a resource of type sentiment-detection-job to the statement
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartSentimentDetectionJob.html
*
* @param jobId - Identifier for the jobId.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*
* Possible conditions:
* - .ifAwsResourceTag()
*/
onSentimentDetectionJob(jobId, account, region, partition) {
return this.on(`arn:${partition ?? this.defaultPartition}:comprehend:${region ?? this.defaultRegion}:${account ?? this.defaultAccount}:sentiment-detection-job/${jobId}`);
}
/**
* Adds a resource of type topics-detection-job to the statement
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartTopicsDetectionJob.html
*
* @param jobId - Identifier for the jobId.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*
* Possible conditions:
* - .ifAwsResourceTag()
*/
onTopicsDetectionJob(jobId, account, region, partition) {
return this.on(`arn:${partition ?? this.defaultPartition}:comprehend:${region ?? this.defaultRegion}:${account ?? this.defaultAccount}:topics-detection-job/${jobId}`);
}
/**
* Adds a resource of type document-classification-job to the statement
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartDocumentClassificationJob.html
*
* @param jobId - Identifier for the jobId.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*
* Possible conditions:
* - .ifAwsResourceTag()
*/
onDocumentClassificationJob(jobId, account, region, partition) {
return this.on(`arn:${partition ?? this.defaultPartition}:comprehend:${region ?? this.defaultRegion}:${account ?? this.defaultAccount}:document-classification-job/${jobId}`);
}
/**
* Adds a resource of type flywheel to the statement
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_CreateFlywheel.html
*
* @param flywheelName - Identifier for the flywheelName.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*
* Possible conditions:
* - .ifAwsResourceTag()
*/
onFlywheel(flywheelName, account, region, partition) {
return this.on(`arn:${partition ??