iam-floyd
Version:
AWS IAM policy statement generator with fluent interface
1,195 lines • 50.5 kB
TypeScript
import { AccessLevelList } from '../../shared/access-level';
import { PolicyStatement, Operator } from '../../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
*/
export declare class Comprehend extends PolicyStatement {
servicePrefix: string;
/**
* 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?: string);
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* Grants permission to delete a previously created document classifier
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DeleteDocumentClassifier.html
*/
toDeleteDocumentClassifier(): this;
/**
* 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(): this;
/**
* Grants permission to delete a submitted entity recognizer
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DeleteEntityRecognizer.html
*/
toDeleteEntityRecognizer(): this;
/**
* Grants permission to Delete a flywheel
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DeleteFlywheel.html
*/
toDeleteFlywheel(): this;
/**
* Grants permission to remove policy on resource
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DeleteResourcePolicy.html
*/
toDeleteResourcePolicy(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* Grants permission to read attached policy on resource
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeResourcePolicy.html
*/
toDescribeResourcePolicy(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* Grants permission to list tags for a resource
*
* Access Level: Read
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListTagsForResource.html
*/
toListTagsForResource(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* Grants permission to attach policy to resource
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_PutResourcePolicy.html
*/
toPutResourcePolicy(): this;
/**
* Grants permission to start an asynchronous document classification job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartDocumentClassificationJob.html
*/
toStartDocumentClassificationJob(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* Grants permission to stop a dominant language detection job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopDominantLanguageDetectionJob.html
*/
toStopDominantLanguageDetectionJob(): this;
/**
* Grants permission to stop an entity detection job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopEntitiesDetectionJob.html
*/
toStopEntitiesDetectionJob(): this;
/**
* Grants permission to stop an Events detection job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopEventsDetectionJob.html
*/
toStopEventsDetectionJob(): this;
/**
* Grants permission to stop a key phrase detection job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopKeyPhrasesDetectionJob.html
*/
toStopKeyPhrasesDetectionJob(): this;
/**
* Grants permission to stop a PII entities detection job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopPiiEntitiesDetectionJob.html
*/
toStopPiiEntitiesDetectionJob(): this;
/**
* Grants permission to stop a sentiment detection job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopSentimentDetectionJob.html
*/
toStopSentimentDetectionJob(): this;
/**
* Grants permission to stop a targeted sentiment detection job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopTargetedSentimentDetectionJob.html
*/
toStopTargetedSentimentDetectionJob(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* 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(): this;
/**
* Grants permission to update information about the specified endpoint
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_UpdateEndpoint.html
*/
toUpdateEndpoint(): this;
/**
* Grants permission to Update a flywheel's configuration
*
* Access Level: Write
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_UpdateFlywheel.html
*/
toUpdateFlywheel(): this;
protected accessLevelList: AccessLevelList;
/**
* 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: string, account?: string, region?: string, partition?: string): this;
/**
* 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: string, account?: string, region?: string, partition?: string): this;
/**
* 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: string, account?: string, region?: string, partition?: string): this;
/**
* 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: string, account?: string, region?: string, partition?: string): this;
/**
* 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: string, account?: string, region?: string, partition?: string): this;
/**
* 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: string, account?: string, region?: string, partition?: string): this;
/**
* 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: string, account?: string, region?: string, partition?: string): this;
/**
* 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: string, account?: string, region?: string, partition?: string): this;
/**
* 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: string, account?: string, region?: string, partition?: string): this;
/**
* 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: string, account?: string, region?: string, partition?: string): this;
/**
* 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: string, account?: string, region?: string, partition?: string): this;
/**
* 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: string, account?: string, region?: string, partition?: string): this;
/**
* 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: string, account?: string, region?: string, partition?: string): this;
/**
* 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: string, account?: string, region?: string, partition?: string): this;
/**
* Adds a resource of type flywheel-dataset to the statement
*
* https://docs.aws.amazon.com/comprehend/latest/APIReference/API_CreateDataset.html
*
* @param flywheelName - Identifier for the flywheelName.
* @param datasetName - Identifier for the datasetName.
* @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()
*/
onFlywheelDataset(flywheelName: string, datasetName: string, account?: string, region?: string, partition?: string): this;
/**
* Filters access by requiring tag values present in a resource creation request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-globally-available
*
* Applies to actions:
* - .toCreateDataset()
* - .toCreateDocumentClassifier()
* - .toCreateEndpoint()
* - .toCreateEntityRecognizer()
* - .toCreateFlywheel()
* - .toImportModel()
* - .toStartDocumentClassificationJob()
* - .toStartDominantLanguageDetectionJob()
* - .toStartEntitiesDetectionJob()
* - .toStartEventsDetectionJob()
* - .toStartKeyPhrasesDetectionJob()
* - .toStartPiiEntitiesDetectionJob()
* - .toStartSentimentDetectionJob()
* - .toStartTargetedSentimentDetectionJob()
* - .toStartTopicsDetectionJob()
* - .toTagResource()
*
* @param tagKey The tag key to check
* @param value The value(s) to check
* @param operator Works with [string operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_String). **Default:** `StringLike`
*/
ifAwsRequestTag(tagKey: string, value: string | string[], operator?: Operator | string): this;
/**
* Filters access by requiring tag value associated with the resource
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-globally-available
*
* Applies to resource types:
* - targeted-sentiment-detection-job
* - document-classifier
* - document-classifier-endpoint
* - entity-recognizer
* - entity-recognizer-endpoint
* - dominant-language-detection-job
* - entities-detection-job
* - pii-entities-detection-job
* - events-detection-job
* - key-phrases-detection-job
* - sentiment-detection-job
* - topics-detection-job
* - document-classification-job
* - flywheel
* - flywheel-dataset
*
* @param tagKey The tag key to check
* @param value The value(s) to check
* @param operator Works with [string operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_String). **Default:** `StringLike`
*/
ifAwsResourceTag(tagKey: string, value: string | string[], operator?: Operator | string): this;
/**
* Filters access by requiring the presence of mandatory tags in the request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-globally-available
*
* Applies to actions:
* - .toCreateDataset()
* - .toCreateDocumentClassifier()
* - .toCreateEndpoint()
* - .toCreateEntityRecognizer()
* - .toCreateFlywheel()
* - .toImportModel()
* - .toStartDocumentClassificationJob()
* - .toStartDominantLanguageDetectionJob()
* - .toStartEntitiesDetectionJob()
* - .toStartEventsDetectionJob()
* - .toStartKeyPhrasesDetectionJob()
* - .toStartPiiEntitiesDetectionJob()
* - .toStartSentimentDetectionJob()
* - .toStartTargetedSentimentDetectionJob()
* - .toStartTopicsDetectionJob()
* - .toTagResource()
* - .toUntagResource()
*
* @param value The value(s) to check
* @param operator Works with [string operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_String). **Default:** `StringLike`
*/
ifAwsTagKeys(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the DataLake Kms Key associated with the flywheel resource in the request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncomprehend.html#amazoncomprehend-policy-keys
*
* Applies to actions:
* - .toCreateFlywheel()
*
* @param value The value(s) to check
* @param operator Works with [arn operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_ARN). **Default:** `ArnLike`
*/
ifDataLakeKmsKey(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by particular Iteration Id for a flywheel
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncomprehend.html#amazoncomprehend-policy-keys
*
* Applies to actions:
* - .toDescribeFlywheelIteration()
*
* @param value The value(s) to check
* @param operator Works with [string operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_String). **Default:** `StringLike`
*/
ifFlywheelIterationId(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the model KMS key associated with the resource in the request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncomprehend.html#amazoncomprehend-policy-keys
*
* Applies to actions:
* - .toCreateDocumentClassifier()
* - .toCreateEntityRecognizer()
* - .toCreateFlywheel()
* - .toImportModel()
* - .toUpdateFlywheel()
*
* @param value The value(s) to check
* @param operator Works with [arn operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_ARN). **Default:** `ArnLike`
*/
ifModelKmsKey(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the output KMS key associated with the resource in the request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncomprehend.html#amazoncomprehend-policy-keys
*
* Applies to actions:
* - .toCreateDocumentClassifier()
* - .toStartDocumentClassificationJob()
* - .toStartDominantLanguageDetectionJob()
* - .toStartEntitiesDetectionJob()
* - .toStartEventsDetectionJob()
* - .toStartKeyPhrasesDetectionJob()
* - .toStartPiiEntitiesDetectionJob()
* - .toStartSentimentDetectionJob()
* - .toStartTargetedSentimentDetectionJob()
* - .toStartTopicsDetectionJob()
*
* @param value The value(s) to check
* @param operator Works with [arn operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_ARN). **Default:** `ArnLike`
*/
ifOutputKmsKey(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the volume KMS key associated with the resource in the request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncomprehend.html#amazoncomprehend-policy-keys
*
* Applies to actions:
* - .toCreateDocumentClassifier()
* - .toCreateEntityRecognizer()
* - .toCreateFlywheel()
* - .toStartDocumentClassificationJob()
* - .toStartDominantLanguageDetectionJob()
* - .toStartEntitiesDetectionJob()
* - .toStartKeyPhrasesDetectionJob()
* - .toStartSentimentDetectionJob()
* - .toStartTargetedSentimentDetectionJob()
* - .toStartTopicsDetectionJob()
* - .toUpdateFlywheel()
*
* @param value The value(s) to check
* @param operator Works with [arn operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_ARN). **Default:** `ArnLike`
*/
ifVolumeKmsKey(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the list of all VPC security group ids associated with the resource in the request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncomprehend.html#amazoncomprehend-policy-keys
*
* Applies to actions:
* - .toCreateDocumentClassifier()
* - .toCreateEntityRecognizer()
* - .toCreateFlywheel()
* - .toStartDocumentClassificationJob()
* - .toStartDominantLanguageDetectionJob()
* - .toStartEntitiesDetectionJob()
* - .toStartKeyPhrasesDetectionJob()
* - .toStartSentimentDetectionJob()
* - .toStartTargetedSentimentDetectionJob()
* - .toStartTopicsDetectionJob()
* - .toUpdateFlywheel()
*
* @param value The value(s) to check
* @param operator Works with [string operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_String). **Default:** `StringLike`
*/
ifVpcSecurityGroupIds(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the list of all VPC subnets associated with the resource in the request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncomprehend.html#amazoncomprehend-policy-keys
*
* Applies to actions:
* - .toCreateDocumentClassifier()
* - .toCreateEntityRecognizer()
* - .toCreateFlywheel()
* - .toStartDocumentClassificationJob()
* - .toStartDominantLanguageDetectionJob()
* - .toStartEntitiesDetectionJob()
* - .toStartKeyPhrasesDetectionJob()
* - .toStartSentimentDete