Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.
For more information about targeted sentiment, see Targeted sentiment.
", "ClassifyDocument": "Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
You can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in Errors that describes the errors.
If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.
Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.
", + "CreateDataset": "Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
", "CreateDocumentClassifier": "Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see Document Classification in the Comprehend Developer Guide.
", "CreateEndpoint": "Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.
", - "CreateEntityRecognizer": "Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.
A flywheel is an AWS resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.
When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.
To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake.
To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.
For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
", "DeleteDocumentClassifier": "Deletes a previously created document classifier
Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.
This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.
", "DeleteEndpoint": "Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints.
", "DeleteEntityRecognizer": "Deletes an entity recognizer.
Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.
This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
", + "DeleteFlywheel": "Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel.
For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
", "DeleteResourcePolicy": "Deletes a resource-based policy that is attached to a custom model.
", + "DescribeDataset": "Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
", "DescribeDocumentClassificationJob": "Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
", "DescribeDocumentClassifier": "Gets the properties associated with a document classifier.
", "DescribeDominantLanguageDetectionJob": "Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
", @@ -24,6 +28,8 @@ "DescribeEntitiesDetectionJob": "Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
", "DescribeEntityRecognizer": "Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
", "DescribeEventsDetectionJob": "Gets the status and details of an events detection job.
", + "DescribeFlywheel": "Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
", + "DescribeFlywheelIteration": "Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
", "DescribeKeyPhrasesDetectionJob": "Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
", "DescribePiiEntitiesDetectionJob": "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.
", @@ -38,6 +44,7 @@ "DetectSyntax": "Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.
", "DetectTargetedSentiment": "Inspects the input text and returns a sentiment analysis for each entity identified in the text.
For more information about targeted sentiment, see Targeted sentiment.
", "ImportModel": "Creates a new custom model that replicates a source custom model that you import. The source model can be in your AWS account or another one.
If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to import it.
The source model must be in the same AWS region that you're using when you import. You can't import a model that's in a different region.
", + "ListDatasets": "List the datasets that you have configured in this region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
", "ListDocumentClassificationJobs": "Gets a list of the documentation classification jobs that you have submitted.
", "ListDocumentClassifierSummaries": "Gets a list of summaries of the document classifiers that you have created
", "ListDocumentClassifiers": "Gets a list of the document classifiers that you have created.
", @@ -47,6 +54,8 @@ "ListEntityRecognizerSummaries": "Gets a list of summaries for the entity recognizers that you have created.
", "ListEntityRecognizers": "Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.
The results of this list are not in any particular order. Please get the list and sort locally if needed.
", "ListEventsDetectionJobs": "Gets a list of the events detection jobs that you have submitted.
", + "ListFlywheelIterationHistory": "Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
", + "ListFlywheels": "Gets a list of the flywheels that you have created.
", "ListKeyPhrasesDetectionJobs": "Get a list of key phrase detection jobs that you have submitted.
", "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.
", @@ -54,14 +63,15 @@ "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.
", + "StartDocumentClassificationJob": "Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob operation to track the progress of the job.
Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
", "StartEntitiesDetectionJob": "Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.
Starts an asynchronous event detection job for a collection of documents.
", + "StartFlywheelIteration": "Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
", "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.
", - "StartTargetedSentimentDetectionJob": "Starts an asynchronous targeted 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 DescribeTargetedSentimentDetectionJob operation to track the status of a job.
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.
", @@ -74,12 +84,14 @@ "StopTrainingEntityRecognizer": "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.
", "UntagResource": "Removes a specific tag associated with an Amazon Comprehend resource.
", - "UpdateEndpoint": "Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.
" + "UpdateEndpoint": "Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.
", + "UpdateFlywheel": "Update the configuration information for an existing flywheel.
" }, "shapes": { "AnyLengthString": { "base": null, "refs": { + "DatasetProperties$Message": "A description of the status of the dataset.
", "DocumentClassificationJobProperties$Message": "A description of the status of the job.
", "DocumentClassifierProperties$Message": "Additional information about the status of the classifier.
", "DominantLanguageDetectionJobProperties$Message": "A description for the status of a job.
", @@ -88,6 +100,9 @@ "EntityRecognizerMetadataEntityTypesListItem$Type": "Type of entity from the list of entity types in the metadata of an entity recognizer.
", "EntityRecognizerProperties$Message": "A description of the status of the recognizer.
", "EventsDetectionJobProperties$Message": "A description of the status of the events detection job.
", + "FlywheelIterationProperties$Message": "A description of the status of the flywheel iteration.
", + "FlywheelProperties$Message": "A description of the status of the flywheel.
", + "FlywheelSummary$Message": "A description of the status of the flywheel.
", "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.
", @@ -98,7 +113,8 @@ "AttributeNamesList": { "base": null, "refs": { - "AugmentedManifestsListItem$AttributeNames": "The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
" + "AugmentedManifestsListItem$AttributeNames": "The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
", + "DatasetAugmentedManifestsListItem$AttributeNames": "The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
" } }, "AttributeNamesListItem": { @@ -110,7 +126,8 @@ "AugmentedManifestsDocumentTypeFormat": { "base": null, "refs": { - "AugmentedManifestsListItem$DocumentType": "The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
The type of augmented manifest. If you don't specify, the default is PlainTextDocument.
PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
", "CreateDocumentClassifierRequest$ClientRequestToken": "A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
", "CreateEndpointRequest$ClientRequestToken": "An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
", + "CreateFlywheelRequest$ClientRequestToken": "A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
", "StartDocumentClassificationJobRequest$ClientRequestToken": "A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
", "StartDominantLanguageDetectionJobRequest$ClientRequestToken": "A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
", "StartEntitiesDetectionJobRequest$ClientRequestToken": "A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
", "StartEventsDetectionJobRequest$ClientRequestToken": "An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
", + "StartFlywheelIterationRequest$ClientRequestToken": "A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
", "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.
", @@ -337,8 +357,11 @@ "ComprehendArnName": { "base": null, "refs": { + "CreateDatasetRequest$DatasetName": "Name of the dataset.
", "CreateDocumentClassifierRequest$DocumentClassifierName": "The name of the document classifier.
", "CreateEntityRecognizerRequest$RecognizerName": "The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.
", + "CreateFlywheelRequest$FlywheelName": "Name for the flywheel.
", + "DatasetProperties$DatasetName": "The name of the dataset.
", "DocumentClassifierFilter$DocumentClassifierName": "The name that you assigned to the document classifier
", "DocumentClassifierSummary$DocumentClassifierName": "The name that you assigned the document classifier.
", "EntityRecognizerFilter$RecognizerName": "The name that you assigned the entity recognizer.
", @@ -346,6 +369,14 @@ "ImportModelRequest$ModelName": "The name to assign to the custom model that is created in Amazon Comprehend by this import.
" } }, + "ComprehendDatasetArn": { + "base": null, + "refs": { + "CreateDatasetResponse$DatasetArn": "The ARN of the dataset.
", + "DatasetProperties$DatasetArn": "The ARN of the dataset.
", + "DescribeDatasetRequest$DatasetArn": "The ARN of the dataset.
" + } + }, "ComprehendEndpointArn": { "base": null, "refs": { @@ -362,19 +393,54 @@ "CreateEndpointRequest$EndpointName": "This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.
The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.
", + "CreateEndpointRequest$FlywheelArn": "The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
", + "CreateFlywheelResponse$FlywheelArn": "The Amazon Resource Number (ARN) of the flywheel.
", + "DeleteFlywheelRequest$FlywheelArn": "The Amazon Resource Number (ARN) of the flywheel to delete.
", + "DescribeFlywheelIterationRequest$FlywheelArn": "", + "DescribeFlywheelRequest$FlywheelArn": "The Amazon Resource Number (ARN) of the flywheel.
", + "DocumentClassificationJobProperties$FlywheelArn": "The Amazon Resource Number (ARN) of the flywheel
", + "DocumentClassifierProperties$FlywheelArn": "The Amazon Resource Number (ARN) of the flywheel
", + "EndpointProperties$FlywheelArn": "The Amazon Resource Number (ARN) of the flywheel
", + "EntityRecognizerProperties$FlywheelArn": "The Amazon Resource Number (ARN) of the flywheel
", + "FlywheelIterationProperties$FlywheelArn": "", + "FlywheelProperties$FlywheelArn": "The Amazon Resource Number (ARN) of the flywheel.
", + "FlywheelSummary$FlywheelArn": "The Amazon Resource Number (ARN) of the flywheel
", + "ListDatasetsRequest$FlywheelArn": "The Amazon Resource Number (ARN) of the flywheel.
", + "ListFlywheelIterationHistoryRequest$FlywheelArn": "The ARN of the flywheel.
", + "StartDocumentClassificationJobRequest$FlywheelArn": "The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
", + "StartEntitiesDetectionJobRequest$FlywheelArn": "The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
", + "StartFlywheelIterationRequest$FlywheelArn": "The ARN of the flywheel.
", + "StartFlywheelIterationResponse$FlywheelArn": "", + "UpdateEndpointRequest$FlywheelArn": "The Amazon Resource Number (ARN) of the flywheel
", + "UpdateFlywheelRequest$FlywheelArn": "The Amazon Resource Number (ARN) of the flywheel to update.
" + } + }, "ComprehendModelArn": { "base": null, "refs": { "CreateEndpointRequest$ModelArn": "The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
", + "CreateEndpointResponse$ModelArn": "The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
", + "CreateFlywheelRequest$ActiveModelArn": "To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version.
", + "CreateFlywheelResponse$ActiveModelArn": "The Amazon Resource Number (ARN) of the active model version.
", "DeleteResourcePolicyRequest$ResourceArn": "The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.
", "DescribeResourcePolicyRequest$ResourceArn": "The Amazon Resource Name (ARN) of the custom model version that has the resource policy.
", "EndpointFilter$ModelArn": "The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
", "EndpointProperties$ModelArn": "The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
", "EndpointProperties$DesiredModelArn": "ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress
", + "FlywheelIterationProperties$EvaluatedModelArn": "The ARN of the evaluated model associated with this flywheel iteration.
", + "FlywheelIterationProperties$TrainedModelArn": "The ARN of the trained model associated with this flywheel iteration.
", + "FlywheelProperties$ActiveModelArn": "The Amazon Resource Number (ARN) of the active model version.
", + "FlywheelSummary$ActiveModelArn": "ARN of the active model version for the flywheel.
", "ImportModelRequest$SourceModelArn": "The Amazon Resource Name (ARN) of the custom model to import.
", "ImportModelResponse$ModelArn": "The Amazon Resource Name (ARN) of the custom model being imported.
", "PutResourcePolicyRequest$ResourceArn": "The Amazon Resource Name (ARN) of the custom model to attach the policy to.
", - "UpdateEndpointRequest$DesiredModelArn": "The ARN of the new model to use when updating an existing endpoint.
" + "UpdateEndpointRequest$DesiredModelArn": "The ARN of the new model to use when updating an existing endpoint.
", + "UpdateEndpointResponse$DesiredModelArn": "The Amazon Resource Number (ARN) of the new model.
", + "UpdateFlywheelRequest$ActiveModelArn": "The Amazon Resource Number (ARN) of the active model version.
" } }, "ConcurrentModificationException": { @@ -392,6 +458,16 @@ "refs": { } }, + "CreateDatasetRequest": { + "base": null, + "refs": { + } + }, + "CreateDatasetResponse": { + "base": null, + "refs": { + } + }, "CreateDocumentClassifierRequest": { "base": null, "refs": { @@ -422,6 +498,16 @@ "refs": { } }, + "CreateFlywheelRequest": { + "base": null, + "refs": { + } + }, + "CreateFlywheelResponse": { + "base": null, + "refs": { + } + }, "CustomerInputString": { "base": null, "refs": { @@ -446,6 +532,101 @@ "BatchDetectTargetedSentimentRequest$TextList": "A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
" } }, + "DataSecurityConfig": { + "base": "Data security configuration.
", + "refs": { + "CreateFlywheelRequest$DataSecurityConfig": "Data security configurations.
", + "FlywheelProperties$DataSecurityConfig": "Data security configuration.
" + } + }, + "DatasetAugmentedManifestsList": { + "base": null, + "refs": { + "DatasetInputDataConfig$AugmentedManifests": "A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
" + } + }, + "DatasetAugmentedManifestsListItem": { + "base": "An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
", + "refs": { + "DatasetAugmentedManifestsList$member": null + } + }, + "DatasetDataFormat": { + "base": null, + "refs": { + "DatasetInputDataConfig$DataFormat": " COMPREHEND_CSV: The data format is a two-column CSV file, where the first column contains labels and the second column contains documents.
AUGMENTED_MANIFEST: The data format
Describes the dataset input data configuration for a document classifier model.
For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.
", + "refs": { + "DatasetInputDataConfig$DocumentClassifierInputDataConfig": "The input properties for training a document classifier model.
For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.
" + } + }, + "DatasetEntityRecognizerAnnotations": { + "base": "Describes the annotations associated with a entity recognizer.
", + "refs": { + "DatasetEntityRecognizerInputDataConfig$Annotations": "The S3 location of the annotation documents for your custom entity recognizer.
" + } + }, + "DatasetEntityRecognizerDocuments": { + "base": "Describes the documents submitted with a dataset for an entity recognizer model.
", + "refs": { + "DatasetEntityRecognizerInputDataConfig$Documents": "The format and location of the training documents for your custom entity recognizer.
" + } + }, + "DatasetEntityRecognizerEntityList": { + "base": "Describes the dataset entity list for an entity recognizer model.
For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.
", + "refs": { + "DatasetEntityRecognizerInputDataConfig$EntityList": "The S3 location of the entity list for your custom entity recognizer.
" + } + }, + "DatasetEntityRecognizerInputDataConfig": { + "base": "Specifies the format and location of the input data. You must provide either the Annotations parameter or the EntityList parameter.
The input properties for training an entity recognizer model.
" + } + }, + "DatasetFilter": { + "base": "Filter the datasets based on creation time or dataset status.
", + "refs": { + "ListDatasetsRequest$Filter": "Filters the datasets to be returned in the response.
" + } + }, + "DatasetInputDataConfig": { + "base": "Specifies the format and location of the input data for the dataset.
", + "refs": { + "CreateDatasetRequest$InputDataConfig": "Information about the input data configuration. The type of input data varies based on the format of the input and whether the data is for a classifier model or an entity recognition model.
" + } + }, + "DatasetProperties": { + "base": "Properties associated with the dataset.
", + "refs": { + "DatasetPropertiesList$member": null, + "DescribeDatasetResponse$DatasetProperties": "The dataset properties.
" + } + }, + "DatasetPropertiesList": { + "base": null, + "refs": { + "ListDatasetsResponse$DatasetPropertiesList": "The dataset properties list.
" + } + }, + "DatasetStatus": { + "base": null, + "refs": { + "DatasetFilter$Status": "Filter the datasets based on the dataset status.
", + "DatasetProperties$Status": "The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.
The dataset type. You can specify that the data in a dataset is for training the model or for testing the model.
", + "DatasetFilter$DatasetType": "Filter the datasets based on the dataset type.
", + "DatasetProperties$DatasetType": "The dataset type (training data or test data).
" + } + }, "DeleteDocumentClassifierRequest": { "base": null, "refs": { @@ -476,6 +657,16 @@ "refs": { } }, + "DeleteFlywheelRequest": { + "base": null, + "refs": { + } + }, + "DeleteFlywheelResponse": { + "base": null, + "refs": { + } + }, "DeleteResourcePolicyRequest": { "base": null, "refs": { @@ -486,6 +677,16 @@ "refs": { } }, + "DescribeDatasetRequest": { + "base": null, + "refs": { + } + }, + "DescribeDatasetResponse": { + "base": null, + "refs": { + } + }, "DescribeDocumentClassificationJobRequest": { "base": null, "refs": { @@ -556,6 +757,26 @@ "refs": { } }, + "DescribeFlywheelIterationRequest": { + "base": null, + "refs": { + } + }, + "DescribeFlywheelIterationResponse": { + "base": null, + "refs": { + } + }, + "DescribeFlywheelRequest": { + "base": null, + "refs": { + } + }, + "DescribeFlywheelResponse": { + "base": null, + "refs": { + } + }, "DescribeKeyPhrasesDetectionJobRequest": { "base": null, "refs": { @@ -616,6 +837,13 @@ "refs": { } }, + "Description": { + "base": null, + "refs": { + "CreateDatasetRequest$Description": "Description of the dataset.
", + "DatasetProperties$Description": "Description of the dataset.
" + } + }, "DetectDominantLanguageRequest": { "base": null, "refs": { @@ -692,6 +920,12 @@ "ListOfClasses$member": null } }, + "DocumentClassificationConfig": { + "base": "Configuration required for a custom classification model.
", + "refs": { + "TaskConfig$DocumentClassificationConfig": "Configuration required for a classification model.
" + } + }, "DocumentClassificationJobFilter": { "base": "Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.
", "refs": { @@ -716,11 +950,12 @@ "refs": { "CreateDocumentClassifierResponse$DocumentClassifierArn": "The Amazon Resource Name (ARN) that identifies the document classifier.
", "DeleteDocumentClassifierRequest$DocumentClassifierArn": "The Amazon Resource Name (ARN) that identifies the document classifier.
", - "DescribeDocumentClassifierRequest$DocumentClassifierArn": "The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its response.
", + "DescribeDocumentClassifierRequest$DocumentClassifierArn": "The Amazon Resource Name (ARN) that identifies the document classifier. The CreateDocumentClassifier operation returns this identifier in its response.
The Amazon Resource Name (ARN) that identifies the document classifier.
", "DocumentClassifierProperties$DocumentClassifierArn": "The Amazon Resource Name (ARN) that identifies the document classifier.
", "DocumentClassifierProperties$SourceModelArn": "The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the document classifier model in your AWS account.
", "StartDocumentClassificationJobRequest$DocumentClassifierArn": "The Amazon Resource Name (ARN) of the document classifier to use to process the job.
", + "StartDocumentClassificationJobResponse$DocumentClassifierArn": "The ARN of the custom classification model.
", "StopTrainingDocumentClassifierRequest$DocumentClassifierArn": "The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.
" } }, @@ -743,7 +978,7 @@ } }, "DocumentClassifierFilter": { - "base": "Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the operation.
", + "base": "Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the ListDocumentClassifiers operation.
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.
" } @@ -759,6 +994,7 @@ "base": null, "refs": { "CreateDocumentClassifierRequest$Mode": "Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
", + "DocumentClassificationConfig$Mode": "Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.
Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.
" } }, @@ -886,7 +1122,11 @@ "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. 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.
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 average F1 score from the evaluation metrics.
", + "FlywheelModelEvaluationMetrics$AveragePrecision": "Average precision metric for the model.
", + "FlywheelModelEvaluationMetrics$AverageRecall": "Average recall metric for the model.
", + "FlywheelModelEvaluationMetrics$AverageAccuracy": "Average accuracy metric for the model.
" } }, "EndpointFilter": { @@ -946,6 +1186,12 @@ "ListOfEntityLabels$member": null } }, + "EntityRecognitionConfig": { + "base": "Configuration required for an entity recognition model.
", + "refs": { + "TaskConfig$EntityRecognitionConfig": "Configuration required for an entity recognition model.
" + } + }, "EntityRecognizerAnnotations": { "base": "Describes the annotations associated with a entity recognizer.
", "refs": { @@ -962,6 +1208,7 @@ "EntityRecognizerProperties$EntityRecognizerArn": "The Amazon Resource Name (ARN) that identifies the entity recognizer.
", "EntityRecognizerProperties$SourceModelArn": "The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the entity recognizer model in your AWS account.
", "StartEntitiesDetectionJobRequest$EntityRecognizerArn": "The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.
The ARN of the custom entity recognition model.
", "StopTrainingEntityRecognizerRequest$EntityRecognizerArn": "The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.
" } }, @@ -990,7 +1237,7 @@ } }, "EntityRecognizerEntityList": { - "base": "Describes the entity recognizer submitted with an entity recognizer.
", + "base": "Describes the entity list submitted with an entity recognizer.
", "refs": { "EntityRecognizerInputDataConfig$EntityList": "The S3 location of the CSV file that has the entity list for your custom entity recognizer.
" } @@ -1002,7 +1249,7 @@ } }, "EntityRecognizerFilter": { - "base": "Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the operation./>
", + "base": "Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the ListEntityRecognizers operation./>
Filters the list of entities returned. You can filter on Status, SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.
Output data configuration.
", + "refs": { + "EntityRecognizerProperties$OutputDataConfig": "Output data configuration.
" + } + }, "EntityRecognizerProperties": { "base": "Describes information about an entity recognizer.
", "refs": { @@ -1078,6 +1331,7 @@ "EntityTypesList": { "base": null, "refs": { + "EntityRecognitionConfig$EntityTypes": "Up to 25 entity types that the model is trained to recognize.
", "EntityRecognizerInputDataConfig$EntityTypes": "The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.
A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \\n (line break), \\\\n (escaped line break), \\r (carriage return), \\\\r (escaped carriage return), \\t (tab), \\\\t (escaped tab), space, and , (comma).
" } }, @@ -1149,6 +1403,87 @@ "TargetedSentimentMention$GroupScore": "The confidence that all the entities mentioned in the group relate to the same entity.
" } }, + "FlywheelFilter": { + "base": "Filter the flywheels based on creation time or flywheel status.
", + "refs": { + "ListFlywheelsRequest$Filter": "Filters the flywheels that are returned. You can filter flywheels on their status, or the date and time that they were submitted. You can only set one filter at a time.
" + } + }, + "FlywheelIterationFilter": { + "base": "Filter the flywheel iterations based on creation time.
", + "refs": { + "ListFlywheelIterationHistoryRequest$Filter": "Filter the flywheel iteration history based on creation time.
" + } + }, + "FlywheelIterationId": { + "base": null, + "refs": { + "DescribeFlywheelIterationRequest$FlywheelIterationId": "", + "FlywheelIterationProperties$FlywheelIterationId": "", + "FlywheelProperties$LatestFlywheelIteration": "The most recent flywheel iteration.
", + "FlywheelSummary$LatestFlywheelIteration": "The most recent flywheel iteration.
", + "StartFlywheelIterationResponse$FlywheelIterationId": "" + } + }, + "FlywheelIterationProperties": { + "base": "The configuration properties of a flywheel iteration.
", + "refs": { + "DescribeFlywheelIterationResponse$FlywheelIterationProperties": "The configuration properties of a flywheel iteration.
", + "FlywheelIterationPropertiesList$member": null + } + }, + "FlywheelIterationPropertiesList": { + "base": null, + "refs": { + "ListFlywheelIterationHistoryResponse$FlywheelIterationPropertiesList": "List of flywheel iteration properties
" + } + }, + "FlywheelIterationStatus": { + "base": null, + "refs": { + "FlywheelIterationProperties$Status": "The status of the flywheel iteration.
" + } + }, + "FlywheelModelEvaluationMetrics": { + "base": "The evaluation metrics associated with the evaluated model.
", + "refs": { + "FlywheelIterationProperties$EvaluatedModelMetrics": null, + "FlywheelIterationProperties$TrainedModelMetrics": "The metrics associated with the trained model.
" + } + }, + "FlywheelProperties": { + "base": "The flywheel properties.
", + "refs": { + "DescribeFlywheelResponse$FlywheelProperties": "The flywheel properties.
", + "UpdateFlywheelResponse$FlywheelProperties": "The flywheel properties.
" + } + }, + "FlywheelS3Uri": { + "base": null, + "refs": { + "CreateFlywheelRequest$DataLakeS3Uri": "Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.
" + } + }, + "FlywheelStatus": { + "base": null, + "refs": { + "FlywheelFilter$Status": "Filter the flywheels based on the flywheel status.
", + "FlywheelProperties$Status": "The status of the flywheel.
", + "FlywheelSummary$Status": "The status of the flywheel.
" + } + }, + "FlywheelSummary": { + "base": "Flywheel summary information.
", + "refs": { + "FlywheelSummaryList$member": null + } + }, + "FlywheelSummaryList": { + "base": null, + "refs": { + "ListFlywheelsResponse$FlywheelSummaryList": "A list of flywheel properties retrieved by the service in response to the request.
" + } + }, "Geometry": { "base": "Information about the location of items on a document page.
For additional information, see Geometry in the Amazon Textract API reference.
", "refs": { @@ -1158,21 +1493,23 @@ "IamRoleArn": { "base": null, "refs": { - "CreateDocumentClassifierRequest$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
", - "CreateEndpointRequest$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
", - "CreateEntityRecognizerRequest$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
", - "DocumentClassificationJobProperties$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.
", - "DocumentClassifierProperties$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
", - "DominantLanguageDetectionJobProperties$DataAccessRoleArn": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
", - "EndpointProperties$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
", + "CreateDocumentClassifierRequest$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.
", + "CreateEndpointRequest$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
", + "CreateEntityRecognizerRequest$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.
", + "CreateFlywheelRequest$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.
", + "DocumentClassificationJobProperties$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.
", + "DocumentClassifierProperties$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.
", + "DominantLanguageDetectionJobProperties$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.
", + "EndpointProperties$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
", "EndpointProperties$DesiredDataAccessRoleArn": "Data access role ARN to use in case the new model is encrypted with a customer KMS key.
", - "EntitiesDetectionJobProperties$DataAccessRoleArn": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
", - "EntityRecognizerProperties$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
", - "EventsDetectionJobProperties$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identify and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
", - "ImportModelRequest$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that allows Amazon Comprehend to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.
", - "KeyPhrasesDetectionJobProperties$DataAccessRoleArn": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
", - "PiiEntitiesDetectionJobProperties$DataAccessRoleArn": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
", - "SentimentDetectionJobProperties$DataAccessRoleArn": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
", + "EntitiesDetectionJobProperties$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.
", + "EntityRecognizerProperties$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.
", + "EventsDetectionJobProperties$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.
", + "FlywheelProperties$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend permission to access the flywheel data.
", + "ImportModelRequest$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.
", + "KeyPhrasesDetectionJobProperties$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.
", + "PiiEntitiesDetectionJobProperties$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.
", + "SentimentDetectionJobProperties$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.
", "StartDocumentClassificationJobRequest$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.
", "StartDominantLanguageDetectionJobRequest$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.
", "StartEntitiesDetectionJobRequest$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.
", @@ -1182,9 +1519,10 @@ "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.
" + "TargetedSentimentDetectionJobProperties$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.
", + "TopicsDetectionJobProperties$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access 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.
", + "UpdateFlywheelRequest$DataAccessRoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend permission to access the flywheel data.
" } }, "ImportModelRequest": { @@ -1232,6 +1570,7 @@ "InputFormat": { "base": null, "refs": { + "DatasetEntityRecognizerDocuments$InputFormat": "Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
", "EntityRecognizerDocuments$InputFormat": "Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
", "InputDataConfig$InputFormat": "Specifies how the text in an input file should be processed:
ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.
ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
", - "DescribeDominantLanguageDetectionJobRequest$JobId": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
", - "DescribeEntitiesDetectionJobRequest$JobId": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
", + "DescribeDocumentClassificationJobRequest$JobId": "The identifier that Amazon Comprehend generated for the job. The StartDocumentClassificationJob operation returns this identifier in its response.
The identifier that Amazon Comprehend generated for the job. The StartDominantLanguageDetectionJob operation returns this identifier in its response.
The identifier that Amazon Comprehend generated for the job. The StartEntitiesDetectionJob operation returns this identifier in its response.
The identifier of the events detection job.
", - "DescribeKeyPhrasesDetectionJobRequest$JobId": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
", + "DescribeKeyPhrasesDetectionJobRequest$JobId": "The identifier that Amazon Comprehend generated for the job. The StartKeyPhrasesDetectionJob operation returns this identifier in its response.
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.
", + "DescribeTargetedSentimentDetectionJobRequest$JobId": "The identifier that Amazon Comprehend generated for the job. The StartTargetedSentimentDetectionJob operation returns this identifier in its response.
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.
", @@ -1333,14 +1672,14 @@ "KeyPhrasesDetectionJobProperties$JobId": "The identifier assigned to the key phrases detection job.
", "PiiEntitiesDetectionJobProperties$JobId": "The identifier assigned to the PII entities detection job.
", "SentimentDetectionJobProperties$JobId": "The identifier assigned to the sentiment detection job.
", - "StartDocumentClassificationJobResponse$JobId": "The identifier generated for the job. To get the status of the job, use this identifier with the operation.
", + "StartDocumentClassificationJobResponse$JobId": "The identifier generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation.
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
", "StartEntitiesDetectionJobResponse$JobId": "The identifier generated for the job. To get the status of job, use this identifier with the operation.
", "StartEventsDetectionJobResponse$JobId": "An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
", "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.
", + "StartTargetedSentimentDetectionJobResponse$JobId": "The identifier generated for the job. To get the status of a job, use this identifier with the DescribeTargetedSentimentDetectionJob operation.
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.
", @@ -1414,14 +1753,14 @@ "PiiEntitiesDetectionJobProperties$JobStatus": "The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
", "SentimentDetectionJobProperties$JobStatus": "The current status of the sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.
The status of the job:
SUBMITTED - The job has been received and 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. For details, use the operation.
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
STOPPED - The job was successfully stopped without completing.
The status of the job:
SUBMITTED - The job has been received and 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. For details, use the DescribeDocumentClassificationJob operation.
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
STOPPED - The job was successfully stopped without completing.
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.
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
STOPPED - The job was successfully stopped without completing.
The status of the events detection job.
", "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 DescribeTargetedSentimentDetectionJob 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.
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 trained custom models. The ModelKmsKeyId 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 trained custom models. The ModelKmsKeyId 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 trained custom models. The ModelKmsKeyId 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 trained custom models. The ModelKmsKeyId 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 the volume.
", + "DataSecurityConfig$DataLakeKmsKeyId": "ID for the KMS key that Amazon Comprehend uses to encrypt the data in the data lake.
", "DocumentClassificationJobProperties$VolumeKmsKeyId": "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 the output results from an analysis job. The KmsKeyId can be one 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\"
KMS Key Alias: \"alias/ExampleAlias\"
ARN of a KMS Key Alias: \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"
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 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 trained custom models. The ModelKmsKeyId 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 trained custom models. The ModelKmsKeyId 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 trained custom models. The ModelKmsKeyId 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 the output results from an analysis job. The KmsKeyId can be one 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\"
KMS Key Alias: \"alias/ExampleAlias\"
ARN of a KMS Key Alias: \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"
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\"
ID for the KMS key that Amazon Comprehend uses to encrypt the 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\"
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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 the volume.
" } }, "KmsKeyValidationException": { @@ -1500,9 +1844,22 @@ "LabelDelimiter": { "base": null, "refs": { + "DatasetDocumentClassifierInputDataConfig$LabelDelimiter": "Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.
", "DocumentClassifierInputDataConfig$LabelDelimiter": "Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.
" } }, + "LabelListItem": { + "base": null, + "refs": { + "LabelsList$member": null + } + }, + "LabelsList": { + "base": null, + "refs": { + "DocumentClassificationConfig$Labels": "One or more labels to associate with the custom classifier.
" + } + }, "LanguageCode": { "base": null, "refs": { @@ -1511,7 +1868,7 @@ "BatchDetectSentimentRequest$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.
", "BatchDetectTargetedSentimentRequest$LanguageCode": "The language of the input documents. Currently, English is the only supported language.
", "ContainsPiiEntitiesRequest$LanguageCode": "The language of the input documents. Currently, English is the only valid language.
", - "CreateDocumentClassifierRequest$LanguageCode": "The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.
", + "CreateDocumentClassifierRequest$LanguageCode": "The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.
", "CreateEntityRecognizerRequest$LanguageCode": "You can specify any of the following languages: English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), German (\"de\"), or Portuguese (\"pt\"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.
", "DetectEntitiesRequest$LanguageCode": "The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.
All input documents must be in the same language.
", "DetectKeyPhrasesRequest$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.
", @@ -1531,7 +1888,18 @@ "StartPiiEntitiesDetectionJobRequest$LanguageCode": "The language of the input documents. Currently, English is the only valid 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. Currently, English is the only supported language.
", - "TargetedSentimentDetectionJobProperties$LanguageCode": "The language code of the input documents.
" + "TargetedSentimentDetectionJobProperties$LanguageCode": "The language code of the input documents.
", + "TaskConfig$LanguageCode": "Language code for the language that the model supports.
" + } + }, + "ListDatasetsRequest": { + "base": null, + "refs": { + } + }, + "ListDatasetsResponse": { + "base": null, + "refs": { } }, "ListDocumentClassificationJobsRequest": { @@ -1624,6 +1992,26 @@ "refs": { } }, + "ListFlywheelIterationHistoryRequest": { + "base": null, + "refs": { + } + }, + "ListFlywheelIterationHistoryResponse": { + "base": null, + "refs": { + } + }, + "ListFlywheelsRequest": { + "base": null, + "refs": { + } + }, + "ListFlywheelsResponse": { + "base": null, + "refs": { + } + }, "ListKeyPhrasesDetectionJobsRequest": { "base": null, "refs": { @@ -1856,6 +2244,7 @@ "MaxResultsInteger": { "base": null, "refs": { + "ListDatasetsRequest$MaxResults": "Maximum number of results to return in a response. The default is 100.
", "ListDocumentClassificationJobsRequest$MaxResults": "The maximum number of results to return in each page. The default is 100.
", "ListDocumentClassifierSummariesRequest$MaxResults": "The maximum number of results to return on each page. The default is 100.
", "ListDocumentClassifiersRequest$MaxResults": "The maximum number of results to return in each page. The default is 100.
", @@ -1865,6 +2254,8 @@ "ListEntityRecognizerSummariesRequest$MaxResults": "The maximum number of results to return on each page. The default is 100.
", "ListEntityRecognizersRequest$MaxResults": "The maximum number of results to return on each page. The default is 100.
", "ListEventsDetectionJobsRequest$MaxResults": "The maximum number of results to return in each page.
", + "ListFlywheelIterationHistoryRequest$MaxResults": "Maximum number of iteration history results to return
", + "ListFlywheelsRequest$MaxResults": "Maximum number of results to return in a response. The default is 100.
", "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.
", @@ -1889,6 +2280,20 @@ "EntityRecognizerSummary$LatestVersionStatus": "Provides the status of the latest entity recognizer version.
" } }, + "ModelType": { + "base": null, + "refs": { + "CreateFlywheelRequest$ModelType": "The model type.
", + "FlywheelProperties$ModelType": "Model type of the flywheel's model.
", + "FlywheelSummary$ModelType": "Model type of the flywheel's model.
" + } + }, + "NumberOfDocuments": { + "base": null, + "refs": { + "DatasetProperties$NumberOfDocuments": "The number of documents in the dataset.
" + } + }, "NumberOfTopicsInteger": { "base": null, "refs": { @@ -2072,14 +2477,27 @@ "AugmentedManifestsListItem$S3Uri": "The Amazon S3 location of the augmented manifest file.
", "AugmentedManifestsListItem$AnnotationDataS3Uri": "The S3 prefix to the annotation files that are referred in the augmented manifest file.
", "AugmentedManifestsListItem$SourceDocumentsS3Uri": "The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
", + "DatasetAugmentedManifestsListItem$S3Uri": "The Amazon S3 location of the augmented manifest file.
", + "DatasetAugmentedManifestsListItem$AnnotationDataS3Uri": "The S3 prefix to the annotation files that are referred in the augmented manifest file.
", + "DatasetAugmentedManifestsListItem$SourceDocumentsS3Uri": "The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
", + "DatasetDocumentClassifierInputDataConfig$S3Uri": "The Amazon S3 URI for the input data. The S3 bucket must be in the 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 input 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.
This parameter is required if you set DataFormat to COMPREHEND_CSV.
Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
", + "DatasetEntityRecognizerDocuments$S3Uri": "Specifies the Amazon S3 location where the documents for the dataset are located.
", + "DatasetEntityRecognizerEntityList$S3Uri": "Specifies the Amazon S3 location where the entity list is located.
", + "DatasetProperties$DatasetS3Uri": "The S3 URI where the dataset is stored.
", "DocumentClassifierInputDataConfig$S3Uri": "The Amazon S3 URI for the input data. The S3 bucket must be in the 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 input 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.
This parameter is required if you set DataFormat to COMPREHEND_CSV.
This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
", "DocumentClassifierOutputDataConfig$S3Uri": "When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. 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 this output file.
When the custom classifier job is finished, the service creates the 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 confusion matrix.
The Amazon S3 prefix for the data lake location of the flywheel statistics.
", "EntityRecognizerAnnotations$S3Uri": "Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
", "EntityRecognizerAnnotations$TestS3Uri": "Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
", "EntityRecognizerDocuments$S3Uri": "Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
", "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.
", + "EntityRecognizerOutputDataConfig$FlywheelStatsS3Prefix": "The Amazon S3 prefix for the data lake location of the flywheel statistics.
", + "FlywheelIterationProperties$EvaluationManifestS3Prefix": "", + "FlywheelProperties$DataLakeS3Uri": "Amazon S3 URI of the data lake location.
", + "FlywheelSummary$DataLakeS3Uri": "Amazon S3 URI of the data lake location.
", "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.
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.
The text of a key noun phrase.
", "KmsKeyValidationException$Message": null, + "ListDatasetsRequest$NextToken": "Identifies the next page of results to return.
", + "ListDatasetsResponse$NextToken": "Identifies the next page of results to return.
", "ListDocumentClassificationJobsRequest$NextToken": "Identifies the next page of results to return.
", "ListDocumentClassificationJobsResponse$NextToken": "Identifies the next page of results to return.
", "ListDocumentClassifierSummariesRequest$NextToken": "Identifies the next page of results to return.
", @@ -2362,11 +2792,15 @@ "ListEntitiesDetectionJobsRequest$NextToken": "Identifies the next page of results to return.
", "ListEntitiesDetectionJobsResponse$NextToken": "Identifies the next page of results to return.
", "ListEntityRecognizerSummariesRequest$NextToken": "Identifies the next page of results to return.
", - "ListEntityRecognizerSummariesResponse$NextToken": "The list entity recognizer summaries.
", + "ListEntityRecognizerSummariesResponse$NextToken": "Identifies the next page of results to return.
", "ListEntityRecognizersRequest$NextToken": "Identifies the next page of results to return.
", "ListEntityRecognizersResponse$NextToken": "Identifies the next page of results to return.
", "ListEventsDetectionJobsRequest$NextToken": "Identifies the next page of results to return.
", "ListEventsDetectionJobsResponse$NextToken": "Identifies the next page of results to return.
", + "ListFlywheelIterationHistoryRequest$NextToken": "Next token
", + "ListFlywheelIterationHistoryResponse$NextToken": "Next token
", + "ListFlywheelsRequest$NextToken": "Identifies the next page of results to return.
", + "ListFlywheelsResponse$NextToken": "Identifies the next page of results to return.
", "ListKeyPhrasesDetectionJobsRequest$NextToken": "Identifies the next page of results to return.
", "ListKeyPhrasesDetectionJobsResponse$NextToken": "Identifies the next page of results to return.
", "ListPiiEntitiesDetectionJobsRequest$NextToken": "Identifies the next page of results to return.
", @@ -2444,20 +2878,22 @@ "TagList": { "base": null, "refs": { - "CreateDocumentClassifierRequest$Tags": "Tags to be associated with the document classifier being created. 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.
", - "CreateEndpointRequest$Tags": "Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with \"Sales\" as the key might be added to an endpoint to indicate its use by the sales department.
", - "CreateEntityRecognizerRequest$Tags": "Tags to be associated with the entity recognizer being created. 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.
", - "ImportModelRequest$Tags": "Tags to be associated with the custom model that is created by this import. 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.
", + "CreateDatasetRequest$Tags": "Tags for the dataset.
", + "CreateDocumentClassifierRequest$Tags": "Tags to associate with the document classifier. 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.
", + "CreateEndpointRequest$Tags": "Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with \"Sales\" as the key might be added to an endpoint to indicate its use by the sales department.
", + "CreateEntityRecognizerRequest$Tags": "Tags to associate with the entity recognizer. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
", + "CreateFlywheelRequest$Tags": "The tags to associate with this flywheel.
", + "ImportModelRequest$Tags": "Tags to associate with the custom model that is created by this import. 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.
", "ListTagsForResourceResponse$Tags": "Tags associated with the Amazon Comprehend resource being queried. 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.
", - "StartDocumentClassificationJobRequest$Tags": "Tags to be associated with the document classification 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.
", - "StartDominantLanguageDetectionJobRequest$Tags": "Tags to be associated with the dominant language 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.
", - "StartEntitiesDetectionJobRequest$Tags": "Tags to be associated with the 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.
", - "StartEventsDetectionJobRequest$Tags": "Tags to be associated with the events 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.
", - "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.
", + "StartDocumentClassificationJobRequest$Tags": "Tags to associate with the document classification 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.
", + "StartDominantLanguageDetectionJobRequest$Tags": "Tags to associate with the dominant language 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.
", + "StartEntitiesDetectionJobRequest$Tags": "Tags to associate with the 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.
", + "StartEventsDetectionJobRequest$Tags": "Tags to associate with the events 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.
", + "StartKeyPhrasesDetectionJobRequest$Tags": "Tags to associate 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 associate 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 associate 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 associate with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.
", + "StartTopicsDetectionJobRequest$Tags": "Tags to associate 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.
" } }, @@ -2485,7 +2921,7 @@ } }, "TargetedSentimentDetectionJobFilter": { - "base": "Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
", + "base": "Provides information for filtering a list of dominant language detection jobs. For more information, see the ListTargetedSentimentDetectionJobs operation.
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.
" } @@ -2521,6 +2957,13 @@ "ListOfMentions$member": null } }, + "TaskConfig": { + "base": "Configuration about the custom classifier associated with the flywheel.
", + "refs": { + "CreateFlywheelRequest$TaskConfig": "Configuration about the custom classifier associated with the flywheel.
", + "FlywheelProperties$TaskConfig": "Configuration about the custom classifier associated with the flywheel.
" + } + }, "TextSizeLimitExceededException": { "base": "The size of the input text exceeds the limit. Use a smaller document.
", "refs": { @@ -2529,6 +2972,10 @@ "Timestamp": { "base": null, "refs": { + "DatasetFilter$CreationTimeAfter": "Filter the datasets to include datasets created after the specified time.
", + "DatasetFilter$CreationTimeBefore": "Filter the datasets to include datasets created before the specified time.
", + "DatasetProperties$CreationTime": "Creation time of the dataset.
", + "DatasetProperties$EndTime": "Time when the data from the dataset becomes available in the data lake.
", "DescribeResourcePolicyResponse$CreationTime": "The time at which the policy was created.
", "DescribeResourcePolicyResponse$LastModifiedTime": "The time at which the policy was last modified.
", "DocumentClassificationJobFilter$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.
", @@ -2565,6 +3012,16 @@ "EventsDetectionJobFilter$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.
", "EventsDetectionJobProperties$SubmitTime": "The time that the events detection job was submitted for processing.
", "EventsDetectionJobProperties$EndTime": "The time that the events detection job completed.
", + "FlywheelFilter$CreationTimeAfter": "Filter the flywheels to include flywheels created after the specified time.
", + "FlywheelFilter$CreationTimeBefore": "Filter the flywheels to include flywheels created before the specified time.
", + "FlywheelIterationFilter$CreationTimeAfter": "Filter the flywheel iterations to include iterations created after the specified time.
", + "FlywheelIterationFilter$CreationTimeBefore": "Filter the flywheel iterations to include iterations created before the specified time.
", + "FlywheelIterationProperties$CreationTime": "The creation start time of the flywheel iteration.
", + "FlywheelIterationProperties$EndTime": "The completion time of this flywheel iteration.
", + "FlywheelProperties$CreationTime": "Creation time of the flywheel.
", + "FlywheelProperties$LastModifiedTime": "Last modified time for the flywheel.
", + "FlywheelSummary$CreationTime": "Creation time of the flywheel.
", + "FlywheelSummary$LastModifiedTime": "Last modified time for the flywheel.
", "KeyPhrasesDetectionJobFilter$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.
", "KeyPhrasesDetectionJobFilter$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.
", "KeyPhrasesDetectionJobProperties$SubmitTime": "The time that the key phrases detection job was submitted for processing.
", @@ -2636,6 +3093,12 @@ "refs": { } }, + "UpdateDataSecurityConfig": { + "base": "Data security configuration.
", + "refs": { + "UpdateFlywheelRequest$DataSecurityConfig": "Flywheel data security configuration.
" + } + }, "UpdateEndpointRequest": { "base": null, "refs": { @@ -2646,6 +3109,16 @@ "refs": { } }, + "UpdateFlywheelRequest": { + "base": null, + "refs": { + } + }, + "UpdateFlywheelResponse": { + "base": null, + "refs": { + } + }, "VersionName": { "base": null, "refs": { @@ -2663,6 +3136,7 @@ "refs": { "CreateDocumentClassifierRequest$VpcConfig": "Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
", "CreateEntityRecognizerRequest$VpcConfig": "Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
", + "DataSecurityConfig$VpcConfig": null, "DocumentClassificationJobProperties$VpcConfig": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
", "DocumentClassifierProperties$VpcConfig": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
", "DominantLanguageDetectionJobProperties$VpcConfig": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.
", @@ -2678,7 +3152,8 @@ "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.
" + "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.
", + "UpdateDataSecurityConfig$VpcConfig": null } } } diff --git a/models/apis/comprehend/2017-11-27/endpoint-rule-set-1.json b/models/apis/comprehend/2017-11-27/endpoint-rule-set-1.json index 62da72bdfe6..f3e6eb40d67 100644 --- a/models/apis/comprehend/2017-11-27/endpoint-rule-set-1.json +++ b/models/apis/comprehend/2017-11-27/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,23 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -71,67 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -140,90 +111,215 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] }, - "supportsFIPS" + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://comprehend-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] }, { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsDualStack" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://comprehend-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://comprehend-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsFIPS" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://comprehend.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], "type": "tree", @@ -231,7 +327,7 @@ { "conditions": [], "endpoint": { - "url": "https://comprehend-fips.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://comprehend.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, @@ -240,74 +336,13 @@ ] } ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://comprehend.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "endpoint": { - "url": "https://comprehend.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/models/apis/comprehend/2017-11-27/endpoint-tests-1.json b/models/apis/comprehend/2017-11-27/endpoint-tests-1.json index 7d2411ad289..e75ad3540f7 100644 --- a/models/apis/comprehend/2017-11-27/endpoint-tests-1.json +++ b/models/apis/comprehend/2017-11-27/endpoint-tests-1.json @@ -1,42 +1,29 @@ { "testCases": [ { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.ap-south-1.amazonaws.com" + "url": "https://comprehend.ap-northeast-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.ap-south-1.api.aws" + "url": "https://comprehend.ap-northeast-2.amazonaws.com" } }, "params": { - "UseDualStack": true, + "Region": "ap-northeast-2", "UseFIPS": false, - "Region": "ap-south-1" + "UseDualStack": false } }, { @@ -47,48 +34,35 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-south-1", "UseFIPS": false, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ca-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ca-central-1" + "UseDualStack": false } }, { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.ca-central-1.amazonaws.com" + "url": "https://comprehend.ap-southeast-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.ca-central-1.api.aws" + "url": "https://comprehend.ap-southeast-2.amazonaws.com" } }, "params": { - "UseDualStack": true, + "Region": "ap-southeast-2", "UseFIPS": false, - "Region": "ca-central-1" + "UseDualStack": false } }, { @@ -99,48 +73,9 @@ } }, "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ca-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.eu-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.eu-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.eu-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, + "Region": "ca-central-1", "UseFIPS": false, - "Region": "eu-central-1" + "UseDualStack": false } }, { @@ -151,100 +86,87 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-central-1", "UseFIPS": false, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-west-1" + "UseDualStack": false } }, { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.us-west-1.amazonaws.com" + "url": "https://comprehend.eu-west-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-west-1" + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.us-west-1.api.aws" + "url": "https://comprehend.eu-west-2.amazonaws.com" } }, "params": { - "UseDualStack": true, + "Region": "eu-west-2", "UseFIPS": false, - "Region": "us-west-1" + "UseDualStack": false } }, { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.us-west-1.amazonaws.com" + "url": "https://comprehend.us-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, - "Region": "us-west-1" + "UseDualStack": false } }, { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.us-west-2.api.aws" + "url": "https://comprehend-fips.us-east-1.amazonaws.com" } }, "params": { - "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": true, - "Region": "us-west-2" + "UseDualStack": false } }, { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.us-west-2.amazonaws.com" + "url": "https://comprehend.us-east-2.amazonaws.com" } }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.us-west-2.api.aws" + "url": "https://comprehend-fips.us-east-2.amazonaws.com" } }, "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false } }, { @@ -255,978 +177,280 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": false, - "Region": "us-west-2" + "UseDualStack": false } }, { - "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.af-south-1.api.aws" + "url": "https://comprehend-fips.us-west-2.amazonaws.com" } }, "params": { - "UseDualStack": true, + "Region": "us-west-2", "UseFIPS": true, - "Region": "af-south-1" + "UseDualStack": false } }, { - "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.af-south-1.amazonaws.com" + "url": "https://comprehend-fips.us-east-1.api.aws" } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": true, - "Region": "af-south-1" - } - }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.af-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "af-south-1" + "UseDualStack": true } }, { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://comprehend.af-south-1.amazonaws.com" + "url": "https://comprehend.us-east-1.api.aws" } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, - "Region": "af-south-1" + "UseDualStack": true } }, { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-north-1.api.aws" + "url": "https://comprehend-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": true, - "Region": "eu-north-1" + "UseDualStack": true } }, { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-north-1.amazonaws.com" + "url": "https://comprehend-fips.cn-north-1.amazonaws.com.cn" } }, "params": { - "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": true, - "Region": "eu-north-1" + "UseDualStack": false } }, { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://comprehend.eu-north-1.api.aws" + "url": "https://comprehend.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": false, - "Region": "eu-north-1" + "UseDualStack": true } }, { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.eu-north-1.amazonaws.com" + "url": "https://comprehend.cn-north-1.amazonaws.com.cn" } }, "params": { - "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": false, - "Region": "eu-north-1" + "UseDualStack": false } }, { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-west-3.api.aws" + "url": "https://comprehend.us-gov-west-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-3" + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-west-3.amazonaws.com" + "url": "https://comprehend-fips.us-gov-west-1.amazonaws.com" } }, "params": { - "UseDualStack": false, + "Region": "us-gov-west-1", "UseFIPS": true, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.eu-west-3.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-west-3" + "UseDualStack": false } }, { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://comprehend.eu-west-3.amazonaws.com" + "url": "https://comprehend-fips.us-gov-east-1.api.aws" } }, "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-west-3" + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-west-2.api.aws" + "url": "https://comprehend-fips.us-gov-east-1.amazonaws.com" } }, "params": { - "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": true, - "Region": "eu-west-2" + "UseDualStack": false } }, { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-west-2.amazonaws.com" + "url": "https://comprehend.us-gov-east-1.api.aws" } }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-2" + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.eu-west-2.api.aws" + "url": "https://comprehend.us-gov-east-1.amazonaws.com" } }, "params": { - "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": false, - "Region": "eu-west-2" + "UseDualStack": false } }, { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.eu-west-2.amazonaws.com" + "url": "https://comprehend.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": false, - "Region": "eu-west-2" + "UseDualStack": false } }, { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-west-1.api.aws" + "url": "https://comprehend-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseDualStack": true, + "Region": "us-iso-east-1", "UseFIPS": true, - "Region": "eu-west-1" + "UseDualStack": false } }, { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend-fips.eu-west-1.amazonaws.com" + "url": "https://comprehend-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": true, - "Region": "eu-west-1" + "UseDualStack": false } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://comprehend.eu-west-1.api.aws" + "url": "https://comprehend.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "UseDualStack": true, + "Region": "us-isob-east-1", "UseFIPS": false, - "Region": "eu-west-1" + "UseDualStack": false } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { - "url": "https://comprehend.eu-west-1.amazonaws.com" + "url": "https://example.com" } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-northeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-northeast-2.amazonaws.com" - } - }, - "params": { "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-northeast-2" + "Endpoint": "https://example.com" } }, { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { - "url": "https://comprehend.ap-northeast-2.api.aws" + "url": "https://example.com" } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-northeast-2.amazonaws.com" - } - }, - "params": { "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-2" + "Endpoint": "https://example.com" } }, { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-northeast-1.api.aws" - } + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": true, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-northeast-1.amazonaws.com" - } - }, - "params": { "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-northeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-northeast-1" + "Endpoint": "https://example.com" } }, { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { - "endpoint": { - "url": "https://comprehend.ap-northeast-1.amazonaws.com" - } + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.me-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "me-south-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.me-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "me-south-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.me-south-1.api.aws" - } - }, - "params": { "UseDualStack": true, - "UseFIPS": false, - "Region": "me-south-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.me-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "me-south-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.sa-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.sa-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-gov-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.us-gov-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-southeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-southeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-southeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-southeast-2" - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-southeast-2" - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-southeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-southeast-2" - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-2" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-east-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-2" - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-2" - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.us-east-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-2" - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.us-east-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-2" - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "cn-northwest-1" - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend-fips.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "cn-northwest-1" - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://comprehend.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "cn-northwest-1" - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://comprehend.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "cn-northwest-1" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } } diff --git a/models/apis/comprehend/2017-11-27/paginators-1.json b/models/apis/comprehend/2017-11-27/paginators-1.json index d95d1ab4d68..3db5bd18266 100644 --- a/models/apis/comprehend/2017-11-27/paginators-1.json +++ b/models/apis/comprehend/2017-11-27/paginators-1.json @@ -1,5 +1,10 @@ { "pagination": { + "ListDatasets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, "ListDocumentClassificationJobs": { "input_token": "NextToken", "limit_key": "MaxResults", @@ -46,6 +51,16 @@ "limit_key": "MaxResults", "output_token": "NextToken" }, + "ListFlywheelIterationHistory": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "ListFlywheels": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, "ListKeyPhrasesDetectionJobs": { "input_token": "NextToken", "limit_key": "MaxResults", diff --git a/models/apis/ec2/2016-11-15/api-2.json b/models/apis/ec2/2016-11-15/api-2.json index a758ca72da4..9ff3799a311 100755 --- a/models/apis/ec2/2016-11-15/api-2.json +++ b/models/apis/ec2/2016-11-15/api-2.json @@ -6555,7 +6555,7 @@ "members":{ "AllocationId":{"shape":"AllocationId"}, "InstanceId":{"shape":"InstanceId"}, - "PublicIp":{"shape":"String"}, + "PublicIp":{"shape":"EipAllocationPublicIp"}, "AllowReassociation":{ "shape":"Boolean", "locationName":"allowReassociation" @@ -19236,7 +19236,7 @@ "type":"structure", "members":{ "AssociationId":{"shape":"ElasticIpAssociationId"}, - "PublicIp":{"shape":"String"}, + "PublicIp":{"shape":"EipAllocationPublicIp"}, "DryRun":{ "shape":"Boolean", "locationName":"dryRun" @@ -19916,6 +19916,7 @@ "locationName":"item" } }, + "EipAllocationPublicIp":{"type":"string"}, "EipAssociationIdList":{ "type":"list", "member":{ @@ -30434,7 +30435,8 @@ "OrganizationalUnitArns":{ "shape":"OrganizationalUnitArnStringList", "locationName":"OrganizationalUnitArn" - } + }, + "ImdsSupport":{"shape":"AttributeValue"} } }, "ModifyInstanceAttributeRequest":{ diff --git a/models/apis/ec2/2016-11-15/docs-2.json b/models/apis/ec2/2016-11-15/docs-2.json index 700c678e7e6..396b968102b 100755 --- a/models/apis/ec2/2016-11-15/docs-2.json +++ b/models/apis/ec2/2016-11-15/docs-2.json @@ -50,7 +50,7 @@ "CancelImageLaunchPermission": "Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more information, see Cancel having an AMI shared with your Amazon Web Services account in the Amazon EC2 User Guide.
", "CancelImportTask": "Cancels an in-process import virtual machine or import snapshot task.
", "CancelReservedInstancesListing": "Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
", - "CancelSpotFleetRequests": "Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support.
", "CopyFpgaImage": "Copies the specified Amazon FPGA Image (AFI) to the current Region.
", @@ -145,7 +145,7 @@ "DeleteCustomerGateway": "Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
", "DeleteDhcpOptions": "Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
", "DeleteEgressOnlyInternetGateway": "Deletes an egress-only internet gateway.
", - "DeleteFleets": "Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances.
You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
", + "DeleteFleets": "Deletes the specified EC2 Fleets.
After you delete an EC2 Fleet, it launches no new instances.
You must also specify whether a deleted EC2 Fleet should terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
", "DeleteFlowLogs": "Deletes one or more flow logs.
", "DeleteFpgaImage": "Deletes the specified Amazon FPGA Image (AFI).
", "DeleteInstanceEventWindow": "Deletes the specified event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
", @@ -319,7 +319,7 @@ "DescribeSpotFleetInstances": "Describes the running instances for the specified Spot Fleet.
", "DescribeSpotFleetRequestHistory": "Describes the events for the specified Spot Fleet request during the specified time.
Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide.
", "DescribeSpotFleetRequests": "Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
", - "DescribeSpotInstanceRequests": "Describes the specified Spot Instance requests.
You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.
We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
", + "DescribeSpotInstanceRequests": "Describes the specified Spot Instance requests.
You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.
We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of items returned. This paginates the output, which makes the list more manageable and returns the items faster. If the list of items exceeds your MaxResults value, then that number of items is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining items.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
", "DescribeSpotPriceHistory": "Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances.
When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time.
", "DescribeStaleSecurityGroups": "[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in the same VPC or in a peer VPC, or if they reference a security group in a peer VPC for which the VPC peering connection has been deleted.
", "DescribeStoreImageTasks": "Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from the last 31 days.
For each AMI task, the response indicates if the task is InProgress, Completed, or Failed. For tasks InProgress, the response shows the estimated progress as a percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.
", @@ -454,7 +454,7 @@ "GetVpnConnectionDeviceSampleConfiguration": "Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.
", "GetVpnConnectionDeviceTypes": "Obtain a list of customer gateway devices for which sample configuration files can be provided. The request has no additional parameters. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide.
", "ImportClientVpnClientCertificateRevocationList": "Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.
Uploading a client certificate revocation list resets existing client connections.
", - "ImportImage": "Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
Amazon Web Services VM Import/Export strongly recommends specifying a value for either the --license-type or --usage-operation parameter when you create a new VM Import task. This ensures your operating system is licensed appropriately and your billing is optimized.
For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.
", + "ImportImage": "To import your virtual machines (VMs) with a console-based experience, you can use the Import virtual machine images to Amazon Web Services template in the Migration Hub Orchestrator console. For more information, see the Migration Hub Orchestrator User Guide .
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
Amazon Web Services VM Import/Export strongly recommends specifying a value for either the --license-type or --usage-operation parameter when you create a new VM Import task. This ensures your operating system is licensed appropriately and your billing is optimized.
For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.
", "ImportInstance": "Creates an import instance task using metadata from the specified disk image.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead.
This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.
For information about the import manifest referenced by this API action, see VM Import Manifest.
", "ImportKeyPair": "Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
", "ImportSnapshot": "Imports a disk into an EBS snapshot.
For more information, see Importing a disk as a snapshot using VM Import/Export in the VM Import/Export User Guide.
", @@ -473,7 +473,7 @@ "ModifyHosts": "Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled.
You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only.
", "ModifyIdFormat": "Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
This setting applies to the IAM user who makes the request; it does not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description or LaunchPermission.
Images with an Amazon Web Services Marketplace product code cannot be made public.
To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.
", + "ModifyImageAttribute": "Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
To specify the attribute, you can use the Attribute parameter, or one of the following parameters: Description, ImdsSupport, or LaunchPermission.
Images with an Amazon Web Services Marketplace product code cannot be made public.
To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.
", "ModifyInstanceAttribute": "Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.
To modify some attributes, the instance must be stopped. For more information, see Modify a stopped instance in the Amazon EC2 User Guide.
", "ModifyInstanceCapacityReservationAttributes": "Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, or run On-Demand Instance capacity.
Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
", @@ -519,7 +519,7 @@ "ModifyVpcEndpointServiceConfiguration": "Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.
If you set or modify the private DNS name, you must prove that you own the private DNS domain name.
", "ModifyVpcEndpointServicePayerResponsibility": "Modifies the payer responsibility for your VPC endpoint service.
", "ModifyVpcEndpointServicePermissions": "Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to your endpoint service.
If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.
", - "ModifyVpcPeeringConnectionOptions": "We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:
Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.
Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.
Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If the peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different different Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
", + "ModifyVpcPeeringConnectionOptions": "We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:
Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.
Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.
Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If the peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
", "ModifyVpcTenancy": "Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to default only. You cannot change the instance tenancy attribute to dedicated.
After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of default, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected.
For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.
", "ModifyVpnConnection": "Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:
An existing virtual private gateway to a new virtual private gateway
An existing virtual private gateway to a transit gateway
An existing transit gateway to a new transit gateway
An existing transit gateway to a virtual private gateway
Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.
This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.
You must delete the static routes before you migrate to the new gateway.
Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.
After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in Update VPC route tables in the Amazon Web Services Site-to-Site VPN User Guide.
When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.
If you deleted VPN static routes, you must add the static routes to the transit gateway route table.
After you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.
", "ModifyVpnConnectionOptions": "Modifies the connection options for your Site-to-Site VPN connection.
When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.
", @@ -1601,6 +1601,7 @@ "InstanceAttribute$SriovNetSupport": "Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
", "InstanceAttribute$UserData": "The user data.
", "ModifyImageAttributeRequest$Description": "A new description for the AMI.
", + "ModifyImageAttributeRequest$ImdsSupport": "Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.
Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", "ModifyInstanceAttributeRequest$InstanceType": "Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.
Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
", @@ -1896,7 +1897,7 @@ "CancelImageLaunchPermissionResult$Return": "Returns true if the request succeeds; otherwise, it returns an error.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.
", + "CancelSpotFleetRequestsRequest$TerminateInstances": "Indicates whether to terminate the associated instances when the Spot Fleet request is canceled. The default is to terminate the instances.
To let the instances continue to run after the Spot Fleet request is canceled, specify no-terminate-instances.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
", "CapacityReservation$EphemeralStorage": "Deprecated.
", @@ -2027,7 +2028,7 @@ "DeleteEgressOnlyInternetGatewayRequest$DryRun": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether to terminate the instances when the EC2 Fleet is deleted. The default is to terminate the instances.
To let the instances continue to run after the EC2 Fleet is deleted, specify NoTerminateInstances. Supported only for fleets of type maintain and request.
For instant fleets, you cannot specify NoTerminateInstances. A deleted instant fleet with running instances is not supported.
Indicates whether to terminate the associated instances when the EC2 Fleet is deleted. The default is to terminate the instances.
To let the instances continue to run after the EC2 Fleet is deleted, specify no-terminate-instances. Supported only for fleets of type maintain and request.
For instant fleets, you cannot specify NoTerminateInstances. A deleted instant fleet with running instances is not supported.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Is true if the request succeeds, and an error otherwise.
The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.
", "CreateFleetRequest$ValidUntil": "The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.
", "DescribeFleetHistoryRequest$StartTime": "The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", - "DescribeFleetHistoryResult$LastEvaluatedTime": "The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more results, this value is not present.
The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more items, this value is not present.
The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", "DescribeSpotFleetRequestHistoryRequest$StartTime": "The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", - "DescribeSpotFleetRequestHistoryResponse$LastEvaluatedTime": "The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more results, this value is not present.
The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more items, this value is not present.
The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", "DescribeSpotPriceHistoryRequest$EndTime": "The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", "DescribeSpotPriceHistoryRequest$StartTime": "The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", @@ -6087,7 +6088,7 @@ "DescribeFastLaunchImagesRequestMaxResults": { "base": null, "refs": { - "DescribeFastLaunchImagesRequest$MaxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. If this parameter is not specified, then all results are returned.
" + "DescribeFastLaunchImagesRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeFastLaunchImagesResult": { @@ -6340,7 +6341,7 @@ "DescribeInstanceCreditSpecificationsMaxResults": { "base": null, "refs": { - "DescribeInstanceCreditSpecificationsRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call. For more information, see Pagination.
" + "DescribeInstanceCreditSpecificationsRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same call.
" } }, "DescribeInstanceCreditSpecificationsRequest": { @@ -6970,7 +6971,7 @@ "DescribeSpotFleetInstancesMaxResults": { "base": null, "refs": { - "DescribeSpotFleetInstancesRequest$MaxResults": "The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeSpotFleetInstancesRequest": { @@ -6986,7 +6987,7 @@ "DescribeSpotFleetRequestHistoryMaxResults": { "base": null, "refs": { - "DescribeSpotFleetRequestHistoryRequest$MaxResults": "The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeSpotFleetRequestHistoryRequest": { @@ -7059,7 +7060,7 @@ "DescribeStoreImageTasksRequestMaxResults": { "base": null, "refs": { - "DescribeStoreImageTasksRequest$MaxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200. You cannot specify this parameter and the ImageIDs parameter in the same call.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the ImageIDs parameter in the same call.
Information about the egress-only internet gateways.
" } }, + "EipAllocationPublicIp": { + "base": null, + "refs": { + "AssociateAddressRequest$PublicIp": "[EC2-Classic] The Elastic IP address to associate with the instance. This is required for EC2-Classic.
", + "DisassociateAddressRequest$PublicIp": "[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
" + } + }, "EipAssociationIdList": { "base": null, "refs": { @@ -8852,7 +8860,7 @@ "refs": { "DescribeFastLaunchImagesSuccessItem$SnapshotConfiguration": "A group of parameters that are used for pre-provisioning the associated Windows AMI using snapshots.
", "DisableFastLaunchResult$SnapshotConfiguration": "Parameters that were used for faster launching for the Windows AMI before faster launching was turned off. This informs the clean-up process.
", - "EnableFastLaunchResult$SnapshotConfiguration": "The configuration settings that were defined for creating and managing the pre-provisioned snapshots for faster launching of the Windows AMI. This property is returned when the associated resourceType is snapshot.
Settings to create and manage the pre-provisioned snapshots that Amazon EC2 uses for faster launches from the Windows AMI. This property is returned when the associated resourceType is snapshot.
Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.
Default: on
Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.
", "Host$HostMaintenance": "Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
", "ModifyHostsRequest$HostMaintenance": "Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.
" } @@ -11243,8 +11251,8 @@ "DescribeFleetsInstances$InstanceType": "The instance type.
", "DescribeReservedInstancesOfferingsRequest$InstanceType": "The instance type that the reservation will cover (for example, m1.small). For more information, see Instance types in the Amazon EC2 User Guide.
The instance type for which the Capacity Reservation reserves capacity.
", - "FleetLaunchTemplateOverrides$InstanceType": "The instance type.
If you specify InstanceType, you can't specify InstanceRequirements.
The instance type.
If you specify InstanceType, you can't specify InstanceRequirements.
The instance type.
mac1.metal is not supported as a launch template override.
If you specify InstanceType, you can't specify InstanceRequirements.
The instance type.
mac1.metal is not supported as a launch template override.
If you specify InstanceType, you can't specify InstanceRequirements.
The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.
", "Instance$InstanceType": "The instance type.
", "InstanceTypeInfo$InstanceType": "The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
", @@ -11404,20 +11412,20 @@ "CreateVolumeRequest$Throughput": "The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
", "DeleteNetworkAclEntryRequest$RuleNumber": "The rule number of the entry to delete.
", "DescribeElasticGpusResult$MaxResults": "The total number of items to return. If the total number of items available is more than the value specified in max-items then a Next-Token will be provided in the output that you can use to resume pagination.
", - "DescribeFastLaunchImagesSuccessItem$MaxParallelLaunches": "The maximum number of parallel instances that are launched for creating resources.
", - "DescribeFleetHistoryRequest$MaxResults": "The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows faster launching.
", + "DescribeFleetHistoryRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", + "DescribeFleetInstancesRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", + "DescribeFleetsRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", "DescribeFlowLogsRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", "DescribeHostReservationOfferingsRequest$MaxDuration": "This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.
", "DescribeHostReservationOfferingsRequest$MinDuration": "This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.
", "DescribeHostReservationsRequest$MaxResults": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
You cannot specify this parameter and the host IDs parameter in the same request.
", - "DescribeImagesRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", "DescribeImportImageTasksRequest$MaxResults": "The maximum number of results to return in a single call.
", "DescribeImportSnapshotTasksRequest$MaxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of items to return for this request. To retrieve the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call. For more information, see Pagination.
", - "DescribeInstancesRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same request. For more information, see Pagination.
", + "DescribeInstanceStatusRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same request.
", + "DescribeInstancesRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same request.
", "DescribeLaunchTemplateVersionsRequest$MaxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of instances to filter when searching for offerings.
Default: 20
", @@ -11426,9 +11434,9 @@ "DescribeScheduledInstanceAvailabilityRequest$MinSlotDurationInHours": "The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
", "DescribeScheduledInstancesRequest$MaxResults": "The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of snapshots to return for this request. This value can be between 5 and 1,000; if this value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, then the request returns all snapshots. You cannot specify this parameter and the snapshot IDs parameter in the same request. For more information, see Pagination.
", - "DescribeSpotFleetRequestsRequest$MaxResults": "The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", + "DescribeSpotInstanceRequestsRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", + "DescribeSpotPriceHistoryRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", "DescribeTagsRequest$MaxResults": "The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", "DescribeVolumeStatusRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1,000; if the value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.
", "DescribeVolumesModificationsRequest$MaxResults": "The maximum number of results (up to a limit of 500) to be returned in a paginated request. For more information, see Pagination.
", @@ -11439,12 +11447,12 @@ "DescribeVpcEndpointServicePermissionsRequest$MaxResults": "The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
", "DescribeVpcEndpointsRequest$MaxResults": "The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
", - "DisableFastLaunchResult$MaxParallelLaunches": "The maximum number of parallel instances to launch for creating resources.
", + "DisableFastLaunchResult$MaxParallelLaunches": "The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows faster launching.
", "EbsBlockDevice$Iops": "The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2 and gp3:1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
", - "EnableFastLaunchRequest$MaxParallelLaunches": "The maximum number of parallel instances to launch for creating resources. Value must be 6 or greater.
The maximum number of parallel instances to launch for creating resources.
", + "EnableFastLaunchRequest$MaxParallelLaunches": "The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows faster launching. Value must be 6 or greater.
The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows faster launching.
", "FastLaunchSnapshotConfigurationRequest$TargetResourceCount": "The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
", "FastLaunchSnapshotConfigurationResponse$TargetResourceCount": "The number of pre-provisioned snapshots requested to keep on hand for a fast-launch enabled Windows AMI.
", "FleetCapacityReservation$TotalInstanceCount": "The total number of instances for which the Capacity Reservation reserves capacity.
", @@ -11454,7 +11462,7 @@ "GetAwsNetworkPerformanceDataRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The number of instances for which the Capacity Reservation reserves capacity.
", "GetCapacityReservationUsageResult$AvailableInstanceCount": "The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
", - "GetInstanceTypesFromInstanceRequirementsRequest$MaxResults": "The maximum number of results to return in a single call. Specify a value between 1 and
1000. The default value is 1000. To retrieve the remaining results, make another call with
the returned NextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", "HostOffering$Duration": "The duration of the offering (in seconds).
", "HostProperties$Cores": "The number of cores on the Dedicated Host.
", "HostProperties$Sockets": "The number of sockets on the Dedicated Host.
", @@ -13067,7 +13075,7 @@ "ListImagesInRecycleBinMaxResults": { "base": null, "refs": { - "ListImagesInRecycleBinRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If you do not specify a value for MaxResults, the request returns 1,000 items per page by default. For more information, see Pagination.
" + "ListImagesInRecycleBinRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "ListImagesInRecycleBinRequest": { @@ -14921,8 +14929,8 @@ "DescribeClientVpnTargetNetworksResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
A token that indicates the next page of results.
", "DescribeExportImageTasksResult$NextToken": "The token to use to get the next page of results. This value is null when there are no more results to return.
The token for the next set of results.
", - "DescribeFastLaunchImagesResult$NextToken": "The token to use for the next set of results. This value is null when there are no more results to return.
", + "DescribeFastLaunchImagesRequest$NextToken": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeFastLaunchImagesResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "DescribeFastSnapshotRestoresResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token to retrieve the next page of results.
", @@ -17338,10 +17346,10 @@ "base": null, "refs": { "KeyPair$KeyMaterial": "An unencrypted PEM encoded RSA or ED25519 private key.
", - "LaunchSpecification$UserData": "The Base64-encoded user data for the instance.
", - "RequestSpotLaunchSpecification$UserData": "The Base64-encoded user data for the instance. User data is limited to 16 KB.
", + "LaunchSpecification$UserData": "The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
", + "RequestSpotLaunchSpecification$UserData": "The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
", "ResponseLaunchTemplateData$UserData": "The user data for the instance.
", - "SpotFleetLaunchSpecification$UserData": "The Base64-encoded user data that instances use when starting up.
" + "SpotFleetLaunchSpecification$UserData": "The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
" } }, "ServiceConfiguration": { @@ -17725,7 +17733,7 @@ "SpotPlacementScoresMaxResults": { "base": null, "refs": { - "GetSpotPlacementScoresRequest$MaxResults": "The maximum number of results to return in a single call. Specify a value between 1 and
1000. The default value is 1000. To retrieve the remaining results, make another call with
the returned NextToken value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "SpotPlacementScoresTargetCapacity": { @@ -17996,7 +18004,6 @@ "AssignIpv6AddressesResult$NetworkInterfaceId": "The ID of the network interface.
", "AssignPrivateIpAddressesResult$NetworkInterfaceId": "The ID of the network interface.
", "AssignedPrivateIpAddress$PrivateIpAddress": "The private IP address assigned to the network interface.
", - "AssociateAddressRequest$PublicIp": "[EC2-Classic] The Elastic IP address to associate with the instance. This is required for EC2-Classic.
", "AssociateAddressRequest$PrivateIpAddress": "[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
", "AssociateAddressResult$AssociationId": "[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.
", "AssociateClientVpnTargetNetworkRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", @@ -18381,7 +18388,7 @@ "DeleteVpnConnectionRouteRequest$DestinationCidrBlock": "The CIDR block associated with the local subnet of the customer network.
", "DeprovisionByoipCidrRequest$Cidr": "The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.
", "DeprovisionIpamPoolCidrRequest$Cidr": "The CIDR which you want to deprovision from the pool.
", - "DeprovisionPublicIpv4PoolCidrRequest$Cidr": "The CIDR you want to deprovision from the pool.
", + "DeprovisionPublicIpv4PoolCidrRequest$Cidr": "The CIDR you want to deprovision from the pool. Enter the CIDR you want to deprovision with a netmask of /32. You must rerun this command for each IP address in the CIDR range. If your CIDR is a /24, you will have to run this command to deprovision each of the 256 IP addresses in the /24 CIDR.
The IP address assigned to the transit gateway multicast group.
", "DeregisterTransitGatewayMulticastGroupSourcesRequest$GroupIpAddress": "The IP address assigned to the transit gateway multicast group.
", @@ -18415,12 +18422,12 @@ "DescribeFastSnapshotRestoreSuccessItem$OwnerAlias": "The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
", "DescribeFleetError$ErrorCode": "The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
", "DescribeFleetError$ErrorMessage": "The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.
", - "DescribeFleetHistoryRequest$NextToken": "The token for the next set of results.
", - "DescribeFleetHistoryResult$NextToken": "The token for the next set of results.
", - "DescribeFleetInstancesRequest$NextToken": "The token for the next set of results.
", - "DescribeFleetInstancesResult$NextToken": "The token for the next set of results.
", - "DescribeFleetsRequest$NextToken": "The token for the next set of results.
", - "DescribeFleetsResult$NextToken": "The token for the next set of results.
", + "DescribeFleetHistoryRequest$NextToken": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeFleetHistoryResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeFleetInstancesResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeFleetsResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token to request the next page of items. Pagination continues from the end of the items returned by the previous request.
", "DescribeFlowLogsResult$NextToken": "The token to request the next page of items. This value is null when there are no more items to return.
The token to use to retrieve the next page of results.
", @@ -18432,8 +18439,8 @@ "DescribeIdFormatRequest$Resource": "The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway
The ARN of the principal, which can be an IAM role, IAM user, or the root user.
", "DescribeIdentityIdFormatRequest$Resource": "The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway
The token for the next page of results.
", - "DescribeImagesResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeImagesResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
A token that indicates the next page of results.
", "DescribeImportImageTasksResult$NextToken": "The token to use to get the next page of results. This value is null when there are no more results to return.
A token that indicates the next page of results.
", @@ -18507,22 +18514,22 @@ "DescribeSnapshotTierStatusResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "DescribeSnapshotsResult$NextToken": "The token to include in another request to return the next page of snapshots. This value is null when there are no more snapshots to return.
The token for the next set of results.
", - "DescribeSpotFleetInstancesResponse$NextToken": "The token required to retrieve the next set of results. This value is null when there are no more results to return.
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The ID of the Spot Fleet request.
", - "DescribeSpotFleetRequestHistoryRequest$NextToken": "The token for the next set of results.
", - "DescribeSpotFleetRequestHistoryResponse$NextToken": "The token required to retrieve the next set of results. This value is null when there are no more results to return.
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The ID of the Spot Fleet request.
", - "DescribeSpotFleetRequestsRequest$NextToken": "The token for the next set of results.
", - "DescribeSpotFleetRequestsResponse$NextToken": "The token required to retrieve the next set of results. This value is null when there are no more results to return.
The token to request the next set of results. This value is null when there are no more results to return.
The token to use to retrieve the next set of results. This value is null when there are no more results to return.
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeSpotInstanceRequestsResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
Filters the results by the specified Availability Zone.
", - "DescribeSpotPriceHistoryRequest$NextToken": "The token for the next set of results.
", - "DescribeSpotPriceHistoryResult$NextToken": "The token required to retrieve the next set of results. This value is null or an empty string when there are no more results to return.
", + "DescribeSpotPriceHistoryRequest$NextToken": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeSpotPriceHistoryResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token to include in another request to get the next page of items. If there are no additional items to return, the string is empty.
", - "DescribeStoreImageTasksRequest$NextToken": "The token for the next page of results.
", - "DescribeStoreImageTasksResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeStoreImageTasksResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "DescribeSubnetsResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", @@ -18598,7 +18605,6 @@ "DisableFastSnapshotRestoreSuccessItem$OwnerId": "The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.
", "DisableFastSnapshotRestoreSuccessItem$OwnerAlias": "The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
", "DisableIpamOrganizationAdminAccountRequest$DelegatedAdminAccountId": "The Organizations member account ID that you want to disable as IPAM account.
", - "DisassociateAddressRequest$PublicIp": "[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
", "DisassociateClientVpnTargetNetworkResult$AssociationId": "The ID of the target network association.
", "DisassociateSubnetCidrBlockResult$SubnetId": "The ID of the subnet.
", "DisassociateTrunkInterfaceRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
", @@ -18747,8 +18753,8 @@ "GetGroupsForCapacityReservationResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The potential total hourly price of the reservation per hour.
", "GetHostReservationPurchasePreviewResult$TotalUpfrontPrice": "The potential total upfront price. This is billed immediately.
", - "GetInstanceTypesFromInstanceRequirementsRequest$NextToken": "The token for the next set of results.
", - "GetInstanceTypesFromInstanceRequirementsResult$NextToken": "The token for the next set of results.
", + "GetInstanceTypesFromInstanceRequirementsRequest$NextToken": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "GetInstanceTypesFromInstanceRequirementsResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
Base64 representation of the non-volatile UEFI variable store.
", "GetIpamAddressHistoryRequest$Cidr": "The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.
", "GetIpamAddressHistoryRequest$VpcId": "The ID of the VPC you want your history records filtered by.
", @@ -18763,8 +18769,8 @@ "GetReservedInstancesExchangeQuoteResult$CurrencyCode": "The currency of the transaction.
", "GetReservedInstancesExchangeQuoteResult$PaymentDue": "The total true upfront charge for the exchange.
", "GetReservedInstancesExchangeQuoteResult$ValidationFailureReason": "Describes the reason why the exchange cannot be completed.
", - "GetSpotPlacementScoresRequest$NextToken": "The token for the next set of results.
", - "GetSpotPlacementScoresResult$NextToken": "The token for the next set of results.
", + "GetSpotPlacementScoresRequest$NextToken": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "GetSpotPlacementScoresResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token for the next page of results.
", "GetSubnetCidrReservationsResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token for the next page of results.
", @@ -19096,8 +19102,8 @@ "LaunchTemplateVersion$CreatedBy": "The principal that created the version.
", "LicenseConfiguration$LicenseConfigurationArn": "The Amazon Resource Name (ARN) of the license configuration.
", "LicenseConfigurationRequest$LicenseConfigurationArn": "The Amazon Resource Name (ARN) of the license configuration.
", - "ListImagesInRecycleBinRequest$NextToken": "The token for the next page of results.
", - "ListImagesInRecycleBinResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "ListImagesInRecycleBinResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "ListSnapshotsInRecycleBinResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The Amazon Web Services account ID.
", @@ -19145,8 +19151,8 @@ "ModifyIdFormatRequest$Resource": "The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.
The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
The name of the attribute to modify.
Valid values: description | launchPermission
The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description.
The name of the attribute to modify.
Valid values: description | imdsSupport | launchPermission
The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or imdsSupport.
A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "ModifyInstanceEventStartTimeRequest$InstanceEventId": "The ID of the event whose date and time you are modifying.
", diff --git a/models/apis/ec2/2016-11-15/endpoint-tests-1.json b/models/apis/ec2/2016-11-15/endpoint-tests-1.json index 106bd24fd7b..f438a23ab83 100644 --- a/models/apis/ec2/2016-11-15/endpoint-tests-1.json +++ b/models/apis/ec2/2016-11-15/endpoint-tests-1.json @@ -8,9 +8,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "af-south-1", "UseFIPS": false, - "Region": "af-south-1" + "UseDualStack": false } }, { @@ -21,9 +21,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-east-1", "UseFIPS": false, - "Region": "ap-east-1" + "UseDualStack": false } }, { @@ -34,9 +34,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-northeast-1", "UseFIPS": false, - "Region": "ap-northeast-1" + "UseDualStack": false } }, { @@ -47,9 +47,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-northeast-2", "UseFIPS": false, - "Region": "ap-northeast-2" + "UseDualStack": false } }, { @@ -60,9 +60,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-northeast-3", "UseFIPS": false, - "Region": "ap-northeast-3" + "UseDualStack": false } }, { @@ -73,9 +73,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-south-1", "UseFIPS": false, - "Region": "ap-south-1" + "UseDualStack": false } }, { @@ -86,9 +86,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "ap-south-1", "UseFIPS": false, - "Region": "ap-south-1" + "UseDualStack": true } }, { @@ -99,9 +99,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-southeast-1", "UseFIPS": false, - "Region": "ap-southeast-1" + "UseDualStack": false } }, { @@ -112,9 +112,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-southeast-2", "UseFIPS": false, - "Region": "ap-southeast-2" + "UseDualStack": false } }, { @@ -125,9 +125,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-southeast-3", "UseFIPS": false, - "Region": "ap-southeast-3" + "UseDualStack": false } }, { @@ -138,9 +138,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ca-central-1", "UseFIPS": false, - "Region": "ca-central-1" + "UseDualStack": false } }, { @@ -151,9 +151,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ca-central-1", "UseFIPS": true, - "Region": "ca-central-1" + "UseDualStack": false } }, { @@ -164,9 +164,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-central-1", "UseFIPS": false, - "Region": "eu-central-1" + "UseDualStack": false } }, { @@ -177,9 +177,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-north-1", "UseFIPS": false, - "Region": "eu-north-1" + "UseDualStack": false } }, { @@ -190,9 +190,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-south-1", "UseFIPS": false, - "Region": "eu-south-1" + "UseDualStack": false } }, { @@ -203,9 +203,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-west-1", "UseFIPS": false, - "Region": "eu-west-1" + "UseDualStack": false } }, { @@ -216,9 +216,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "eu-west-1", "UseFIPS": false, - "Region": "eu-west-1" + "UseDualStack": true } }, { @@ -229,9 +229,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-west-2", "UseFIPS": false, - "Region": "eu-west-2" + "UseDualStack": false } }, { @@ -242,9 +242,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-west-3", "UseFIPS": false, - "Region": "eu-west-3" + "UseDualStack": false } }, { @@ -255,9 +255,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "me-south-1", "UseFIPS": false, - "Region": "me-south-1" + "UseDualStack": false } }, { @@ -268,9 +268,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "sa-east-1", "UseFIPS": false, - "Region": "sa-east-1" + "UseDualStack": false } }, { @@ -281,9 +281,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "sa-east-1", "UseFIPS": false, - "Region": "sa-east-1" + "UseDualStack": true } }, { @@ -294,9 +294,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, - "Region": "us-east-1" + "UseDualStack": false } }, { @@ -307,9 +307,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": true, - "Region": "us-east-1" + "UseDualStack": false } }, { @@ -320,9 +320,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": false, - "Region": "us-east-1" + "UseDualStack": true } }, { @@ -333,9 +333,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-2", "UseFIPS": false, - "Region": "us-east-2" + "UseDualStack": false } }, { @@ -346,9 +346,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-2", "UseFIPS": true, - "Region": "us-east-2" + "UseDualStack": false } }, { @@ -359,9 +359,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-east-2", "UseFIPS": false, - "Region": "us-east-2" + "UseDualStack": true } }, { @@ -372,9 +372,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-1", "UseFIPS": false, - "Region": "us-west-1" + "UseDualStack": false } }, { @@ -385,9 +385,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-1", "UseFIPS": true, - "Region": "us-west-1" + "UseDualStack": false } }, { @@ -398,9 +398,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": false, - "Region": "us-west-2" + "UseDualStack": false } }, { @@ -411,9 +411,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": true, - "Region": "us-west-2" + "UseDualStack": false } }, { @@ -424,9 +424,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-west-2", "UseFIPS": false, - "Region": "us-west-2" + "UseDualStack": true } }, { @@ -437,9 +437,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": true, - "Region": "us-east-1" + "UseDualStack": true } }, { @@ -450,9 +450,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": false, - "Region": "cn-north-1" + "UseDualStack": false } }, { @@ -463,9 +463,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "cn-northwest-1", "UseFIPS": false, - "Region": "cn-northwest-1" + "UseDualStack": false } }, { @@ -476,9 +476,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": true, - "Region": "cn-north-1" + "UseDualStack": true } }, { @@ -489,9 +489,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": true, - "Region": "cn-north-1" + "UseDualStack": false } }, { @@ -502,9 +502,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": false, - "Region": "cn-north-1" + "UseDualStack": true } }, { @@ -515,9 +515,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": false, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { @@ -528,9 +528,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-gov-west-1", "UseFIPS": false, - "Region": "us-gov-west-1" + "UseDualStack": false } }, { @@ -541,9 +541,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": true, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { @@ -554,9 +554,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": true, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { @@ -567,9 +567,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": false, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { @@ -580,9 +580,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": false, - "Region": "us-iso-east-1" + "UseDualStack": false } }, { @@ -593,9 +593,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-iso-west-1", "UseFIPS": false, - "Region": "us-iso-west-1" + "UseDualStack": false } }, { @@ -606,9 +606,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": true, - "Region": "us-iso-east-1" + "UseDualStack": false } }, { @@ -619,9 +619,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": false, - "Region": "us-isob-east-1" + "UseDualStack": false } }, { @@ -632,9 +632,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": true, - "Region": "us-isob-east-1" + "UseDualStack": false } }, { @@ -645,9 +645,9 @@ } }, "params": { - "UseDualStack": false, - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -659,8 +659,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -670,9 +670,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, - "UseFIPS": true, "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -682,9 +682,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } } diff --git a/models/apis/kms/2014-11-01/docs-2.json b/models/apis/kms/2014-11-01/docs-2.json index 9c2666a216c..2cf2d45140c 100644 --- a/models/apis/kms/2014-11-01/docs-2.json +++ b/models/apis/kms/2014-11-01/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "Key Management Service (KMS) is an encryption and key management web service. This guide describes the KMS operations that you can call programmatically. For general information about KMS, see the Key Management Service Developer Guide .
KMS has replaced the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to KMS and other Amazon Web Services services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.
If you need to use FIPS 140-2 validated cryptographic modules when communicating with Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the available FIPS endpoints, see Service endpoints in the Key Management Service topic of the Amazon Web Services General Reference.
All KMS API calls must be signed and be transmitted using Transport Layer Security (TLS). KMS recommends you always use the latest supported TLS version. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.
Signing Requests
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your Amazon Web Services account (root) access key ID and secret access key for everyday work with KMS. Instead, use the access key ID and secret access key for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary security credentials that you can use to sign requests.
All KMS operations require Signature Version 4.
Logging API Requests
KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
Amazon Web Services Security Credentials - This topic provides general information about the types of credentials used to access Amazon Web Services.
Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.
Signature Version 4 Signing Process - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.
Commonly Used API Operations
Of the API operations discussed in this guide, the following will prove the most useful for most applications. You will likely perform operations other than these, such as creating keys and assigning policies, by using the console.
", + "service": "Key Management Service (KMS) is an encryption and key management web service. This guide describes the KMS operations that you can call programmatically. For general information about KMS, see the Key Management Service Developer Guide .
KMS has replaced the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to KMS and other Amazon Web Services services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.
If you need to use FIPS 140-2 validated cryptographic modules when communicating with Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the available FIPS endpoints, see Service endpoints in the Key Management Service topic of the Amazon Web Services General Reference.
All KMS API calls must be signed and be transmitted using Transport Layer Security (TLS). KMS recommends you always use the latest supported TLS version. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.
Signing Requests
Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your Amazon Web Services account root access key ID and secret access key for everyday work. You can use the access key ID and secret access key for an IAM user or you can use the Security Token Service (STS) to generate temporary security credentials and use those to sign requests.
All KMS requests must be signed with Signature Version 4.
Logging API Requests
KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
Amazon Web Services Security Credentials - This topic provides general information about the types of credentials used to access Amazon Web Services.
Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.
Signature Version 4 Signing Process - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.
Commonly Used API Operations
Of the API operations discussed in this guide, the following will prove the most useful for most applications. You will likely perform operations other than these, such as creating keys and assigning policies, by using the console.
", "operations": { "CancelKeyDeletion": "Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS key is Disabled. To enable the KMS key, use EnableKey.
For more information about scheduling and canceling deletion of a KMS key, see Deleting KMS keys in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:CancelKeyDeletion (key policy)
Related operations: ScheduleKeyDeletion
", "ConnectCustomKeyStore": "Connects or reconnects a custom key store to its backing key store. For an CloudHSM key store, ConnectCustomKeyStore connects the key store to its associated CloudHSM cluster. For an external key store, ConnectCustomKeyStore connects the key store to the external key store proxy that communicates with your external key manager.
The custom key store must be connected before you can create KMS keys in the key store or use the KMS keys it contains. You can disconnect and reconnect a custom key store at any time.
The connection process for a custom key store can take an extended amount of time to complete. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.
This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.
The ConnectCustomKeyStore operation might fail for various reasons. To find the reason, use the DescribeCustomKeyStores operation and see the ConnectionErrorCode in the response. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.
To fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use ConnectCustomKeyStore again.
CloudHSM key store
During the connection process for an CloudHSM key store, KMS finds the CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the CloudHSM client as the kmsuser CU, and rotates its password.
To connect an CloudHSM key store, its associated CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs to the cluster, use the CreateHsm operation. Also, the kmsuser crypto user (CU) must not be logged into the cluster. This prevents KMS from using this account to log in.
If you are having trouble connecting or disconnecting a CloudHSM key store, see Troubleshooting an CloudHSM key store in the Key Management Service Developer Guide.
External key store
When you connect an external key store that uses public endpoint connectivity, KMS tests its ability to communicate with your external key manager by sending a request via the external key store proxy.
When you connect to an external key store that uses VPC endpoint service connectivity, KMS establishes the networking elements that it needs to communicate with your external key manager via the external key store proxy. This includes creating an interface endpoint to the VPC endpoint service and a private hosted zone for traffic between KMS and the VPC endpoint service.
To connect an external key store, KMS must be able to connect to the external key store proxy, the external key store proxy must be able to communicate with your external key manager, and the external key manager must be available for cryptographic operations.
If you are having trouble connecting or disconnecting an external key store, see Troubleshooting an external key store in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.
Required permissions: kms:ConnectCustomKeyStore (IAM policy)
Related operations
Creates a custom key store backed by a key store that you own and manage. When you use a KMS key in a custom key store for a cryptographic operation, the cryptographic operation is actually performed in your key store using your keys. KMS supports CloudHSM key stores backed by an CloudHSM cluster and external key stores backed by an external key store proxy and external key manager outside of Amazon Web Services.
This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.
Before you create the custom key store, the required elements must be in place and operational. We recommend that you use the test tools that KMS provides to verify the configuration your external key store proxy. For details about the required elements and verification tests, see Assemble the prerequisites (for CloudHSM key stores) or Assemble the prerequisites (for external key stores) in the Key Management Service Developer Guide.
To create a custom key store, use the following parameters.
To create an CloudHSM key store, specify the CustomKeyStoreName, CloudHsmClusterId, KeyStorePassword, and TrustAnchorCertificate. The CustomKeyStoreType parameter is optional for CloudHSM key stores. If you include it, set it to the default value, AWS_CLOUDHSM. For help with failures, see Troubleshooting an CloudHSM key store in the Key Management Service Developer Guide.
To create an external key store, specify the CustomKeyStoreName and a CustomKeyStoreType of EXTERNAL_KEY_STORE. Also, specify values for XksProxyConnectivity, XksProxyAuthenticationCredential, XksProxyUriEndpoint, and XksProxyUriPath. If your XksProxyConnectivity value is VPC_ENDPOINT_SERVICE, specify the XksProxyVpcEndpointServiceName parameter. For help with failures, see Troubleshooting an external key store in the Key Management Service Developer Guide.
For external key stores:
Some external key managers provide a simpler method for creating an external key store. For details, see your external key manager documentation.
When creating an external key store in the KMS console, you can upload a JSON-based proxy configuration file with the desired values. You cannot use a proxy configuration with the CreateCustomKeyStore operation. However, you can use the values in the file to help you determine the correct values for the CreateCustomKeyStore parameters.
When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect a new CloudHSM key store to its CloudHSM cluster, or to connect a new external key store to the external key store proxy for your external key manager. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.
For help with failures, see Troubleshooting a custom key store in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.
Required permissions: kms:CreateCustomKeyStore (IAM policy).
Related operations:
Adds a grant to a KMS key.
A grant is a policy instrument that allows Amazon Web Services principals to use KMS keys in cryptographic operations. It also can allow them to view a KMS key (DescribeKey) and create and manage grants. When authorizing access to a KMS key, grants are considered along with key policies and IAM policies. Grants are often used for temporary permissions because you can create one, use its permissions, and delete it without changing your key policies or IAM policies.
For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of working with grants in several programming languages, see Programming grants.
The CreateGrant operation returns a GrantToken and a GrantId.
When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. Once the grant has achieved eventual consistency, the grantee principal can use the permissions in the grant without identifying the grant.
However, to use the permissions in the grant immediately, use the GrantToken that CreateGrant returns. For details, see Using a grant token in the Key Management Service Developer Guide .
The CreateGrant operation also returns a GrantId. You can use the GrantId and a key identifier to identify the grant in the RetireGrant and RevokeGrant operations. To find the grant ID, use the ListGrants or ListRetirableGrants operations.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.
Required permissions: kms:CreateGrant (key policy)
Related operations:
", "CreateKey": "Creates a unique customer managed KMS key in your Amazon Web Services account and Region. You can use a KMS key in cryptographic operations, such as encryption and signing. Some Amazon Web Services services let you use KMS keys that you create and manage to protect your service resources.
A KMS key is a logical representation of a cryptographic key. In addition to the key material used in cryptographic operations, a KMS key includes metadata, such as the key ID, key policy, creation date, description, and key state. For details, see Managing keys in the Key Management Service Developer Guide
Use the parameters of CreateKey to specify the type of KMS key, the source of its key material, its key policy, description, tags, and other properties.
KMS has replaced the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
To create different types of KMS keys, use the following guidance:
By default, CreateKey creates a symmetric encryption KMS key with key material that KMS generates. This is the basic and most widely used type of KMS key, and provides the best performance.
To create a symmetric encryption KMS key, you don't need to specify any parameters. The default value for KeySpec, SYMMETRIC_DEFAULT, the default value for KeyUsage, ENCRYPT_DECRYPT, and the default value for Origin, AWS_KMS, create a symmetric encryption KMS key with KMS key material.
If you need a key for basic encryption and decryption or you are creating a KMS key to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key. The key material in a symmetric encryption key never leaves KMS unencrypted. You can use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair.
To create an asymmetric KMS key, use the KeySpec parameter to specify the type of key material in the KMS key. Then, use the KeyUsage parameter to determine whether the KMS key will be used to encrypt and decrypt or sign and verify. You can't change these properties after the KMS key is created.
Asymmetric KMS keys contain an RSA key pair, Elliptic Curve (ECC) key pair, or an SM2 key pair (China Regions only). The private key in an asymmetric KMS key never leaves KMS unencrypted. However, you can use the GetPublicKey operation to download the public key so it can be used outside of KMS. KMS keys with RSA or SM2 key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). KMS keys with ECC key pairs can be used only to sign and verify messages. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
To create an HMAC KMS key, set the KeySpec parameter to a key spec value for HMAC KMS keys. Then set the KeyUsage parameter to GENERATE_VERIFY_MAC. You must set the key usage even though GENERATE_VERIFY_MAC is the only valid key usage value for HMAC KMS keys. You can't change these properties after the KMS key is created.
HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use HMAC keys to generate (GenerateMac) and verify (VerifyMac) HMAC codes for messages up to 4096 bytes.
HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to create an HMAC KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the CreateKey operation returns an UnsupportedOperationException. For a list of Regions in which HMAC KMS keys are supported, see HMAC keys in KMS in the Key Management Service Developer Guide.
To create a multi-Region primary key in the local Amazon Web Services Region, use the MultiRegion parameter with a value of True. To create a multi-Region replica key, that is, a KMS key with the same key ID and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its primary key to a replica key, use the UpdatePrimaryRegion operation.
You can create multi-Region KMS keys for all supported KMS key types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric signing KMS keys. You can also create multi-Region keys with imported key material. However, you can't create multi-Region keys in a custom key store.
This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
To import your own key material into a KMS key, begin by creating a symmetric encryption KMS key with no key material. To do this, use the Origin parameter of CreateKey with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For step-by-step instructions, see Importing Key Material in the Key Management Service Developer Guide .
This feature supports only symmetric encryption KMS keys, including multi-Region symmetric encryption KMS keys. You cannot import key material into any other type of KMS key.
To create a multi-Region primary key with imported key material, use the Origin parameter of CreateKey with a value of EXTERNAL and the MultiRegion parameter with a value of True. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For instructions, see Importing key material into multi-Region keys. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
A custom key store lets you protect your Amazon Web Services resources using keys in a backing key store that you own and manage. When you request a cryptographic operation with a KMS key in a custom key store, the operation is performed in the backing key store using its cryptographic keys.
KMS supports CloudHSM key stores backed by an CloudHSM cluster and external key stores backed by an external key manager outside of Amazon Web Services. When you create a KMS key in an CloudHSM key store, KMS generates an encryption key in the CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key store, you specify an existing encryption key in the external key manager.
Some external key managers provide a simpler method for creating a KMS key in an external key store. For details, see your external key manager documentation.
Before you create a KMS key in a custom key store, the ConnectionState of the key store must be CONNECTED. To connect the custom key store, use the ConnectCustomKeyStore operation. To find the ConnectionState, use the DescribeCustomKeyStores operation.
To create a KMS key in a custom key store, use the CustomKeyStoreId. Use the default KeySpec value, SYMMETRIC_DEFAULT, and the default KeyUsage value, ENCRYPT_DECRYPT to create a symmetric encryption key. No other key type is supported in a custom key store.
To create a KMS key in an CloudHSM key store, use the Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the Amazon Web Services Region.
To create a KMS key in an external key store, use the Origin parameter with a value of EXTERNAL_KEY_STORE and an XksKeyId parameter that identifies an existing external key.
Some external key managers provide a simpler method for creating a KMS key in an external key store. For details, see your external key manager documentation.
Cross-account use: No. You cannot use this operation to create a KMS key in a different Amazon Web Services account.
Required permissions: kms:CreateKey (IAM policy). To use the Tags parameter, kms:TagResource (IAM policy). For examples and information about related permissions, see Allow a user to create KMS keys in the Key Management Service Developer Guide.
Related operations:
", - "Decrypt": "Decrypts ciphertext that was encrypted by a KMS key using any of the following operations:
You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS.
If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the KMS key is always recommended as a best practice. When you use the KeyId parameter to specify a KMS key, KMS only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the Decrypt operation fails. This practice ensures that you use the KMS key that you intend.
Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular KMS key, instead of using IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular KMS keys or particular trusted accounts. For details, see Best practices for IAM policies in the Key Management Service Developer Guide.
Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Required permissions: kms:Decrypt (key policy)
Related operations:
", + "Decrypt": "Decrypts ciphertext that was encrypted by a KMS key using any of the following operations:
You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS.
If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the KMS key is always recommended as a best practice. When you use the KeyId parameter to specify a KMS key, KMS only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the Decrypt operation fails. This practice ensures that you use the KMS key that you intend.
Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular KMS key, instead of using &IAM; policies. Otherwise, you might create an &IAM; policy that gives the user Decrypt permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular KMS keys or particular trusted accounts. For details, see Best practices for IAM policies in the Key Management Service Developer Guide.
Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. If you use the KeyId parameter to identify a KMS key in a different Amazon Web Services account, specify the key ARN or the alias ARN of the KMS key.
Required permissions: kms:Decrypt (key policy)
Related operations:
", "DeleteAlias": "Deletes the specified alias.
Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.
Because an alias is not a property of a KMS key, you can delete and change the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all KMS keys, use the ListAliases operation.
Each KMS key can have multiple aliases. To change the alias of a KMS key, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different KMS key, call UpdateAlias.
Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.
Required permissions
kms:DeleteAlias on the alias (IAM policy).
kms:DeleteAlias on the KMS key (key policy).
For details, see Controlling access to aliases in the Key Management Service Developer Guide.
Related operations:
", "DeleteCustomKeyStore": "Deletes a custom key store. This operation does not affect any backing elements of the custom key store. It does not delete the CloudHSM cluster that is associated with an CloudHSM key store, or affect any users or keys in the cluster. For an external key store, it does not affect the external key store proxy, external key manager, or any external keys.
This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.
The custom key store that you delete cannot contain any KMS keys. Before deleting the key store, verify that you will never need to use any of the KMS keys in the key store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the KMS keys from the key store. After the required waiting period expires and all KMS keys are deleted from the custom key store, use DisconnectCustomKeyStore to disconnect the key store from KMS. Then, you can delete the custom key store.
For keys in an CloudHSM key store, the ScheduleKeyDeletion operation makes a best effort to delete the key material from the associated cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. KMS never creates, manages, or deletes cryptographic keys in the external key manager associated with an external key store. You must manage them using your external key manager tools.
Instead of deleting the custom key store, consider using the DisconnectCustomKeyStore operation to disconnect the custom key store from its backing key store. While the key store is disconnected, you cannot create or use the KMS keys in the key store. But, you do not need to delete KMS keys and you can reconnect a disconnected custom key store at any time.
If the operation succeeds, it returns a JSON object with no properties.
Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.
Required permissions: kms:DeleteCustomKeyStore (IAM policy)
Related operations:
Deletes key material that you previously imported. This operation makes the specified KMS key unusable. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide.
When the specified KMS key is in the PendingDeletion state, this operation does not change the KMS key's state. Otherwise, it changes the KMS key's state to PendingImport.
After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the KMS key.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:DeleteImportedKeyMaterial (key policy)
Related operations:
", @@ -20,7 +20,7 @@ "EnableKey": "Sets the key state of a KMS key to enabled. This allows you to use the KMS key for cryptographic operations.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:EnableKey (key policy)
Related operations: DisableKey
", "EnableKeyRotation": "Enables automatic rotation of the key material of the specified symmetric encryption KMS key.
When you enable automatic rotation of acustomer managed KMS key, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use the DisableKeyRotation operation.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You cannot enable or disable automatic rotation Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys varies.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years (approximately 1,095 days) to every year (approximately 365 days).
New Amazon Web Services managed keys are automatically rotated one year after they are created, and approximately every year thereafter.
Existing Amazon Web Services managed keys are automatically rotated one year after their most recent rotation, and every year thereafter.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:EnableKeyRotation (key policy)
Related operations:
", "Encrypt": "Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric or asymmetric KMS key with a KeyUsage of ENCRYPT_DECRYPT.
You can use this operation to encrypt small amounts of arbitrary data, such as a personal identifier or database password, or other sensitive information. You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a plaintext data key and an encrypted copy of that data key.
If you use a symmetric encryption KMS key, you can use an encryption context to add additional security to your encryption operation. If you specify an EncryptionContext when encrypting data, you must specify the same encryption context (a case-sensitive exact match) when decrypting the data. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide.
If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The algorithm must be compatible with the KMS key spec.
When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.
You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.
The maximum size of the data that you can encrypt varies with the type of KMS key and the encryption algorithm that you choose.
Symmetric encryption KMS keys
SYMMETRIC_DEFAULT: 4096 bytes
RSA_2048
RSAES_OAEP_SHA_1: 214 bytes
RSAES_OAEP_SHA_256: 190 bytes
RSA_3072
RSAES_OAEP_SHA_1: 342 bytes
RSAES_OAEP_SHA_256: 318 bytes
RSA_4096
RSAES_OAEP_SHA_1: 470 bytes
RSAES_OAEP_SHA_256: 446 bytes
SM2PKE: 1024 bytes (China Regions only)
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Required permissions: kms:Encrypt (key policy)
Related operations:
", - "GenerateDataKey": "Returns a unique symmetric data key for use outside of KMS. This operation returns a plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the plaintext key are random; they are not related to the caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data.
To generate a data key, specify the symmetric encryption KMS key that will be used to encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the type of your KMS key, use the DescribeKey operation.
You must also specify the length of the data key. Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter.
To generate an SM4 data key (China Regions only), specify a KeySpec value of AES_128 or NumberOfBytes value of 128. The symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption key.
To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom.
You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide.
Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
How to use your data key
We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the Amazon Web Services Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side encryption to do these tasks for you.
To encrypt data outside of KMS:
Use the GenerateDataKey operation to get a data key.
Use the plaintext data key (in the Plaintext field of the response) to encrypt your data outside of KMS. Then erase the plaintext data key from memory.
Store the encrypted data key (in the CiphertextBlob field of the response) with the encrypted data.
To decrypt data outside of KMS:
Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.
Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext data key from memory.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Required permissions: kms:GenerateDataKey (key policy)
Related operations:
Returns a unique symmetric data key for use outside of KMS. This operation returns a plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the plaintext key are random; they are not related to the caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data.
To generate a data key, specify the symmetric encryption KMS key that will be used to encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the type of your KMS key, use the DescribeKey operation.
You must also specify the length of the data key. Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter.
To generate a 128-bit SM4 data key (China Regions only), specify a KeySpec value of AES_128 or a NumberOfBytes value of 16. The symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption key.
To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom.
You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide.
Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
How to use your data key
We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the Amazon Web Services Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side encryption to do these tasks for you.
To encrypt data outside of KMS:
Use the GenerateDataKey operation to get a data key.
Use the plaintext data key (in the Plaintext field of the response) to encrypt your data outside of KMS. Then erase the plaintext data key from memory.
Store the encrypted data key (in the CiphertextBlob field of the response) with the encrypted data.
To decrypt data outside of KMS:
Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.
Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext data key from memory.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Required permissions: kms:GenerateDataKey (key policy)
Related operations:
Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes in the keys are random; they not related to the caller or to the KMS key that is used to encrypt the private key.
You can use the public key that GenerateDataKeyPair returns to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.
To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.
Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that you use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or signing, but not both. However, KMS cannot enforce any restrictions on the use of data key pairs outside of KMS.
If you are using the data key pair to encrypt data, or for any operation where you don't immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation. GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the Decrypt operation to decrypt the encrypted private key in the data key pair.
GenerateDataKeyPair returns a unique data key pair for each request. The bytes in the keys are random; they are not related to the caller or the KMS key that is used to encrypt the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in RFC 5280. The private key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958.
You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Required permissions: kms:GenerateDataKeyPair (key policy)
Related operations:
", "GenerateDataKeyPairWithoutPlaintext": "Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric encryption KMS key you specify. Unlike GenerateDataKeyPair, this operation does not return a plaintext private key. The bytes in the keys are random; they are not related to the caller or to the KMS key that is used to encrypt the private key.
You can use the public key that GenerateDataKeyPairWithoutPlaintext returns to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.
To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.
Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that you use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or signing, but not both. However, KMS cannot enforce any restrictions on the use of data key pairs outside of KMS.
GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each request. The bytes in the key are not related to the caller or KMS key that is used to encrypt the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in RFC 5280.
You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key policy)
Related operations:
", "GenerateDataKeyWithoutPlaintext": "Returns a unique symmetric data key for use outside of KMS. This operation returns a data key that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the key are random; they are not related to the caller or to the KMS key.
GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that it does not return a plaintext copy of the data key.
This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the Decrypt operation on the encrypted copy of the key.
It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key.
To request an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations.
To generate a data key, you must specify the symmetric encryption KMS key that is used to encrypt the data key. You cannot use an asymmetric KMS key or a key in a custom key store to generate a data key. To get the type of your KMS key, use the DescribeKey operation.
You must also specify the length of the data key. Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter.
To generate an SM4 data key (China Regions only), specify a KeySpec value of AES_128 or NumberOfBytes value of 128. The symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption key.
If the operation succeeds, you will find the encrypted copy of the data key in the CiphertextBlob field.
You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Required permissions: kms:GenerateDataKeyWithoutPlaintext (key policy)
Related operations:
", @@ -50,7 +50,7 @@ "UpdateCustomKeyStore": "Changes the properties of a custom key store. You can use this operation to change the properties of an CloudHSM key store or an external key store.
Use the required CustomKeyStoreId parameter to identify the custom key store. Use the remaining optional parameters to change its properties. This operation does not return any property values. To verify the updated property values, use the DescribeCustomKeyStores operation.
This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.
When updating the properties of an external key store, verify that the updated settings connect your key store, via the external key store proxy, to the same external key manager as the previous settings, or to a backup or snapshot of the external key manager with the same cryptographic keys. If the updated connection settings fail, you can fix them and retry, although an extended delay might disrupt Amazon Web Services services. However, if KMS permanently loses its access to cryptographic keys, ciphertext encrypted under those keys is unrecoverable.
For external key stores:
Some external key managers provide a simpler method for updating an external key store. For details, see your external key manager documentation.
When updating an external key store in the KMS console, you can upload a JSON-based proxy configuration file with the desired values. You cannot upload the proxy configuration file to the UpdateCustomKeyStore operation. However, you can use the file to help you determine the correct values for the UpdateCustomKeyStore parameters.
For an CloudHSM key store, you can use this operation to change the custom key store friendly name (NewCustomKeyStoreName), to tell KMS about a change to the kmsuser crypto user password (KeyStorePassword), or to associate the custom key store with a different, but related, CloudHSM cluster (CloudHsmClusterId). To update any property of an CloudHSM key store, the ConnectionState of the CloudHSM key store must be DISCONNECTED.
For an external key store, you can use this operation to change the custom key store friendly name (NewCustomKeyStoreName), or to tell KMS about a change to the external key store proxy authentication credentials (XksProxyAuthenticationCredential), connection method (XksProxyConnectivity), external proxy endpoint (XksProxyUriEndpoint) and path (XksProxyUriPath). For external key stores with an XksProxyConnectivity of VPC_ENDPOINT_SERVICE, you can also update the Amazon VPC endpoint service name (XksProxyVpcEndpointServiceName). To update most properties of an external key store, the ConnectionState of the external key store must be DISCONNECTED. However, you can update the CustomKeyStoreName, XksProxyAuthenticationCredential, and XksProxyUriPath of an external key store when it is in the CONNECTED or DISCONNECTED state.
If your update requires a DISCONNECTED state, before using UpdateCustomKeyStore, use the DisconnectCustomKeyStore operation to disconnect the custom key store. After the UpdateCustomKeyStore operation completes, use the ConnectCustomKeyStore to reconnect the custom key store. To find the ConnectionState of the custom key store, use the DescribeCustomKeyStores operation.
Before updating the custom key store, verify that the new values allow KMS to connect the custom key store to its backing key store. For example, before you change the XksProxyUriPath value, verify that the external key store proxy is reachable at the new path.
If the operation succeeds, it returns a JSON object with no properties.
Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.
Required permissions: kms:UpdateCustomKeyStore (IAM policy)
Related operations:
Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:UpdateKeyDescription (key policy)
Related operations
", "UpdatePrimaryRegion": "Changes the primary key of a multi-Region key.
This operation changes the replica key in the specified Region to a primary key and changes the former primary key to a replica key. For example, suppose you have a primary key in us-east-1 and a replica key in eu-west-2. If you run UpdatePrimaryRegion with a PrimaryRegion value of eu-west-2, the primary key is now the key in eu-west-2, and the key in us-east-1 becomes a replica key. For details, see Updating the primary Region in the Key Management Service Developer Guide.
This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
The primary key of a multi-Region key is the source for properties that are always shared by primary and replica keys, including the key material, key ID, key spec, key usage, key material origin, and automatic key rotation. It's the only key that can be replicated. You cannot delete the primary key until all replica keys are deleted.
The key ID and primary Region that you specify uniquely identify the replica key that will become the primary key. The primary Region must already have a replica key. This operation does not create a KMS key in the specified Region. To find the replica keys, use the DescribeKey operation on the primary key or any replica key. To create a replica key, use the ReplicateKey operation.
You can run this operation while using the affected multi-Region keys in cryptographic operations. This operation should not delay, interrupt, or cause failures in cryptographic operations.
Even after this operation completes, the process of updating the primary Region might still be in progress for a few more seconds. Operations such as DescribeKey might display both the old and new primary keys as replicas. The old and new primary keys have a transient key state of Updating. The original key state is restored when the update is complete. While the key state is Updating, you can use the keys in cryptographic operations, but you cannot replicate the new primary key or perform certain management operations, such as enabling or disabling these keys. For details about the Updating key state, see Key states of KMS keys in the Key Management Service Developer Guide.
This operation does not return any output. To verify that primary key is changed, use the DescribeKey operation.
Cross-account use: No. You cannot use this operation in a different Amazon Web Services account.
Required permissions:
kms:UpdatePrimaryRegion on the current primary key (in the primary key's Region). Include this permission primary key's key policy.
kms:UpdatePrimaryRegion on the current replica key (in the replica key's Region). Include this permission in the replica key's key policy.
Related operations
", - "Verify": "Verifies a digital signature that was generated by the Sign operation.
Verification confirms that an authorized user signed the message with the specified KMS key and signing algorithm, and the message hasn't changed since it was signed. If the signature is verified, the value of the SignatureValid field in the response is True. If the signature verification fails, the Verify operation fails with an KMSInvalidSignatureException exception.
A digital signature is generated by using the private key in an asymmetric KMS key. The signature is verified by using the public key in the same asymmetric KMS key. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
To verify a digital signature, you can use the Verify operation. Specify the same asymmetric KMS key, message, and signing algorithm that were used to produce the signature.
You can also verify the digital signature by using the public key of the KMS key outside of KMS. Use the GetPublicKey operation to download the public key in the asymmetric KMS key and then use the public key to verify the signature outside of KMS. The advantage of using the Verify operation is that it is performed within KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the KMS key to verify signatures.
To verify a signature outside of KMS with an SM2 public key (China Regions only), you must specify the distinguishing ID. By default, KMS uses 1234567812345678 as the distinguishing ID. For more information, see Offline verification with SM2 key pairs.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Required permissions: kms:Verify (key policy)
Related operations: Sign
", + "Verify": "Verifies a digital signature that was generated by the Sign operation.
Verification confirms that an authorized user signed the message with the specified KMS key and signing algorithm, and the message hasn't changed since it was signed. If the signature is verified, the value of the SignatureValid field in the response is True. If the signature verification fails, the Verify operation fails with an KMSInvalidSignatureException exception.
A digital signature is generated by using the private key in an asymmetric KMS key. The signature is verified by using the public key in the same asymmetric KMS key. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
To use the Verify operation, specify the same asymmetric KMS key, message, and signing algorithm that were used to produce the signature. The message type does not need to be the same as the one used for signing, but it must indicate whether the value of the Message parameter should be hashed as part of the verification process.
You can also verify the digital signature by using the public key of the KMS key outside of KMS. Use the GetPublicKey operation to download the public key in the asymmetric KMS key and then use the public key to verify the signature outside of KMS. The advantage of using the Verify operation is that it is performed within KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the KMS key to verify signatures.
To verify a signature outside of KMS with an SM2 public key (China Regions only), you must specify the distinguishing ID. By default, KMS uses 1234567812345678 as the distinguishing ID. For more information, see Offline verification with SM2 key pairs.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Required permissions: kms:Verify (key policy)
Related operations: Sign
", "VerifyMac": "Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC KMS key, and MAC algorithm. To verify the HMAC, VerifyMac computes an HMAC using the message, HMAC KMS key, and MAC algorithm that you specify, and compares the computed HMAC to the HMAC that you specify. If the HMACs are identical, the verification succeeds; otherwise, it fails. Verification indicates that the message hasn't changed since the HMAC was calculated, and the specified key was used to generate and verify the HMAC.
HMAC KMS keys and the HMAC algorithms that KMS uses conform to industry standards defined in RFC 2104.
This operation is part of KMS support for HMAC KMS keys. For details, see HMAC keys in KMS in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Required permissions: kms:VerifyMac (key policy)
Related operations: GenerateMac
" }, "shapes": { @@ -63,7 +63,7 @@ "AlgorithmSpec": { "base": null, "refs": { - "GetParametersForImportRequest$WrappingAlgorithm": "The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.
" + "GetParametersForImportRequest$WrappingAlgorithm": "The algorithm you will use to encrypt the key material before using the ImportKeyMaterial operation to import it. For more information, see Encrypt the key material in the Key Management Service Developer Guide.
The RSAES_PKCS1_V1_5 wrapping algorithm is deprecated. We recommend that you begin using a different wrapping algorithm immediately. KMS will end support for RSAES_PKCS1_V1_5 by October 1, 2023 pursuant to cryptographic key management guidance from the National Institute of Standards and Technology (NIST).
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
The default value is false.
", + "CreateKeyRequest$BypassPolicyLockoutSafetyCheck": "Skips (\"bypasses\") the key policy lockout safety check. The default value is false.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, see Default key policy in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
", "DescribeCustomKeyStoresResponse$Truncated": "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A Boolean value that specifies whether key rotation is enabled.
", "KeyMetadata$Enabled": "Specifies whether the KMS key is enabled. When KeyState is Enabled this value is true, otherwise it is false.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
The default value is false.
", - "ReplicateKeyRequest$BypassPolicyLockoutSafetyCheck": "A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
The default value is false.
", + "PutKeyPolicyRequest$BypassPolicyLockoutSafetyCheck": "Skips (\"bypasses\") the key policy lockout safety check. The default value is false.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, see Default key policy in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
", + "ReplicateKeyRequest$BypassPolicyLockoutSafetyCheck": "Skips (\"bypasses\") the key policy lockout safety check. The default value is false.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, see Default key policy in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
", "VerifyMacResponse$MacValid": "A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the HMAC (Mac) was generated with the specified Message, HMAC KMS key (KeyID) and MacAlgorithm..
If the HMAC is not verified, the VerifyMac operation fails with a KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.
A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.
Tells KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.
Tells KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.
Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with a raw message, the security of the verification operation can be compromised.
Tells KMS whether the value of the Message parameter should be hashed as part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are already hashed.
When the value of MessageType is RAW, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing algorithm.
Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with an unhashed message, the security of the signing operation can be compromised.
When the value of MessageTypeis DIGEST, the length of the Message value must match the length of hashed messages for the specified signing algorithm.
You can submit a message digest and omit the MessageType or specify RAW so the digest is hashed again while signing. However, this can cause verification failures when verifying with a system that assumes a single hash.
The hashing algorithm in that Sign uses is based on the SigningAlgorithm value.
Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.
Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.
Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.
Tells KMS whether the value of the Message parameter should be hashed as part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are already hashed.
When the value of MessageType is RAW, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing algorithm.
Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with an unhashed message, the security of the verification operation can be compromised.
When the value of MessageTypeis DIGEST, the length of the Message value must match the length of hashed messages for the specified signing algorithm.
You can submit a message digest and omit the MessageType or specify RAW so the digest is hashed again while signing. However, if the signed message is hashed once while signing, but twice while verifying, verification fails, even when the message hasn't changed.
The hashing algorithm in that Verify uses is based on the SigningAlgorithm value.
Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.
Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.
Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.
The message to be hashed. Specify a message of up to 4,096 bytes.
GenerateMac and VerifyMac do not provide special handling for message digests. If you generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.
The random byte string. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
", "GetParametersForImportResponse$PublicKey": "The public key to use to encrypt the key material before importing it with ImportKeyMaterial.
", - "SignRequest$Message": "Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.
If you provide a message, KMS generates a hash digest of the message and then signs it.
", + "SignRequest$Message": "Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide a message digest.
If you provide a message digest, use the DIGEST value of MessageType to prevent the digest from being hashed again while signing.
The message that will be used in the verification. Enter the same message that was used to generate the HMAC.
GenerateMac and VerifyMac do not provide special handling for message digests. If you generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.
Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the message. If you submit a digest, use the MessageType parameter with a value of DIGEST.
If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.
" } @@ -1159,23 +1159,23 @@ "PolicyType": { "base": null, "refs": { - "CreateKeyRequest$Policy": "The key policy to attach to the KMS key.
If you provide a key policy, it must meet the following criteria:
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide .
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default Key Policy in the Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
", + "CreateKeyRequest$Policy": "The key policy to attach to the KMS key.
If you provide a key policy, it must meet the following criteria:
The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default key policy in the Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
", "GetKeyPolicyResponse$Policy": "A key policy document in JSON format.
", - "PutKeyPolicyRequest$Policy": "The key policy to attach to the KMS key.
The key policy must meet the following criteria:
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide.
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
A key policy document can include only the following characters:
Printable ASCII characters from the space character (\\u0020) through the end of the ASCII character range.
Printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF).
The tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) special characters
For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide.For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
", - "ReplicateKeyRequest$Policy": "The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.
The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.
If you provide a key policy, it must meet the following criteria:
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide .
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Identity and Access Management User Guide .
A key policy document can include only the following characters:
Printable ASCII characters from the space character (\\u0020) through the end of the ASCII character range.
Printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF).
The tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) special characters
For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
", + "PutKeyPolicyRequest$Policy": "The key policy to attach to the KMS key.
The key policy must meet the following criteria:
The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
A key policy document can include only the following characters:
Printable ASCII characters from the space character (\\u0020) through the end of the ASCII character range.
Printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF).
The tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) special characters
For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide.For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
", + "ReplicateKeyRequest$Policy": "The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.
The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.
If you provide a key policy, it must meet the following criteria:
The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
A key policy document can include only the following characters:
Printable ASCII characters from the space character (\\u0020) through the end of the ASCII character range.
Printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF).
The tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) special characters
For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
", "ReplicateKeyResponse$ReplicaPolicy": "The key policy of the new replica key. The value is a key policy document in JSON format.
" } }, "PrincipalIdType": { "base": null, "refs": { - "CreateGrantRequest$GranteePrincipal": "The identity that gets the permissions specified in the grant.
To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
", - "CreateGrantRequest$RetiringPrincipal": "The principal that has permission to use the RetireGrant operation to retire the grant.
To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.
", + "CreateGrantRequest$GranteePrincipal": "The identity that gets the permissions specified in the grant.
To specify the grantee principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .
", + "CreateGrantRequest$RetiringPrincipal": "The principal that has permission to use the RetireGrant operation to retire the grant.
To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .
The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.
", "GrantListEntry$GranteePrincipal": "The identity that gets the permissions in the grant.
The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.
The principal that can retire the grant.
", "GrantListEntry$IssuingAccount": "The Amazon Web Services account under which the grant was issued.
", "ListGrantsRequest$GranteePrincipal": "Returns only grants where the specified principal is the grantee principal for the grant.
", - "ListRetirableGrantsRequest$RetiringPrincipal": "The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
" + "ListRetirableGrantsRequest$RetiringPrincipal": "The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .
" } }, "PublicKeyType": { @@ -1252,7 +1252,7 @@ "SigningAlgorithmSpec": { "base": null, "refs": { - "SignRequest$SigningAlgorithm": "Specifies the signing algorithm to use when signing the message.
Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.
", + "SignRequest$SigningAlgorithm": "Specifies the signing algorithm to use when signing the message.
Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key. When signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1_5 algorithms for compatibility with existing applications.
", "SignResponse$SigningAlgorithm": "The signing algorithm that was used to sign the message.
", "SigningAlgorithmSpecList$member": null, "VerifyRequest$SigningAlgorithm": "The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
", diff --git a/models/apis/kms/2014-11-01/endpoint-rule-set-1.json b/models/apis/kms/2014-11-01/endpoint-rule-set-1.json index 7e3838f6331..64b8c61c24d 100644 --- a/models/apis/kms/2014-11-01/endpoint-rule-set-1.json +++ b/models/apis/kms/2014-11-01/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,14 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -62,67 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -131,90 +111,215 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] }, - "supportsFIPS" + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kms-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] }, { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsDualStack" + true ] } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kms-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://kms-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsFIPS" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kms.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], "type": "tree", @@ -222,7 +327,7 @@ { "conditions": [], "endpoint": { - "url": "https://kms-fips.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://kms.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, @@ -231,74 +336,13 @@ ] } ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://kms.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "endpoint": { - "url": "https://kms.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/models/apis/kms/2014-11-01/endpoint-tests-1.json b/models/apis/kms/2014-11-01/endpoint-tests-1.json index f45c01f0c14..48ad4fc1be5 100644 --- a/models/apis/kms/2014-11-01/endpoint-tests-1.json +++ b/models/apis/kms/2014-11-01/endpoint-tests-1.json @@ -1,1721 +1,808 @@ { "testCases": [ { - "documentation": "For region ap-south-2 with FIPS enabled and DualStack enabled", + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-south-2.api.aws" + "url": "https://kms.af-south-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-south-2" + "UseDualStack": false, + "UseFIPS": false, + "Region": "af-south-1" } }, { - "documentation": "For region ap-south-2 with FIPS enabled and DualStack disabled", + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-south-2.amazonaws.com" + "url": "https://kms-fips.af-south-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "ap-south-2" + "UseFIPS": true, + "Region": "af-south-1" } }, { - "documentation": "For region ap-south-2 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-south-2.api.aws" + "url": "https://kms.ap-east-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-south-2" + "Region": "ap-east-1" } }, { - "documentation": "For region ap-south-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-south-2.amazonaws.com" + "url": "https://kms-fips.ap-east-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "ap-south-2" + "UseFIPS": true, + "Region": "ap-east-1" } }, { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-south-1.api.aws" + "url": "https://kms.ap-northeast-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-south-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-1" } }, { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-south-1.amazonaws.com" + "url": "https://kms-fips.ap-northeast-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "ap-south-1" + "UseFIPS": true, + "Region": "ap-northeast-1" } }, { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-south-1.api.aws" + "url": "https://kms.ap-northeast-2.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-south-1" + "Region": "ap-northeast-2" } }, { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-south-1.amazonaws.com" + "url": "https://kms-fips.ap-northeast-2.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "ap-south-1" + "UseFIPS": true, + "Region": "ap-northeast-2" } }, { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.eu-south-1.api.aws" + "url": "https://kms.ap-northeast-3.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-south-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-3" } }, { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.eu-south-1.amazonaws.com" + "url": "https://kms-fips.ap-northeast-3.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "eu-south-1" + "UseFIPS": true, + "Region": "ap-northeast-3" } }, { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.eu-south-1.api.aws" + "url": "https://kms.ap-south-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-south-1" + "Region": "ap-south-1" } }, { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.eu-south-1.amazonaws.com" + "url": "https://kms-fips.ap-south-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "eu-south-1" + "UseFIPS": true, + "Region": "ap-south-1" } }, { - "documentation": "For region eu-south-2 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.eu-south-2.api.aws" + "url": "https://kms.ap-southeast-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-south-2" + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-1" } }, { - "documentation": "For region eu-south-2 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.eu-south-2.amazonaws.com" + "url": "https://kms-fips.ap-southeast-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "eu-south-2" + "UseFIPS": true, + "Region": "ap-southeast-1" } }, { - "documentation": "For region eu-south-2 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.eu-south-2.api.aws" + "url": "https://kms.ap-southeast-2.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-south-2" + "Region": "ap-southeast-2" } }, { - "documentation": "For region eu-south-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.eu-south-2.amazonaws.com" + "url": "https://kms-fips.ap-southeast-2.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "eu-south-2" + "UseFIPS": true, + "Region": "ap-southeast-2" } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.us-gov-east-1.api.aws" + "url": "https://kms.ap-southeast-3.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-gov-east-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-3" } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.us-gov-east-1.amazonaws.com" + "url": "https://kms-fips.ap-southeast-3.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-gov-east-1" + "UseFIPS": true, + "Region": "ap-southeast-3" } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.us-gov-east-1.api.aws" + "url": "https://kms.ca-central-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "us-gov-east-1" + "Region": "ca-central-1" } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.us-gov-east-1.amazonaws.com" + "url": "https://kms-fips.ca-central-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-gov-east-1" + "UseFIPS": true, + "Region": "ca-central-1" } }, { - "documentation": "For region me-central-1 with FIPS enabled and DualStack enabled", + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.me-central-1.api.aws" + "url": "https://kms.eu-central-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "me-central-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-central-1" } }, { - "documentation": "For region me-central-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.me-central-1.amazonaws.com" + "url": "https://kms-fips.eu-central-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "me-central-1" + "UseFIPS": true, + "Region": "eu-central-1" } }, { - "documentation": "For region me-central-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.me-central-1.api.aws" + "url": "https://kms.eu-north-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "me-central-1" + "Region": "eu-north-1" } }, { - "documentation": "For region me-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.me-central-1.amazonaws.com" + "url": "https://kms-fips.eu-north-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "me-central-1" + "UseFIPS": true, + "Region": "eu-north-1" } }, { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ca-central-1.api.aws" + "url": "https://kms.eu-south-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ca-central-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-south-1" } }, { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ca-central-1.amazonaws.com" + "url": "https://kms-fips.eu-south-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "ca-central-1" + "UseFIPS": true, + "Region": "eu-south-1" } }, { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ca-central-1.api.aws" + "url": "https://kms.eu-west-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "ca-central-1" + "Region": "eu-west-1" } }, { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ca-central-1.amazonaws.com" + "url": "https://kms-fips.eu-west-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "ca-central-1" + "UseFIPS": true, + "Region": "eu-west-1" } }, { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.eu-central-1.api.aws" + "url": "https://kms.eu-west-2.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-central-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-2" } }, { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.eu-central-1.amazonaws.com" + "url": "https://kms-fips.eu-west-2.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "eu-central-1" + "UseFIPS": true, + "Region": "eu-west-2" } }, { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.eu-central-1.api.aws" + "url": "https://kms.eu-west-3.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-central-1" + "Region": "eu-west-3" } }, { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.eu-central-1.amazonaws.com" + "url": "https://kms-fips.eu-west-3.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "eu-central-1" + "UseFIPS": true, + "Region": "eu-west-3" } }, { - "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack enabled", + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://kms.me-south-1.amazonaws.com" + } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-iso-west-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "me-south-1" } }, { - "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.us-iso-west-1.c2s.ic.gov" + "url": "https://kms-fips.me-south-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-iso-west-1" + "UseFIPS": true, + "Region": "me-south-1" } }, { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://kms.sa-east-1.amazonaws.com" + } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "us-iso-west-1" + "Region": "sa-east-1" } }, { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.us-iso-west-1.c2s.ic.gov" + "url": "https://kms-fips.sa-east-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-iso-west-1" + "UseFIPS": true, + "Region": "sa-east-1" } }, { - "documentation": "For region eu-central-2 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.eu-central-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-central-2" - } - }, - { - "documentation": "For region eu-central-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-central-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-central-2" - } - }, - { - "documentation": "For region eu-central-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-central-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-central-2" - } - }, - { - "documentation": "For region eu-central-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-central-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-central-2" - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.us-west-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.us-west-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.us-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.us-west-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.us-west-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.us-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "us-west-2" - } - }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.af-south-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "af-south-1" - } - }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.af-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "af-south-1" - } - }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.af-south-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "af-south-1" - } - }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.af-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "af-south-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-north-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-north-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-north-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-north-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-west-3.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-west-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-west-3.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-west-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-west-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-west-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-west-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.eu-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-west-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.eu-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-northeast-3.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-northeast-3" - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-northeast-3" - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-northeast-3.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-northeast-3" - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-northeast-3" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-northeast-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-northeast-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-northeast-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-northeast-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.me-south-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "me-south-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.me-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "me-south-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.me-south-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "me-south-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.me-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "me-south-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.sa-east-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.sa-east-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-east-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-east-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.us-gov-west-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.us-gov-west-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-southeast-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.ap-southeast-1.api.aws" + "url": "https://kms.us-east-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-southeast-1" + "Region": "us-east-1" } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-southeast-1.amazonaws.com" + "url": "https://kms-fips.us-east-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "ap-southeast-1" + "UseFIPS": true, + "Region": "us-east-1" } }, { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-southeast-2.api.aws" + "url": "https://kms.us-east-2.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-southeast-2" + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-2" } }, { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-southeast-2.amazonaws.com" + "url": "https://kms-fips.us-east-2.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "ap-southeast-2" + "UseFIPS": true, + "Region": "us-east-2" } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-southeast-2.api.aws" + "url": "https://kms.us-west-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-southeast-2" + "Region": "us-west-1" } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-southeast-2.amazonaws.com" + "url": "https://kms-fips.us-west-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "ap-southeast-2" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-iso-east-1" + "Region": "us-west-1" } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.us-iso-east-1.c2s.ic.gov" + "url": "https://kms.us-west-2.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-iso-east-1" + "Region": "us-west-2" } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.us-iso-east-1.c2s.ic.gov" + "url": "https://kms-fips.us-west-2.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-iso-east-1" + "UseFIPS": true, + "Region": "us-west-2" } }, { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-southeast-3.api.aws" + "url": "https://kms-fips.us-east-1.api.aws" } }, "params": { - "UseFIPS": true, "UseDualStack": true, - "Region": "ap-southeast-3" + "UseFIPS": true, + "Region": "us-east-1" } }, { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-southeast-3.amazonaws.com" + "url": "https://kms.us-east-1.api.aws" } }, "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-southeast-3" + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-southeast-3.api.aws" + "url": "https://kms.cn-north-1.amazonaws.com.cn" } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-southeast-3" + "Region": "cn-north-1" } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-southeast-3.amazonaws.com" + "url": "https://kms.cn-northwest-1.amazonaws.com.cn" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "ap-southeast-3" + "UseFIPS": false, + "Region": "cn-northwest-1" } }, { - "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-southeast-4.api.aws" + "url": "https://kms-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "UseFIPS": true, "UseDualStack": true, - "Region": "ap-southeast-4" + "UseFIPS": true, + "Region": "cn-north-1" } }, { - "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.ap-southeast-4.amazonaws.com" + "url": "https://kms-fips.cn-north-1.amazonaws.com.cn" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "ap-southeast-4" + "UseFIPS": true, + "Region": "cn-north-1" } }, { - "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://kms.ap-southeast-4.api.aws" + "url": "https://kms.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "UseFIPS": false, "UseDualStack": true, - "Region": "ap-southeast-4" + "UseFIPS": false, + "Region": "cn-north-1" } }, { - "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.ap-southeast-4.amazonaws.com" + "url": "https://kms.us-gov-east-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "ap-southeast-4" + "UseFIPS": false, + "Region": "us-gov-east-1" } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.us-east-1.api.aws" + "url": "https://kms-fips.us-gov-east-1.amazonaws.com" } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": true, - "Region": "us-east-1" + "Region": "us-gov-east-1" } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.us-east-1.amazonaws.com" + "url": "https://kms.us-gov-west-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms.us-east-1.api.aws" - } - }, - "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-east-1" + "Region": "us-gov-west-1" } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.us-east-1.amazonaws.com" + "url": "https://kms-fips.us-gov-west-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kms-fips.us-east-2.api.aws" - } - }, - "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-east-2" + "Region": "us-gov-west-1" } }, { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://kms-fips.us-east-2.amazonaws.com" + "url": "https://kms-fips.us-gov-east-1.api.aws" } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "UseDualStack": false, - "Region": "us-east-2" + "Region": "us-gov-east-1" } }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://kms.us-east-2.api.aws" + "url": "https://kms.us-gov-east-1.api.aws" } }, "params": { - "UseFIPS": false, "UseDualStack": true, - "Region": "us-east-2" + "UseFIPS": false, + "Region": "us-gov-east-1" } }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.us-east-2.amazonaws.com" + "url": "https://kms.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-east-2" + "UseFIPS": false, + "Region": "us-iso-east-1" } }, { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.cn-northwest-1.api.amazonwebservices.com.cn" + "url": "https://kms-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": true, - "Region": "cn-northwest-1" + "Region": "us-iso-east-1" } }, { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms-fips.cn-northwest-1.amazonaws.com.cn" + "url": "https://kms.us-iso-west-1.c2s.ic.gov" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "cn-northwest-1" + "UseFIPS": false, + "Region": "us-iso-west-1" } }, { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.cn-northwest-1.api.amazonwebservices.com.cn" + "url": "https://kms-fips.us-iso-west-1.c2s.ic.gov" } }, "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "cn-northwest-1" + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-west-1" } }, { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://kms.cn-northwest-1.amazonaws.com.cn" + "url": "https://kms.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "cn-northwest-1" - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, + "UseFIPS": false, "Region": "us-isob-east-1" } }, @@ -1727,46 +814,35 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, "Region": "us-isob-east-1" } }, { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-isob-east-1" - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { - "url": "https://kms.us-isob-east-1.sc2s.sgov.gov" + "url": "https://example.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-isob-east-1" + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-east-1", + "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -1776,8 +852,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -1788,8 +864,8 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseFIPS": false, "UseDualStack": true, + "UseFIPS": false, "Region": "us-east-1", "Endpoint": "https://example.com" } diff --git a/models/apis/kms/2014-11-01/examples-1.json b/models/apis/kms/2014-11-01/examples-1.json index 21b01579b5e..06c2a6368a4 100644 --- a/models/apis/kms/2014-11-01/examples-1.json +++ b/models/apis/kms/2014-11-01/examples-1.json @@ -1799,8 +1799,37 @@ } }, "description": "This operation uses the private key in an asymmetric elliptic curve (ECC) KMS key to generate a digital signature for a given message.", - "id": "to-digitally-sign-a-message-with-an-asymmetric-kms-key-1628631433832", + "id": "to-digitally-sign-a-message-with-an-asymmetric-kms-key-1", "title": "To digitally sign a message with an asymmetric KMS key." + }, + { + "input": { + "KeyId": "alias/RSA_signing_key", + "Message": "Creates an Amazon Lightsail content delivery network (CDN) distribution.
A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.
", "CreateDomain": "Creates a domain resource for the specified domain (e.g., example.com).
The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.
Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session.
Use StartGUISession to open the session.
Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.
The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates one or more Amazon Lightsail instances.
The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Developer Guide.
Creates one or more new instances from a manual or automatic snapshot of an instance.
The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.
Returns the data points of a specific metric of your Amazon Lightsail container service.
Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
", "GetContainerServicePowers": "Returns the list of powers that can be specified for your Amazon Lightsail container services.
The power specifies the amount of memory, the number of vCPUs, and the base price of the container service.
", "GetContainerServices": "Returns information about one or more of your Amazon Lightsail container services.
", + "GetCostEstimate": "Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.
", "GetDisk": "Returns information about a specific block storage disk.
", "GetDiskSnapshot": "Returns information about a specific block storage disk snapshot.
", "GetDiskSnapshots": "Returns information about all block storage disk snapshots in your AWS account and region.
", @@ -139,8 +141,10 @@ "SendContactMethodVerification": "Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.
Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.
Sets the IP address type for an Amazon Lightsail resource.
Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.
", "SetResourceAccessForBucket": "Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.
", + "StartGUISession": "Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.
", "StartInstance": "Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.
Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation.
The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.
", "StopInstance": "Stops a specific Amazon Lightsail instance that is currently running.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.
Stops a specific database that is currently running in Amazon Lightsail.
The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Amazon Lightsail Developer Guide.
The tag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Amazon Lightsail Developer Guide.
Virtual computer blueprints that are supported by Lightsail for Research.
This parameter only applies to Lightsail for Research resources.
Returns a list of blueprints that are specific to Lightsail for Research.
You must use this parameter to view Lightsail for Research blueprints.
Returns a list of bundles that are specific to Lightsail for Research.
You must use this parameter to view Lightsail for Research bundles.
Virtual computer blueprints that are supported by a Lightsail for Research bundle.
This parameter only applies to Lightsail for Research resources.
An object containing information about one or more disk mappings.
" } }, + "AutoMountStatus": { + "base": null, + "refs": { + "Disk$autoMountStatus": "The status of automatically mounting a storage disk to a virtual computer.
This parameter only applies to Lightsail for Research resources.
Describes a request to enable or modify the automatic snapshot add-on for an Amazon Lightsail instance or disk.
When you modify the automatic snapshot time for a resource, it is typically effective immediately except under the following conditions:
If an automatic snapshot has been created for the current day, and you change the snapshot time to a later time of day, then the new snapshot time will be effective the following day. This ensures that two snapshots are not created for the current day.
If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to an earlier time of day, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day.
If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to a time that is within 30 minutes from your current time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.
If an automatic snapshot is scheduled to be created within 30 minutes from your current time and you change the snapshot time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.
Describes the estimated cost for resources in your Lightsail for Research account.
", + "refs": { + "CostEstimates$member": null + } + }, + "CostEstimates": { + "base": null, + "refs": { + "ResourceBudgetEstimate$costEstimates": "The cost estimate for the specified budget.
" + } + }, "CreateBucketAccessKeyRequest": { "base": null, "refs": { @@ -1077,6 +1114,16 @@ "refs": { } }, + "CreateGUISessionAccessDetailsRequest": { + "base": null, + "refs": { + } + }, + "CreateGUISessionAccessDetailsResult": { + "base": null, + "refs": { + } + }, "CreateInstanceSnapshotRequest": { "base": null, "refs": { @@ -1167,6 +1214,12 @@ "refs": { } }, + "Currency": { + "base": null, + "refs": { + "EstimateByTime$currency": "The currency of the estimate in USD.
" + } + }, "DeleteAlarmRequest": { "base": null, "refs": { @@ -1669,6 +1722,18 @@ "Container$environment": "The environment variables of the container.
" } }, + "EstimateByTime": { + "base": "An estimate that's associated with a time period.
", + "refs": { + "EstimatesByTime$member": null + } + }, + "EstimatesByTime": { + "base": null, + "refs": { + "CostEstimate$resultsByTime": "The cost estimate result that's associated with a time period.
" + } + }, "ExportSnapshotRecord": { "base": "Describes an export snapshot record.
", "refs": { @@ -1895,6 +1960,16 @@ "refs": { } }, + "GetCostEstimateRequest": { + "base": null, + "refs": { + } + }, + "GetCostEstimateResult": { + "base": null, + "refs": { + } + }, "GetDiskRequest": { "base": null, "refs": { @@ -2666,6 +2741,8 @@ "GetContainerLogRequest$endTime": "The end of the time interval for which to get log data.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
", "GetContainerServiceMetricDataRequest$startTime": "The start time of the time period.
", "GetContainerServiceMetricDataRequest$endTime": "The end time of the time period.
", + "GetCostEstimateRequest$startTime": "The cost estimate start time.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
", + "GetCostEstimateRequest$endTime": "The cost estimate end time.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
", "GetDistributionLatestCacheResetResult$createTime": "The timestamp of the last cache reset (e.g., 1479734909.17) in Unix time format.
The start of the time interval from which to get log events.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.
The end of the time interval from which to get log events.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.
The timestamp when the database snapshot was created.
", "RenewalSummary$updatedAt": "The timestamp when the certificate was last updated.
", "ResetDistributionCacheResult$createTime": "The timestamp of the reset cache request (e.g., 1479734909.17) in Unix time format.
The timestamp when the static IP was created (e.g., 1479735304.222).
The estimate start time.
", + "ResourceBudgetEstimate$endTime": "The estimate end time.
", + "StaticIp$createdAt": "The timestamp when the static IP was created (e.g., 1479735304.222).
The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Lightsail for Research retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.
The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Lightsail for Research retrieves cost and usage data from the start date up to, but not including, 2017-05-01.
The destination of the contact method, such as an email address or a mobile phone number.
", "ContactMethod$arn": "The Amazon Resource Name (ARN) of the contact method.
", "ContainerService$arn": "The Amazon Resource Name (ARN) of the container service.
", + "CostEstimate$usageType": "The types of usage that are included in the estimate, such as costs, usage, or data transfer.
", "CreateBucketRequest$bundleId": "The ID of the bundle to use for the bucket.
A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.
Use the GetBucketBundles action to get a list of bundle IDs that you can specify.
Use the UpdateBucketBundle action to change the bundle after the bucket is created.
", "CreateDiskFromSnapshotRequest$availabilityZone": "The Availability Zone where you want to create the disk (e.g., us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.
Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
", "CreateDiskRequest$availabilityZone": "The Availability Zone where you want to create the disk (e.g., us-east-2a). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk.
Use the get regions operation to list the Availability Zones where Lightsail is currently available.
The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
", "ResourceReceivingAccess$name": "The name of the Lightsail instance.
", "ResourceReceivingAccess$resourceType": "The Lightsail resource type (for example, Instance).
The session name.
", "StaticIp$arn": "The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).
The ID of the new bundle to apply to the bucket.
Use the GetBucketBundles action to get a list of bundle IDs that you can specify.
", "UpdateBucketRequest$versioning": "Specifies whether to enable or suspend versioning of objects in the bucket.
The following options can be specified:
Enabled - Enables versioning of objects in the specified bucket.
Suspended - Suspends versioning of objects in the specified bucket. Existing object versions are retained.
An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
", "SetIpAddressTypeResult$operations": "An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
", "SetResourceAccessForBucketResult$operations": "An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
", + "StartGUISessionResult$operations": "The available API operations.
", "StartInstanceResult$operations": "An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
", "StartRelationalDatabaseResult$operations": "An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
", + "StopGUISessionResult$operations": "The available API operations.
", "StopInstanceResult$operations": "An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
", "StopRelationalDatabaseResult$operations": "An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
", "TagResourceResult$operations": "An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
", @@ -3348,6 +3433,12 @@ "InstancePortState$state": "Specifies whether the instance port is open or closed.
The port state for Lightsail instances is always open.
The unit of measurement that's used for the cost estimate.
" + } + }, "PrivateRegistryAccess": { "base": "Describes the configuration for an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.
", "refs": { @@ -3628,6 +3719,12 @@ "SetResourceAccessForBucketRequest$access": "The access setting.
The following access settings are available:
allow - Allows access to the bucket and its objects.
deny - Denies access to the bucket and its objects. Use this setting to remove access for a resource previously set to allow.
Describes the estimated cost or usage that a budget tracks.
", + "refs": { + "ResourcesBudgetEstimate$member": null + } + }, "ResourceLocation": { "base": "Describes the resource location.
", "refs": { @@ -3680,6 +3777,8 @@ "CreateDiskSnapshotRequest$diskSnapshotName": "The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the source disk.
The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1). When this is defined, a snapshot of the instance's system volume is created.
This parameter cannot be defined together with the disk name parameter. The instance name and disk name parameters are mutually exclusive.
The name for the distribution.
", + "CreateGUISessionAccessDetailsRequest$resourceName": "The resource name.
", + "CreateGUISessionAccessDetailsResult$resourceName": "The resource name.
", "CreateInstanceSnapshotRequest$instanceSnapshotName": "The name for your new snapshot.
", "CreateInstanceSnapshotRequest$instanceName": "The Lightsail instance on which to base your snapshot.
", "CreateInstancesFromSnapshotRequest$instanceSnapshotName": "The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.
Constraint:
This parameter cannot be defined together with the source instance name parameter. The instance snapshot name and source instance name parameters are mutually exclusive.
The name of the Lightsail resource being monitored by the alarm.
Specify a monitored resource name to return information about all alarms for a specific resource.
", "GetAutoSnapshotsRequest$resourceName": "The name of the source instance or disk from which to get automatic snapshot information.
", "GetAutoSnapshotsResult$resourceName": "The name of the source instance or disk for the automatic snapshots.
", + "GetCostEstimateRequest$resourceName": "The resource name.
", "GetDiskRequest$diskName": "The name of the disk (e.g., my-disk).
The name of the disk snapshot (e.g., my-disk-snapshot).
The name of the distribution for which to return the timestamp of the last cache reset.
Use the GetDistributions action to get a list of distribution names that you can specify.
When omitted, the response includes the latest cache reset timestamp of all your distributions.
", @@ -3789,13 +3889,16 @@ "RelationalDatabaseSnapshot$name": "The name of the database snapshot.
", "ReleaseStaticIpRequest$staticIpName": "The name of the static IP to delete.
", "ResetDistributionCacheRequest$distributionName": "The name of the distribution for which to reset cache.
Use the GetDistributions action to get a list of distribution names that you can specify.
The resource name.
", "ResourceNameList$member": null, "SetIpAddressTypeRequest$resourceName": "The name of the resource for which to set the IP address type.
", "SetResourceAccessForBucketRequest$resourceName": "The name of the Lightsail instance for which to set bucket access. The instance must be in a running or stopped state.
", + "StartGUISessionRequest$resourceName": "The resource name.
", "StartInstanceRequest$instanceName": "The name of the instance (a virtual private server) to start.
", "StartRelationalDatabaseRequest$relationalDatabaseName": "The name of your database to start.
", "StaticIp$name": "The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).
The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1).
The resource name.
", "StopInstanceRequest$instanceName": "The name of the instance (a virtual private server) to stop.
", "StopRelationalDatabaseRequest$relationalDatabaseName": "The name of your database to stop.
", "StopRelationalDatabaseRequest$relationalDatabaseSnapshotName": "The name of your new database snapshot to be created before stopping your database.
", @@ -3852,10 +3955,17 @@ "Origin$resourceType": "The resource type of the origin resource (e.g., Instance).
", "RelationalDatabase$resourceType": "The Lightsail resource type for the database (for example, RelationalDatabase).
The Lightsail resource type.
", + "ResourceBudgetEstimate$resourceType": "The type of resource the budget will track.
", "SetIpAddressTypeRequest$resourceType": "The resource type.
The possible values are Distribution, Instance, and LoadBalancer.
Distribution-related APIs are available only in the N. Virginia (us-east-1) Amazon Web Services Region. Set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit distributions.
The resource type (usually StaticIp).
Returns the estimate's forecasted cost or usage.
" + } + }, "RevocationReason": { "base": null, "refs": { @@ -3872,6 +3982,12 @@ "refs": { } }, + "SensitiveNonEmptyString": { + "base": null, + "refs": { + "Session$url": "The session URL.
" + } + }, "SensitiveString": { "base": null, "refs": { @@ -3891,6 +4007,18 @@ "refs": { } }, + "Session": { + "base": "Describes a web-based, remote graphical user interface (GUI), NICE DCV session. The session is used to access a virtual computer’s operating system or application.
", + "refs": { + "Sessions$member": null + } + }, + "Sessions": { + "base": null, + "refs": { + "CreateGUISessionAccessDetailsResult$sessions": "Returns information about the specified NICE DCV GUI session.
" + } + }, "SetIpAddressTypeRequest": { "base": null, "refs": { @@ -3911,6 +4039,16 @@ "refs": { } }, + "StartGUISessionRequest": { + "base": null, + "refs": { + } + }, + "StartGUISessionResult": { + "base": null, + "refs": { + } + }, "StartInstanceRequest": { "base": null, "refs": { @@ -3944,12 +4082,34 @@ "GetStaticIpsResult$staticIps": "An array of key-value pairs containing information about your get static IPs request.
" } }, + "Status": { + "base": null, + "refs": { + "CreateGUISessionAccessDetailsResult$status": "The status of the operation.
" + } + }, "StatusType": { "base": null, "refs": { "AccessKey$status": "The status of the access key.
A status of Active means that the key is valid, while Inactive means it is not.
Describes a request to create or edit the StopInstanceOnIdle add-on.
This add-on only applies to Lightsail for Research resources.
An object that represents additional parameters when enabling or modifying the StopInstanceOnIdle add-on.
This object only applies to Lightsail for Research resources.
The daily time when an automatic snapshot will be created.
Constraints:
Must be in HH:00 format, and in an hourly increment.
Specified in Coordinated Universal Time (UTC).
The snapshot will be automatically created between the time specified and up to 45 minutes after.
Sets the start date and end date for retrieving a cost estimate. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
The period of time, in days, that an estimate covers. The period has a start date and an end date. The start date must come before the end date.
" + } + }, "TreatMissingData": { "base": null, "refs": { @@ -4239,6 +4405,7 @@ "AccessRules$allowPublicOverrides": "A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.
When this is true, you can use the PutObjectAcl Amazon S3 API action to set individual objects to public (read-only) using the public-read ACL, or to private using the private ACL.
A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.
", "Alarm$notificationEnabled": "Indicates whether the alarm is enabled.
", + "AttachDiskRequest$autoMounting": "A Boolean value used to determine the automatic mounting of a storage volume to a virtual computer. The default value is False.
This value only applies to Lightsail for Research resources.
A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
", "Bucket$ableToUpdateBundle": "Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.
You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle.
Use the UpdateBucketBundle action to change a bucket's bundle.
", "BucketAccessLogConfig$enabled": "A Boolean value that indicates whether bucket access logging is enabled for the bucket.
", @@ -4294,6 +4461,7 @@ "RelationalDatabaseBundle$isEncrypted": "A Boolean value indicating whether the database bundle is encrypted.
", "RelationalDatabaseBundle$isActive": "A Boolean value indicating whether the database bundle is active.
", "RelationalDatabaseParameter$isModifiable": "A Boolean value indicating whether the parameter can be modified.
", + "Session$isPrimary": "When true, this Boolean value indicates the primary session for the specified resource.
", "StaticIp$isAttached": "A Boolean value indicating whether the static IP is attached.
", "StopInstanceRequest$force": "When set to True, forces a Lightsail instance that is stuck in a stopping state to stop.
Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request.
A Boolean value to indicate whether the container service is disabled.
", @@ -4309,6 +4477,8 @@ "base": null, "refs": { "Alarm$threshold": "The value against which the specified statistic is compared.
", + "EstimateByTime$usageCost": "The amount of cost or usage that's measured for the cost estimate.
", + "EstimateByTime$unit": "The number of pricing units used to calculate the total number of hours. For example, 1 unit equals 1 hour.
", "MetricDatapoint$average": "The average.
", "MetricDatapoint$maximum": "The maximum.
", "MetricDatapoint$minimum": "The minimum.
", @@ -4354,6 +4524,7 @@ "ContainerServiceHealthCheckConfig$intervalSeconds": "The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.
The size of the disk in GB (e.g., 32).
The size of the disk in GB (e.g., 32).
The percentage of completion for the operation.
", "Disk$sizeInGb": "The size of the disk in GB.
", "Disk$iops": "The input/output operations per second (IOPS) of the disk.
", "Disk$gbInUse": "(Deprecated) The number of GB in use by the disk.
In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.
The name of the add-on.
", "AddOn$status": "The status of the add-on.
", + "AddOn$threshold": "The trigger threshold of the action.
This add-on only applies to Lightsail for Research resources.
The amount of idle time in minutes after which your virtual computer will automatically stop.
This add-on only applies to Lightsail for Research resources.
The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.
", "AttachedDisk$path": "The path of the disk (e.g., /dev/xvdf).
The date of the automatic snapshot in YYYY-MM-DD format.
The name of the source disk from which the source automatic snapshot was created.
Constraints:
This parameter cannot be defined together with the disk snapshot name parameter. The source disk name and disk snapshot name parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.
Constraints:
Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
The bundle ID to use for the distribution.
A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota.
Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.
The reason the operation failed.
", "CreateInstancesFromSnapshotRequest$availabilityZone": "The Availability Zone where you want to create your instances. Use the following formatting: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.
You can create a launch script that configures a server with additional user data. For example, apt-get -y update.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.
The name of the source instance from which the source automatic snapshot was created.
Constraints:
This parameter cannot be defined together with the instance snapshot name parameter. The source instance name and instance snapshot name parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
", + "StopInstanceOnIdleRequest$threshold": "The value to compare with the duration.
", + "StopInstanceOnIdleRequest$duration": "The amount of idle time in minutes after which your virtual computer will automatically stop.
", "StringList$member": null, "UnauthenticatedException$code": null, "UnauthenticatedException$docs": null, diff --git a/models/apis/lightsail/2016-11-28/endpoint-rule-set-1.json b/models/apis/lightsail/2016-11-28/endpoint-rule-set-1.json index ee08de54218..9428d1992f5 100644 --- a/models/apis/lightsail/2016-11-28/endpoint-rule-set-1.json +++ b/models/apis/lightsail/2016-11-28/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,14 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -62,67 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -131,154 +111,215 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + }, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true ] } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], + ], "type": "tree", "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lightsail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, { "conditions": [], - "endpoint": { - "url": "https://lightsail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], + ], "type": "tree", "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lightsail-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, { "conditions": [], - "endpoint": { - "url": "https://lightsail-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lightsail.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], "type": "tree", @@ -286,7 +327,7 @@ { "conditions": [], "endpoint": { - "url": "https://lightsail.{Region}.{PartitionResult#dualStackDnsSuffix}", + "url": "https://lightsail.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, @@ -295,28 +336,13 @@ ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lightsail.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/models/apis/lightsail/2016-11-28/endpoint-tests-1.json b/models/apis/lightsail/2016-11-28/endpoint-tests-1.json index 26e14e9d4ed..ef083046452 100644 --- a/models/apis/lightsail/2016-11-28/endpoint-tests-1.json +++ b/models/apis/lightsail/2016-11-28/endpoint-tests-1.json @@ -9,8 +9,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -22,8 +22,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -35,8 +35,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -48,8 +48,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -61,8 +61,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -74,8 +74,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -87,8 +87,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -100,8 +100,8 @@ }, "params": { "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -113,8 +113,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -126,8 +126,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -139,8 +139,8 @@ }, "params": { "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -152,8 +152,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -165,8 +165,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -178,8 +178,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -191,8 +191,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -204,8 +204,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -217,8 +217,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -230,8 +230,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -243,8 +243,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -256,8 +256,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -269,8 +269,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -282,8 +282,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -295,8 +295,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -308,8 +308,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -321,8 +321,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -334,8 +334,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -347,8 +347,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -360,8 +360,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -373,12 +373,12 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" @@ -386,8 +386,21 @@ }, "params": { "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -398,8 +411,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -410,8 +423,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } } diff --git a/models/apis/managedblockchain/2018-09-24/api-2.json b/models/apis/managedblockchain/2018-09-24/api-2.json index ed25fbc91d1..a6d2ba0e71d 100644 --- a/models/apis/managedblockchain/2018-09-24/api-2.json +++ b/models/apis/managedblockchain/2018-09-24/api-2.json @@ -27,7 +27,8 @@ {"shape":"ResourceAlreadyExistsException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceLimitExceededException"}, - {"shape":"InternalServiceErrorException"} + {"shape":"InternalServiceErrorException"}, + {"shape":"TooManyTagsException"} ] }, "CreateMember":{ @@ -474,7 +475,8 @@ "BillingToken":{"shape":"AccessorBillingTokenString"}, "Status":{"shape":"AccessorStatus"}, "CreationDate":{"shape":"Timestamp"}, - "Arn":{"shape":"ArnString"} + "Arn":{"shape":"ArnString"}, + "Tags":{"shape":"OutputTagMap"} } }, "AccessorBillingTokenString":{ @@ -545,7 +547,8 @@ "shape":"ClientRequestTokenString", "idempotencyToken":true }, - "AccessorType":{"shape":"AccessorType"} + "AccessorType":{"shape":"AccessorType"}, + "Tags":{"shape":"InputTagMap"} } }, "CreateAccessorOutput":{ diff --git a/models/apis/managedblockchain/2018-09-24/docs-2.json b/models/apis/managedblockchain/2018-09-24/docs-2.json index d849b3c51cf..9eb7fbbcbfe 100644 --- a/models/apis/managedblockchain/2018-09-24/docs-2.json +++ b/models/apis/managedblockchain/2018-09-24/docs-2.json @@ -2,20 +2,20 @@ "version": "2.0", "service": "Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority.
Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source frameworks. Because of fundamental differences between the frameworks, some API actions or data types may only apply in the context of one framework and not the other. For example, actions related to Hyperledger Fabric network members such as CreateMember and DeleteMember don't apply to Ethereum.
The description for each action indicates the framework or frameworks to which it applies. Data types and properties that apply only in the context of a particular framework are similarly indicated.
", "operations": { - "CreateAccessor": "The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.
Creates a new accessor for use with Managed Blockchain Ethereum nodes. An accessor object is a container that has the information required for token based access to your Ethereum nodes.
", + "CreateAccessor": "Creates a new accessor for use with Managed Blockchain Ethereum nodes. An accessor contains information required for token based access to your Ethereum nodes.
", "CreateMember": "Creates a member within a Managed Blockchain network.
Applies only to Hyperledger Fabric.
", "CreateNetwork": "Creates a new blockchain network using Amazon Managed Blockchain.
Applies only to Hyperledger Fabric.
", "CreateNode": "Creates a node on the specified blockchain network.
Applies to Hyperledger Fabric and Ethereum.
", "CreateProposal": "Creates a proposal for a change to the network that other members of the network can vote on, for example, a proposal to add a new member to the network. Any member can create a proposal.
Applies only to Hyperledger Fabric.
", - "DeleteAccessor": "The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.
Deletes an accessor that your Amazon Web Services account owns. An accessor object is a container that has the information required for token based access to your Ethereum nodes including, the BILLING_TOKEN. After an accessor is deleted, the status of the accessor changes from AVAILABLE to PENDING_DELETION. An accessor in the PENDING_DELETION state can’t be used for new WebSocket requests or HTTP requests. However, WebSocket connections that were initiated while the accessor was in the AVAILABLE state remain open until they expire (up to 2 hours).
Deletes an accessor that your Amazon Web Services account owns. An accessor object is a container that has the information required for token based access to your Ethereum nodes including, the BILLING_TOKEN. After an accessor is deleted, the status of the accessor changes from AVAILABLE to PENDING_DELETION. An accessor in the PENDING_DELETION state can’t be used for new WebSocket requests or HTTP requests. However, WebSocket connections that were initiated while the accessor was in the AVAILABLE state remain open until they expire (up to 2 hours).
Deletes a member. Deleting a member removes the member and all associated resources from the network. DeleteMember can only be called for a specified MemberId if the principal performing the action is associated with the Amazon Web Services account that owns the member. In all other cases, the DeleteMember action is carried out as the result of an approved proposal to remove a member. If MemberId is the last member in a network specified by the last Amazon Web Services account, the network is deleted also.
Applies only to Hyperledger Fabric.
", "DeleteNode": "Deletes a node that your Amazon Web Services account owns. All data on the node is lost and cannot be recovered.
Applies to Hyperledger Fabric and Ethereum.
", - "GetAccessor": "The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.
Returns detailed information about an accessor. An accessor object is a container that has the information required for token based access to your Ethereum nodes.
", + "GetAccessor": "Returns detailed information about an accessor. An accessor object is a container that has the information required for token based access to your Ethereum nodes.
", "GetMember": "Returns detailed information about a member.
Applies only to Hyperledger Fabric.
", "GetNetwork": "Returns detailed information about a network.
Applies to Hyperledger Fabric and Ethereum.
", "GetNode": "Returns detailed information about a node.
Applies to Hyperledger Fabric and Ethereum.
", "GetProposal": "Returns detailed information about a proposal.
Applies only to Hyperledger Fabric.
", - "ListAccessors": "The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.
Returns a list of the accessors and their properties. Accessor objects are containers that have the information required for token based access to your Ethereum nodes.
", + "ListAccessors": "Returns a list of the accessors and their properties. Accessor objects are containers that have the information required for token based access to your Ethereum nodes.
", "ListInvitations": "Returns a list of all invitations for the current Amazon Web Services account.
Applies only to Hyperledger Fabric.
", "ListMembers": "Returns a list of the members in a network and properties of their configurations.
Applies only to Hyperledger Fabric.
", "ListNetworks": "Returns information about the networks in which the current Amazon Web Services account participates.
Applies to Hyperledger Fabric and Ethereum.
", @@ -37,7 +37,7 @@ } }, "Accessor": { - "base": "The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.
The properties of the Accessor.
", + "base": "The properties of the Accessor.
", "refs": { "GetAccessorOutput$Accessor": "The properties of the accessor.
" } @@ -63,7 +63,7 @@ } }, "AccessorSummary": { - "base": "The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.
A summary of accessor properties.
", + "base": "A summary of accessor properties.
", "refs": { "AccessorSummaryList$member": null } @@ -316,10 +316,11 @@ "InputTagMap": { "base": null, "refs": { - "CreateNetworkInput$Tags": "Tags to assign to the network. Each tag consists of a key and optional value.
When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
", - "CreateNodeInput$Tags": "Tags to assign to the node. Each tag consists of a key and optional value.
When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
", - "CreateProposalInput$Tags": "Tags to assign to the proposal. Each tag consists of a key and optional value.
When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource. If the proposal is for a network invitation, the invitation inherits the tags added to the proposal.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
", - "MemberConfiguration$Tags": "Tags assigned to the member. Tags consist of a key and optional value. For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.
", + "CreateAccessorInput$Tags": "Tags to assign to the Accessor.
Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
", + "CreateNetworkInput$Tags": "Tags to assign to the network.
Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
", + "CreateNodeInput$Tags": "Tags to assign to the node.
Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
", + "CreateProposalInput$Tags": "Tags to assign to the proposal.
Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
", + "MemberConfiguration$Tags": "Tags assigned to the member. Tags consist of a key and optional value.
When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
", "TagResourceRequest$Tags": "The tags to assign to the specified resource. Tag values can be empty, for example, \"MyTagKey\" : \"\". You can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.
The tags assigned to the Accessor.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
", "ListTagsForResourceResponse$Tags": "The tags assigned to the resource.
", - "Member$Tags": "Tags assigned to the member. Tags consist of a key and optional value. For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
", + "Member$Tags": "Tags assigned to the member. Tags consist of a key and optional value.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
", "Network$Tags": "Tags assigned to the network. Each tag consists of a key and optional value.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
", "Node$Tags": "Tags assigned to the node. Each tag consists of a key and optional value.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
", "Proposal$Tags": "Tags assigned to the proposal. Each tag consists of a key and optional value.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
" diff --git a/models/apis/managedblockchain/2018-09-24/endpoint-rule-set-1.json b/models/apis/managedblockchain/2018-09-24/endpoint-rule-set-1.json index 08b19332119..f33cf19b95f 100644 --- a/models/apis/managedblockchain/2018-09-24/endpoint-rule-set-1.json +++ b/models/apis/managedblockchain/2018-09-24/endpoint-rule-set-1.json @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,23 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -71,67 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -140,90 +111,215 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true ] } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://managedblockchain-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } ] }, { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsDualStack" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://managedblockchain-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://managedblockchain-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsFIPS" + true ] } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://managedblockchain.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], "type": "tree", @@ -231,7 +327,7 @@ { "conditions": [], "endpoint": { - "url": "https://managedblockchain-fips.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://managedblockchain.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, @@ -240,74 +336,13 @@ ] } ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://managedblockchain.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "endpoint": { - "url": "https://managedblockchain.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/models/apis/managedblockchain/2018-09-24/endpoint-tests-1.json b/models/apis/managedblockchain/2018-09-24/endpoint-tests-1.json index bd1d94336cf..b9af713af63 100644 --- a/models/apis/managedblockchain/2018-09-24/endpoint-tests-1.json +++ b/models/apis/managedblockchain/2018-09-24/endpoint-tests-1.json @@ -1,371 +1,294 @@ { "testCases": [ { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-fips.eu-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.eu-west-2.amazonaws.com" + "url": "https://managedblockchain.ap-northeast-1.amazonaws.com" } }, "params": { "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain.eu-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "ap-northeast-1" } }, { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.eu-west-2.amazonaws.com" + "url": "https://managedblockchain.ap-northeast-2.amazonaws.com" } }, "params": { "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "ap-northeast-2" } }, { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.eu-west-1.api.aws" + "url": "https://managedblockchain.ap-southeast-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-1" + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-1" } }, { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.eu-west-1.amazonaws.com" + "url": "https://managedblockchain.eu-west-1.amazonaws.com" } }, "params": { "UseDualStack": false, - "UseFIPS": true, + "UseFIPS": false, "Region": "eu-west-1" } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.eu-west-1.api.aws" + "url": "https://managedblockchain.eu-west-2.amazonaws.com" } }, "params": { - "UseDualStack": true, + "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-2" } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.eu-west-1.amazonaws.com" + "url": "https://managedblockchain.us-east-1.amazonaws.com" } }, "params": { "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "us-east-1" } }, { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.ap-northeast-2.api.aws" + "url": "https://managedblockchain-fips.us-east-1.api.aws" } }, "params": { "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "us-east-1" } }, { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.ap-northeast-2.amazonaws.com" + "url": "https://managedblockchain-fips.us-east-1.amazonaws.com" } }, "params": { "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "us-east-1" } }, { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://managedblockchain.ap-northeast-2.api.aws" + "url": "https://managedblockchain.us-east-1.api.aws" } }, "params": { "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "us-east-1" } }, { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.ap-northeast-1.api.aws" + "url": "https://managedblockchain-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "cn-north-1" } }, { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.ap-northeast-1.amazonaws.com" + "url": "https://managedblockchain-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "cn-north-1" } }, { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://managedblockchain.ap-northeast-1.api.aws" + "url": "https://managedblockchain.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "cn-north-1" } }, { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.ap-northeast-1.amazonaws.com" + "url": "https://managedblockchain.cn-north-1.amazonaws.com.cn" } }, "params": { "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "cn-north-1" } }, { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.us-gov-west-1.api.aws" + "url": "https://managedblockchain-fips.us-gov-east-1.api.aws" } }, "params": { "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-east-1" } }, { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.us-gov-west-1.amazonaws.com" + "url": "https://managedblockchain-fips.us-gov-east-1.amazonaws.com" } }, "params": { "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-east-1" } }, { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://managedblockchain.us-gov-west-1.api.aws" + "url": "https://managedblockchain.us-gov-east-1.api.aws" } }, "params": { "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-east-1" } }, { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.us-gov-west-1.amazonaws.com" + "url": "https://managedblockchain.us-gov-east-1.amazonaws.com" } }, "params": { "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-east-1" } }, { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.ap-southeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-fips.ap-southeast-1.amazonaws.com" + "url": "https://managedblockchain-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain.ap-southeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "us-iso-east-1" } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.ap-southeast-1.amazonaws.com" + "url": "https://managedblockchain.us-iso-east-1.c2s.ic.gov" } }, "params": { "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "us-iso-east-1" } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain-fips.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-fips.us-east-1.amazonaws.com" + "url": "https://managedblockchain-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-isob-east-1" } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.us-east-1.api.aws" + "url": "https://managedblockchain.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "UseDualStack": true, + "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-isob-east-1" } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { - "url": "https://managedblockchain.us-east-1.amazonaws.com" + "url": "https://example.com" } }, "params": { "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "Endpoint": "https://example.com" } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" @@ -374,7 +297,6 @@ "params": { "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, diff --git a/models/apis/omics/2022-11-28/api-2.json b/models/apis/omics/2022-11-28/api-2.json index 264f686220d..f9b93f068b8 100644 --- a/models/apis/omics/2022-11-28/api-2.json +++ b/models/apis/omics/2022-11-28/api-2.json @@ -2690,7 +2690,6 @@ "type": "structure" }, "AnnotationImportItemSources": { - "max": 1, "member": { "shape": "AnnotationImportItemSource" }, @@ -4935,7 +4934,8 @@ "IN_PROGRESS", "CANCELLED", "COMPLETED", - "FAILED" + "FAILED", + "COMPLETED_WITH_FAILURES" ], "type": "string" }, @@ -6580,7 +6580,7 @@ }, "SchemaItem": { "key": { - "shape": "String" + "shape": "SchemaItemKeyString" }, "max": 1, "min": 1, @@ -6589,6 +6589,10 @@ "shape": "SchemaValueType" } }, + "SchemaItemKeyString": { + "pattern": "^[a-z0-9_]{1,255}$", + "type": "string" + }, "SchemaValueType": { "enum": [ "LONG", @@ -7669,6 +7673,9 @@ }, "source": { "shape": "S3Uri" + }, + "statusMessage": { + "shape": "JobStatusMsg" } }, "required": [ @@ -7678,7 +7685,6 @@ "type": "structure" }, "VariantImportItemDetails": { - "max": 1, "member": { "shape": "VariantImportItemDetail" }, @@ -7697,7 +7703,6 @@ "type": "structure" }, "VariantImportItemSources": { - "max": 1, "member": { "shape": "VariantImportItemSource" }, @@ -7965,7 +7970,8 @@ "ACTIVE", "UPDATING", "DELETED", - "FAILED" + "FAILED", + "INACTIVE" ], "max": 64, "min": 1, @@ -7981,7 +7987,8 @@ }, "WorkflowType": { "enum": [ - "PRIVATE" + "PRIVATE", + "SERVICE" ], "max": 64, "min": 1, diff --git a/models/apis/omics/2022-11-28/defaults-1.json b/models/apis/omics/2022-11-28/defaults-1.json new file mode 100644 index 00000000000..3549611be0f --- /dev/null +++ b/models/apis/omics/2022-11-28/defaults-1.json @@ -0,0 +1,4 @@ +{ + "added": { + } +} diff --git a/models/apis/omics/2022-11-28/docs-2.json b/models/apis/omics/2022-11-28/docs-2.json index 881a1403107..82a1b17216d 100644 --- a/models/apis/omics/2022-11-28/docs-2.json +++ b/models/apis/omics/2022-11-28/docs-2.json @@ -56,8 +56,8 @@ "ListVariantStores": "Retrieves a list of variant stores.
", "ListWorkflows": "Retrieves a list of workflows.
", "StartAnnotationImportJob": "Starts an annotation import job.
", - "StartReadSetActivationJob": "Starts a read set activation job.
", - "StartReadSetExportJob": "Starts a read set export job.
", + "StartReadSetActivationJob": "Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read sets after 30 days.
", + "StartReadSetExportJob": "Exports a read set to Amazon S3.
", "StartReadSetImportJob": "Starts a read set import job.
", "StartReferenceImportJob": "Starts a reference import job.
", "StartRun": "Starts a run.
", @@ -102,7 +102,7 @@ "ActivateReadSetSourceList": { "base": null, "refs": { - "GetReadSetActivationJobResponse$sources": "The job's sources.
" + "GetReadSetActivationJobResponse$sources": "The job's source files.
" } }, "ActivationJobId": { @@ -303,7 +303,7 @@ "CreateRunGroupRequestMaxDurationInteger": { "base": null, "refs": { - "CreateRunGroupRequest$maxDuration": "A max duration for the group.
" + "CreateRunGroupRequest$maxDuration": "A maximum run time for the group in minutes.
" } }, "CreateRunGroupRequestMaxRunsInteger": { @@ -351,7 +351,7 @@ "CreateWorkflowRequestStorageCapacityInteger": { "base": null, "refs": { - "CreateWorkflowRequest$storageCapacity": "A storage capacity for the workflow.
" + "CreateWorkflowRequest$storageCapacity": "A storage capacity for the workflow in gigabytes.
" } }, "CreateWorkflowResponse": { @@ -721,7 +721,7 @@ "GetRunGroupResponseMaxDurationInteger": { "base": null, "refs": { - "GetRunGroupResponse$maxDuration": "The group's maximum run duration.
" + "GetRunGroupResponse$maxDuration": "The group's maximum run time in minutes.
" } }, "GetRunGroupResponseMaxRunsInteger": { @@ -749,7 +749,7 @@ "GetRunResponseStorageCapacityInteger": { "base": null, "refs": { - "GetRunResponse$storageCapacity": "The run's storage capacity.
" + "GetRunResponse$storageCapacity": "The run's storage capacity in gigabytes.
" } }, "GetRunTaskRequest": { @@ -771,7 +771,7 @@ "GetRunTaskResponseMemoryInteger": { "base": null, "refs": { - "GetRunTaskResponse$memory": "The task's memory setting.
" + "GetRunTaskResponse$memory": "The task's memory use in gigabytes.
" } }, "GetSequenceStoreRequest": { @@ -817,7 +817,7 @@ "GetWorkflowResponseStorageCapacityInteger": { "base": null, "refs": { - "GetWorkflowResponse$storageCapacity": "The workflow's storage capacity.
" + "GetWorkflowResponse$storageCapacity": "The workflow's storage capacity in gigabytes.
" } }, "Header": { @@ -866,7 +866,7 @@ "ImportReadSetSourceList": { "base": null, "refs": { - "GetReadSetImportJobResponse$sources": "The job's sources.
" + "GetReadSetImportJobResponse$sources": "The job's source files.
" } }, "ImportReferenceFilter": { @@ -896,7 +896,7 @@ "ImportReferenceSourceList": { "base": null, "refs": { - "GetReferenceImportJobResponse$sources": "The job's sources.
" + "GetReferenceImportJobResponse$sources": "The job's source files.
" } }, "InternalServerException": { @@ -934,7 +934,8 @@ "base": null, "refs": { "GetAnnotationImportResponse$statusMessage": "The job's status message.
", - "GetVariantImportResponse$statusMessage": "The job's status message.
" + "GetVariantImportResponse$statusMessage": "The job's status message.
", + "VariantImportItemDetail$statusMessage": "A message that provides additional context about a job
" } }, "LineSep": { @@ -1575,7 +1576,7 @@ "refs": { "AnnotationStoreItem$reference": "The store's genome reference.
", "CreateAnnotationStoreRequest$reference": "The genome reference for the store's annotations.
", - "CreateAnnotationStoreResponse$reference": "The store's genome reference.
", + "CreateAnnotationStoreResponse$reference": "The store's genome reference. Required for all stores except TSV format with generic annotations.
", "CreateVariantStoreRequest$reference": "The genome reference for the store's variants.
", "CreateVariantStoreResponse$reference": "The store's genome reference.
", "GetAnnotationStoreResponse$reference": "The store's genome reference.
", @@ -1804,7 +1805,7 @@ "RunGroupListItemMaxDurationInteger": { "base": null, "refs": { - "RunGroupListItem$maxDuration": "The group's maximum duration setting.
" + "RunGroupListItem$maxDuration": "The group's maximum duration setting in minutes.
" } }, "RunGroupListItemMaxRunsInteger": { @@ -1833,7 +1834,7 @@ "RunGroupRequestId": { "base": null, "refs": { - "CreateRunGroupRequest$requestId": "A request ID for the group.
" + "CreateRunGroupRequest$requestId": "To ensure that requests don't run multiple times, specify a unique ID for each request.
" } }, "RunGroupTimestamp": { @@ -1933,7 +1934,7 @@ "RunRequestId": { "base": null, "refs": { - "StartRunRequest$requestId": "A request ID for the run.
" + "StartRunRequest$requestId": "To ensure that requests don't run multiple times, specify a unique ID for each request.
" } }, "RunResourceDigest": { @@ -2029,6 +2030,12 @@ "TsvStoreOptionsSchemaList$member": null } }, + "SchemaItemKeyString": { + "base": null, + "refs": { + "SchemaItem$key": null + } + }, "SchemaValueType": { "base": null, "refs": { @@ -2182,7 +2189,7 @@ "StartReadSetActivationJobRequestSourcesList": { "base": null, "refs": { - "StartReadSetActivationJobRequest$sources": "The job's sources.
" + "StartReadSetActivationJobRequest$sources": "The job's source files.
" } }, "StartReadSetActivationJobResponse": { @@ -2204,7 +2211,7 @@ "StartReadSetExportJobRequestSourcesList": { "base": null, "refs": { - "StartReadSetExportJobRequest$sources": "Sources for the job.
" + "StartReadSetExportJobRequest$sources": "The job's source files.
" } }, "StartReadSetExportJobResponse": { @@ -2220,7 +2227,7 @@ "StartReadSetImportJobRequestSourcesList": { "base": null, "refs": { - "StartReadSetImportJobRequest$sources": "Source files to import.
" + "StartReadSetImportJobRequest$sources": "The job's source files.
" } }, "StartReadSetImportJobResponse": { @@ -2242,7 +2249,7 @@ "StartReferenceImportJobRequestSourcesList": { "base": null, "refs": { - "StartReferenceImportJobRequest$sources": "Sources for the job.
" + "StartReferenceImportJobRequest$sources": "The job's source files.
" } }, "StartReferenceImportJobResponse": { @@ -2270,7 +2277,7 @@ "StartRunRequestStorageCapacityInteger": { "base": null, "refs": { - "StartRunRequest$storageCapacity": "A storage capacity for the run.
" + "StartRunRequest$storageCapacity": "A storage capacity for the run in gigabytes.
" } }, "StartRunResponse": { @@ -2385,7 +2392,6 @@ "ReadSetBatchError$message": "The error's message.
", "RequestTimeoutException$message": null, "ResourceNotFoundException$message": null, - "SchemaItem$key": null, "SequenceInformation$alignment": "The sequence's alignment setting.
", "ServiceQuotaExceededException$message": null, "ThrottlingException$message": null, @@ -2560,7 +2566,7 @@ "TaskListItemMemoryInteger": { "base": null, "refs": { - "TaskListItem$memory": "The task's memory.
" + "TaskListItem$memory": "The task's memory use in gigabyes.
" } }, "TaskListToken": { @@ -2665,7 +2671,7 @@ "UpdateRunGroupRequestMaxDurationInteger": { "base": null, "refs": { - "UpdateRunGroupRequest$maxDuration": "The maximum amount of time to run.
" + "UpdateRunGroupRequest$maxDuration": "A maximum run time for the group in minutes.
" } }, "UpdateRunGroupRequestMaxRunsInteger": { @@ -2892,7 +2898,7 @@ "WorkflowRequestId": { "base": null, "refs": { - "CreateWorkflowRequest$requestId": "A request ID for the workflow.
" + "CreateWorkflowRequest$requestId": "To ensure that requests don't run multiple times, specify a unique ID for each request.
" } }, "WorkflowStatus": { diff --git a/models/apis/omics/2022-11-28/endpoint-rule-set-1.json b/models/apis/omics/2022-11-28/endpoint-rule-set-1.json index 8c1b3668fb9..76599609af3 100644 --- a/models/apis/omics/2022-11-28/endpoint-rule-set-1.json +++ b/models/apis/omics/2022-11-28/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,23 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -71,67 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -140,168 +111,238 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + }, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] }, - "supportsDualStack" + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://omics-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://omics-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://omics-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://omics-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://omics.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], - "endpoint": { - "url": "https://omics.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://omics.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "endpoint": { - "url": "https://omics.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/models/apis/omics/2022-11-28/endpoint-tests-1.json b/models/apis/omics/2022-11-28/endpoint-tests-1.json index 485293e3915..4770b5497f2 100644 --- a/models/apis/omics/2022-11-28/endpoint-tests-1.json +++ b/models/apis/omics/2022-11-28/endpoint-tests-1.json @@ -8,9 +8,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -21,9 +21,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -34,9 +34,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -47,9 +47,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -60,9 +60,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -73,9 +73,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -86,9 +86,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -99,9 +99,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -110,9 +110,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -123,9 +123,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -134,9 +134,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -147,9 +147,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -160,9 +160,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -173,9 +173,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -186,9 +186,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -199,9 +199,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -210,9 +210,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -223,9 +223,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -234,9 +234,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -247,9 +247,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -260,9 +260,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -272,9 +272,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -284,9 +284,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } } diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 2c143f81dcc..d4a94f1e376 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -1666,6 +1666,9 @@ "apprunner" : { "endpoints" : { "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, "eu-west-1" : { }, "fips-us-east-1" : { "credentialScope" : { diff --git a/service/comprehend/api.go b/service/comprehend/api.go index 6958d513192..0a9d26c001b 100644 --- a/service/comprehend/api.go +++ b/service/comprehend/api.go @@ -790,6 +790,111 @@ func (c *Comprehend) ContainsPiiEntitiesWithContext(ctx aws.Context, input *Cont return out, req.Send() } +const opCreateDataset = "CreateDataset" + +// CreateDatasetRequest generates a "aws/request.Request" representing the +// client's request for the CreateDataset 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 CreateDataset for more information on using the CreateDataset +// 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 CreateDatasetRequest method. +// req, resp := client.CreateDatasetRequest(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/CreateDataset +func (c *Comprehend) CreateDatasetRequest(input *CreateDatasetInput) (req *request.Request, output *CreateDatasetOutput) { + op := &request.Operation{ + Name: opCreateDataset, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateDatasetInput{} + } + + output = &CreateDatasetOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateDataset API operation for Amazon Comprehend. +// +// Creates a dataset to upload training or test data for a model associated +// with a flywheel. For more information about datasets, see Flywheel overview +// (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in +// the Amazon Comprehend Developer Guide. +// +// 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 CreateDataset for usage and error information. +// +// Returned Error Types: +// +// - InvalidRequestException +// The request is invalid. +// +// - ResourceInUseException +// The specified resource name is already in use. Use a different name and try +// your request again. +// +// - 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. +// +// - TooManyRequestsException +// The number of requests exceeds the limit. Resubmit your request later. +// +// - ResourceLimitExceededException +// The maximum number of resources per account has been exceeded. Review the +// resources, and then try your request again. +// +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. +// +// - InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDataset +func (c *Comprehend) CreateDataset(input *CreateDatasetInput) (*CreateDatasetOutput, error) { + req, out := c.CreateDatasetRequest(input) + return out, req.Send() +} + +// CreateDatasetWithContext is the same as CreateDataset with the addition of +// the ability to pass a context and additional request options. +// +// See CreateDataset 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) CreateDatasetWithContext(ctx aws.Context, input *CreateDatasetInput, opts ...request.Option) (*CreateDatasetOutput, error) { + req, out := c.CreateDatasetRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateDocumentClassifier = "CreateDocumentClassifier" // CreateDocumentClassifierRequest generates a "aws/request.Request" representing the @@ -1056,7 +1161,8 @@ func (c *Comprehend) CreateEntityRecognizerRequest(input *CreateEntityRecognizer // CreateEntityRecognizer API operation for Amazon Comprehend. // // Creates an entity recognizer using submitted files. After your CreateEntityRecognizer -// request is submitted, you can check job status using the API. +// request is submitted, you can check job status using the DescribeEntityRecognizer +// API. // // 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 @@ -1122,6 +1228,140 @@ func (c *Comprehend) CreateEntityRecognizerWithContext(ctx aws.Context, input *C return out, req.Send() } +const opCreateFlywheel = "CreateFlywheel" + +// CreateFlywheelRequest generates a "aws/request.Request" representing the +// client's request for the CreateFlywheel 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 CreateFlywheel for more information on using the CreateFlywheel +// 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 CreateFlywheelRequest method. +// req, resp := client.CreateFlywheelRequest(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/CreateFlywheel +func (c *Comprehend) CreateFlywheelRequest(input *CreateFlywheelInput) (req *request.Request, output *CreateFlywheelOutput) { + op := &request.Operation{ + Name: opCreateFlywheel, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateFlywheelInput{} + } + + output = &CreateFlywheelOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateFlywheel API operation for Amazon Comprehend. +// +// A flywheel is an AWS resource that orchestrates the ongoing training of a +// model for custom classification or custom entity recognition. You can create +// a flywheel to start with an existing trained model, or Comprehend can create +// and train a new model. +// +// When you create the flywheel, Comprehend creates a data lake in your account. +// The data lake holds the training data and test data for all versions of the +// model. +// +// To use a flywheel with an existing trained model, you specify the active +// model version. Comprehend copies the model's training data and test data +// into the flywheel's data lake. +// +// To use the flywheel with a new model, you need to provide a dataset for training +// data (and optional test data) when you create the flywheel. +// +// For more information about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. +// +// 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 CreateFlywheel for usage and error information. +// +// Returned Error Types: +// +// - InvalidRequestException +// The request is invalid. +// +// - ResourceInUseException +// The specified resource name is already in use. Use a different name and try +// your request again. +// +// - 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. +// +// - TooManyRequestsException +// The number of requests exceeds the limit. Resubmit your request later. +// +// - ResourceLimitExceededException +// The maximum number of resources per account has been exceeded. Review the +// resources, and then try your request again. +// +// - UnsupportedLanguageException +// Amazon Comprehend can't process the language of the input text. For custom +// entity recognition APIs, only English, Spanish, French, Italian, German, +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. +// +// - KmsKeyValidationException +// The KMS customer managed key (CMK) entered cannot be validated. Verify the +// key and re-enter it. +// +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. +// +// - ResourceUnavailableException +// The specified resource is not available. Check the resource and try your +// request again. +// +// - InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateFlywheel +func (c *Comprehend) CreateFlywheel(input *CreateFlywheelInput) (*CreateFlywheelOutput, error) { + req, out := c.CreateFlywheelRequest(input) + return out, req.Send() +} + +// CreateFlywheelWithContext is the same as CreateFlywheel with the addition of +// the ability to pass a context and additional request options. +// +// See CreateFlywheel 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) CreateFlywheelWithContext(ctx aws.Context, input *CreateFlywheelInput, opts ...request.Option) (*CreateFlywheelOutput, error) { + req, out := c.CreateFlywheelRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteDocumentClassifier = "DeleteDocumentClassifier" // DeleteDocumentClassifierRequest generates a "aws/request.Request" representing the @@ -1430,164 +1670,357 @@ func (c *Comprehend) DeleteEntityRecognizerWithContext(ctx aws.Context, input *D return out, req.Send() } -const opDeleteResourcePolicy = "DeleteResourcePolicy" +const opDeleteFlywheel = "DeleteFlywheel" -// DeleteResourcePolicyRequest generates a "aws/request.Request" representing the -// client's request for the DeleteResourcePolicy operation. The "output" return +// DeleteFlywheelRequest generates a "aws/request.Request" representing the +// client's request for the DeleteFlywheel 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 DeleteResourcePolicy for more information on using the DeleteResourcePolicy +// See DeleteFlywheel for more information on using the DeleteFlywheel // 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 DeleteResourcePolicyRequest method. -// req, resp := client.DeleteResourcePolicyRequest(params) +// // Example sending a request using the DeleteFlywheelRequest method. +// req, resp := client.DeleteFlywheelRequest(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/DeleteResourcePolicy -func (c *Comprehend) DeleteResourcePolicyRequest(input *DeleteResourcePolicyInput) (req *request.Request, output *DeleteResourcePolicyOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteFlywheel +func (c *Comprehend) DeleteFlywheelRequest(input *DeleteFlywheelInput) (req *request.Request, output *DeleteFlywheelOutput) { op := &request.Operation{ - Name: opDeleteResourcePolicy, + Name: opDeleteFlywheel, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DeleteResourcePolicyInput{} + input = &DeleteFlywheelInput{} } - output = &DeleteResourcePolicyOutput{} + output = &DeleteFlywheelOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DeleteResourcePolicy API operation for Amazon Comprehend. +// DeleteFlywheel API operation for Amazon Comprehend. // -// Deletes a resource-based policy that is attached to a custom model. +// Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does +// not delete the data lake or the model associated with the flywheel. +// +// For more information about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. // // 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 DeleteResourcePolicy for usage and error information. +// API operation DeleteFlywheel 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. +// // - ResourceNotFoundException // The specified resource ARN was not found. Check the ARN and try your request // again. // +// - ResourceUnavailableException +// The specified resource is not available. Check the resource and try your +// request again. +// +// - ResourceInUseException +// The specified resource name is already in use. Use a different name and try +// your request again. +// // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteResourcePolicy -func (c *Comprehend) DeleteResourcePolicy(input *DeleteResourcePolicyInput) (*DeleteResourcePolicyOutput, error) { - req, out := c.DeleteResourcePolicyRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteFlywheel +func (c *Comprehend) DeleteFlywheel(input *DeleteFlywheelInput) (*DeleteFlywheelOutput, error) { + req, out := c.DeleteFlywheelRequest(input) return out, req.Send() } -// DeleteResourcePolicyWithContext is the same as DeleteResourcePolicy with the addition of +// DeleteFlywheelWithContext is the same as DeleteFlywheel with the addition of // the ability to pass a context and additional request options. // -// See DeleteResourcePolicy for details on how to use this API operation. +// See DeleteFlywheel 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) DeleteResourcePolicyWithContext(ctx aws.Context, input *DeleteResourcePolicyInput, opts ...request.Option) (*DeleteResourcePolicyOutput, error) { - req, out := c.DeleteResourcePolicyRequest(input) +func (c *Comprehend) DeleteFlywheelWithContext(ctx aws.Context, input *DeleteFlywheelInput, opts ...request.Option) (*DeleteFlywheelOutput, error) { + req, out := c.DeleteFlywheelRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeDocumentClassificationJob = "DescribeDocumentClassificationJob" +const opDeleteResourcePolicy = "DeleteResourcePolicy" -// DescribeDocumentClassificationJobRequest generates a "aws/request.Request" representing the -// client's request for the DescribeDocumentClassificationJob operation. The "output" return +// DeleteResourcePolicyRequest generates a "aws/request.Request" representing the +// client's request for the DeleteResourcePolicy 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 DescribeDocumentClassificationJob for more information on using the DescribeDocumentClassificationJob +// See DeleteResourcePolicy for more information on using the DeleteResourcePolicy // 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 DescribeDocumentClassificationJobRequest method. -// req, resp := client.DescribeDocumentClassificationJobRequest(params) +// // Example sending a request using the DeleteResourcePolicyRequest method. +// req, resp := client.DeleteResourcePolicyRequest(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/DescribeDocumentClassificationJob -func (c *Comprehend) DescribeDocumentClassificationJobRequest(input *DescribeDocumentClassificationJobInput) (req *request.Request, output *DescribeDocumentClassificationJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteResourcePolicy +func (c *Comprehend) DeleteResourcePolicyRequest(input *DeleteResourcePolicyInput) (req *request.Request, output *DeleteResourcePolicyOutput) { op := &request.Operation{ - Name: opDescribeDocumentClassificationJob, + Name: opDeleteResourcePolicy, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DescribeDocumentClassificationJobInput{} + input = &DeleteResourcePolicyInput{} } - output = &DescribeDocumentClassificationJobOutput{} + output = &DeleteResourcePolicyOutput{} req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DescribeDocumentClassificationJob API operation for Amazon Comprehend. +// DeleteResourcePolicy API operation for Amazon Comprehend. // -// Gets the properties associated with a document classification job. Use this -// operation to get the status of a classification job. +// Deletes a resource-based policy that is attached to a custom model. // // 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 DescribeDocumentClassificationJob for usage and error information. +// API operation DeleteResourcePolicy 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. -// -// - JobNotFoundException -// The specified job was not found. Check the job ID and try again. +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassificationJob -func (c *Comprehend) DescribeDocumentClassificationJob(input *DescribeDocumentClassificationJobInput) (*DescribeDocumentClassificationJobOutput, error) { - req, out := c.DescribeDocumentClassificationJobRequest(input) - return out, req.Send() +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteResourcePolicy +func (c *Comprehend) DeleteResourcePolicy(input *DeleteResourcePolicyInput) (*DeleteResourcePolicyOutput, error) { + req, out := c.DeleteResourcePolicyRequest(input) + return out, req.Send() +} + +// DeleteResourcePolicyWithContext is the same as DeleteResourcePolicy with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteResourcePolicy 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) DeleteResourcePolicyWithContext(ctx aws.Context, input *DeleteResourcePolicyInput, opts ...request.Option) (*DeleteResourcePolicyOutput, error) { + req, out := c.DeleteResourcePolicyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeDataset = "DescribeDataset" + +// DescribeDatasetRequest generates a "aws/request.Request" representing the +// client's request for the DescribeDataset 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 DescribeDataset for more information on using the DescribeDataset +// 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 DescribeDatasetRequest method. +// req, resp := client.DescribeDatasetRequest(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/DescribeDataset +func (c *Comprehend) DescribeDatasetRequest(input *DescribeDatasetInput) (req *request.Request, output *DescribeDatasetOutput) { + op := &request.Operation{ + Name: opDescribeDataset, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeDatasetInput{} + } + + output = &DescribeDatasetOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeDataset API operation for Amazon Comprehend. +// +// Returns information about the dataset that you specify. For more information +// about datasets, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. +// +// 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 DescribeDataset 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. +// +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. +// +// - InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDataset +func (c *Comprehend) DescribeDataset(input *DescribeDatasetInput) (*DescribeDatasetOutput, error) { + req, out := c.DescribeDatasetRequest(input) + return out, req.Send() +} + +// DescribeDatasetWithContext is the same as DescribeDataset with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeDataset 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) DescribeDatasetWithContext(ctx aws.Context, input *DescribeDatasetInput, opts ...request.Option) (*DescribeDatasetOutput, error) { + req, out := c.DescribeDatasetRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeDocumentClassificationJob = "DescribeDocumentClassificationJob" + +// DescribeDocumentClassificationJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribeDocumentClassificationJob 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 DescribeDocumentClassificationJob for more information on using the DescribeDocumentClassificationJob +// 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 DescribeDocumentClassificationJobRequest method. +// req, resp := client.DescribeDocumentClassificationJobRequest(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/DescribeDocumentClassificationJob +func (c *Comprehend) DescribeDocumentClassificationJobRequest(input *DescribeDocumentClassificationJobInput) (req *request.Request, output *DescribeDocumentClassificationJobOutput) { + op := &request.Operation{ + Name: opDescribeDocumentClassificationJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeDocumentClassificationJobInput{} + } + + output = &DescribeDocumentClassificationJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeDocumentClassificationJob API operation for Amazon Comprehend. +// +// Gets the properties associated with a document classification job. Use this +// operation to get the status of a classification 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 DescribeDocumentClassificationJob 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. +// +// - 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/DescribeDocumentClassificationJob +func (c *Comprehend) DescribeDocumentClassificationJob(input *DescribeDocumentClassificationJobInput) (*DescribeDocumentClassificationJobOutput, error) { + req, out := c.DescribeDocumentClassificationJobRequest(input) + return out, req.Send() } // DescribeDocumentClassificationJobWithContext is the same as DescribeDocumentClassificationJob with the addition of @@ -2142,248 +2575,430 @@ func (c *Comprehend) DescribeEventsDetectionJobWithContext(ctx aws.Context, inpu return out, req.Send() } -const opDescribeKeyPhrasesDetectionJob = "DescribeKeyPhrasesDetectionJob" +const opDescribeFlywheel = "DescribeFlywheel" -// DescribeKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the DescribeKeyPhrasesDetectionJob operation. The "output" return +// DescribeFlywheelRequest generates a "aws/request.Request" representing the +// client's request for the DescribeFlywheel 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 DescribeKeyPhrasesDetectionJob for more information on using the DescribeKeyPhrasesDetectionJob +// See DescribeFlywheel for more information on using the DescribeFlywheel // 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 DescribeKeyPhrasesDetectionJobRequest method. -// req, resp := client.DescribeKeyPhrasesDetectionJobRequest(params) +// // Example sending a request using the DescribeFlywheelRequest method. +// req, resp := client.DescribeFlywheelRequest(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/DescribeKeyPhrasesDetectionJob -func (c *Comprehend) DescribeKeyPhrasesDetectionJobRequest(input *DescribeKeyPhrasesDetectionJobInput) (req *request.Request, output *DescribeKeyPhrasesDetectionJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheel +func (c *Comprehend) DescribeFlywheelRequest(input *DescribeFlywheelInput) (req *request.Request, output *DescribeFlywheelOutput) { op := &request.Operation{ - Name: opDescribeKeyPhrasesDetectionJob, + Name: opDescribeFlywheel, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DescribeKeyPhrasesDetectionJobInput{} + input = &DescribeFlywheelInput{} } - output = &DescribeKeyPhrasesDetectionJobOutput{} + output = &DescribeFlywheelOutput{} req = c.newRequest(op, input, output) return } -// DescribeKeyPhrasesDetectionJob API operation for Amazon Comprehend. +// DescribeFlywheel API operation for Amazon Comprehend. // -// Gets the properties associated with a key phrases detection job. Use this -// operation to get the status of a detection job. +// Provides configuration information about the flywheel. For more information +// about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. // // 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 DescribeKeyPhrasesDetectionJob for usage and error information. +// API operation DescribeFlywheel 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. // +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. +// // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeKeyPhrasesDetectionJob -func (c *Comprehend) DescribeKeyPhrasesDetectionJob(input *DescribeKeyPhrasesDetectionJobInput) (*DescribeKeyPhrasesDetectionJobOutput, error) { - req, out := c.DescribeKeyPhrasesDetectionJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheel +func (c *Comprehend) DescribeFlywheel(input *DescribeFlywheelInput) (*DescribeFlywheelOutput, error) { + req, out := c.DescribeFlywheelRequest(input) return out, req.Send() } -// DescribeKeyPhrasesDetectionJobWithContext is the same as DescribeKeyPhrasesDetectionJob with the addition of +// DescribeFlywheelWithContext is the same as DescribeFlywheel with the addition of // the ability to pass a context and additional request options. // -// See DescribeKeyPhrasesDetectionJob for details on how to use this API operation. +// See DescribeFlywheel 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) DescribeKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *DescribeKeyPhrasesDetectionJobInput, opts ...request.Option) (*DescribeKeyPhrasesDetectionJobOutput, error) { - req, out := c.DescribeKeyPhrasesDetectionJobRequest(input) +func (c *Comprehend) DescribeFlywheelWithContext(ctx aws.Context, input *DescribeFlywheelInput, opts ...request.Option) (*DescribeFlywheelOutput, error) { + req, out := c.DescribeFlywheelRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribePiiEntitiesDetectionJob = "DescribePiiEntitiesDetectionJob" +const opDescribeFlywheelIteration = "DescribeFlywheelIteration" -// DescribePiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the DescribePiiEntitiesDetectionJob operation. The "output" return +// DescribeFlywheelIterationRequest generates a "aws/request.Request" representing the +// client's request for the DescribeFlywheelIteration 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 DescribePiiEntitiesDetectionJob for more information on using the DescribePiiEntitiesDetectionJob +// See DescribeFlywheelIteration for more information on using the DescribeFlywheelIteration // 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 DescribePiiEntitiesDetectionJobRequest method. -// req, resp := client.DescribePiiEntitiesDetectionJobRequest(params) +// // Example sending a request using the DescribeFlywheelIterationRequest method. +// req, resp := client.DescribeFlywheelIterationRequest(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/DescribePiiEntitiesDetectionJob -func (c *Comprehend) DescribePiiEntitiesDetectionJobRequest(input *DescribePiiEntitiesDetectionJobInput) (req *request.Request, output *DescribePiiEntitiesDetectionJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheelIteration +func (c *Comprehend) DescribeFlywheelIterationRequest(input *DescribeFlywheelIterationInput) (req *request.Request, output *DescribeFlywheelIterationOutput) { op := &request.Operation{ - Name: opDescribePiiEntitiesDetectionJob, + Name: opDescribeFlywheelIteration, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DescribePiiEntitiesDetectionJobInput{} + input = &DescribeFlywheelIterationInput{} } - output = &DescribePiiEntitiesDetectionJobOutput{} + output = &DescribeFlywheelIterationOutput{} req = c.newRequest(op, input, output) return } -// DescribePiiEntitiesDetectionJob API operation for Amazon Comprehend. +// DescribeFlywheelIteration API operation for Amazon Comprehend. // -// Gets the properties associated with a PII entities detection job. For example, -// you can use this operation to get the job status. +// Retrieve the configuration properties of a flywheel iteration. For more information +// about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. // // 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 DescribePiiEntitiesDetectionJob for usage and error information. +// API operation DescribeFlywheelIteration 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. // +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. +// // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJob -func (c *Comprehend) DescribePiiEntitiesDetectionJob(input *DescribePiiEntitiesDetectionJobInput) (*DescribePiiEntitiesDetectionJobOutput, error) { - req, out := c.DescribePiiEntitiesDetectionJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheelIteration +func (c *Comprehend) DescribeFlywheelIteration(input *DescribeFlywheelIterationInput) (*DescribeFlywheelIterationOutput, error) { + req, out := c.DescribeFlywheelIterationRequest(input) return out, req.Send() } -// DescribePiiEntitiesDetectionJobWithContext is the same as DescribePiiEntitiesDetectionJob with the addition of +// DescribeFlywheelIterationWithContext is the same as DescribeFlywheelIteration with the addition of // the ability to pass a context and additional request options. // -// See DescribePiiEntitiesDetectionJob for details on how to use this API operation. +// See DescribeFlywheelIteration 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) DescribePiiEntitiesDetectionJobWithContext(ctx aws.Context, input *DescribePiiEntitiesDetectionJobInput, opts ...request.Option) (*DescribePiiEntitiesDetectionJobOutput, error) { - req, out := c.DescribePiiEntitiesDetectionJobRequest(input) +func (c *Comprehend) DescribeFlywheelIterationWithContext(ctx aws.Context, input *DescribeFlywheelIterationInput, opts ...request.Option) (*DescribeFlywheelIterationOutput, error) { + req, out := c.DescribeFlywheelIterationRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeResourcePolicy = "DescribeResourcePolicy" +const opDescribeKeyPhrasesDetectionJob = "DescribeKeyPhrasesDetectionJob" -// DescribeResourcePolicyRequest generates a "aws/request.Request" representing the -// client's request for the DescribeResourcePolicy operation. The "output" return +// DescribeKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribeKeyPhrasesDetectionJob 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 DescribeResourcePolicy for more information on using the DescribeResourcePolicy +// See DescribeKeyPhrasesDetectionJob for more information on using the DescribeKeyPhrasesDetectionJob // 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 DescribeResourcePolicyRequest method. -// req, resp := client.DescribeResourcePolicyRequest(params) +// // Example sending a request using the DescribeKeyPhrasesDetectionJobRequest method. +// req, resp := client.DescribeKeyPhrasesDetectionJobRequest(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/DescribeResourcePolicy -func (c *Comprehend) DescribeResourcePolicyRequest(input *DescribeResourcePolicyInput) (req *request.Request, output *DescribeResourcePolicyOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeKeyPhrasesDetectionJob +func (c *Comprehend) DescribeKeyPhrasesDetectionJobRequest(input *DescribeKeyPhrasesDetectionJobInput) (req *request.Request, output *DescribeKeyPhrasesDetectionJobOutput) { op := &request.Operation{ - Name: opDescribeResourcePolicy, + Name: opDescribeKeyPhrasesDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DescribeResourcePolicyInput{} + input = &DescribeKeyPhrasesDetectionJobInput{} } - output = &DescribeResourcePolicyOutput{} + output = &DescribeKeyPhrasesDetectionJobOutput{} req = c.newRequest(op, input, output) return } -// DescribeResourcePolicy API operation for Amazon Comprehend. +// DescribeKeyPhrasesDetectionJob API operation for Amazon Comprehend. // -// Gets the details of a resource-based policy that is attached to a custom -// model, including the JSON body of the policy. +// Gets the properties associated with a key phrases detection job. Use this +// operation to get the status of a detection 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 DescribeResourcePolicy for usage and error information. +// API operation DescribeKeyPhrasesDetectionJob for usage and error information. // // Returned Error Types: // // - InvalidRequestException // The request is invalid. // -// - ResourceNotFoundException -// The specified resource ARN was not found. Check the ARN and try your request -// again. +// - JobNotFoundException +// The specified job was not found. Check the job ID and try again. // -// - InternalServerException -// An internal server error occurred. Retry your request. +// - 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/DescribeKeyPhrasesDetectionJob +func (c *Comprehend) DescribeKeyPhrasesDetectionJob(input *DescribeKeyPhrasesDetectionJobInput) (*DescribeKeyPhrasesDetectionJobOutput, error) { + req, out := c.DescribeKeyPhrasesDetectionJobRequest(input) + return out, req.Send() +} + +// DescribeKeyPhrasesDetectionJobWithContext is the same as DescribeKeyPhrasesDetectionJob with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeKeyPhrasesDetectionJob 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) DescribeKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *DescribeKeyPhrasesDetectionJobInput, opts ...request.Option) (*DescribeKeyPhrasesDetectionJobOutput, error) { + req, out := c.DescribeKeyPhrasesDetectionJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribePiiEntitiesDetectionJob = "DescribePiiEntitiesDetectionJob" + +// DescribePiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribePiiEntitiesDetectionJob 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 DescribePiiEntitiesDetectionJob for more information on using the DescribePiiEntitiesDetectionJob +// 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 DescribePiiEntitiesDetectionJobRequest method. +// req, resp := client.DescribePiiEntitiesDetectionJobRequest(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/DescribePiiEntitiesDetectionJob +func (c *Comprehend) DescribePiiEntitiesDetectionJobRequest(input *DescribePiiEntitiesDetectionJobInput) (req *request.Request, output *DescribePiiEntitiesDetectionJobOutput) { + op := &request.Operation{ + Name: opDescribePiiEntitiesDetectionJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribePiiEntitiesDetectionJobInput{} + } + + output = &DescribePiiEntitiesDetectionJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribePiiEntitiesDetectionJob API operation for Amazon Comprehend. +// +// Gets the properties associated with a PII entities detection job. For example, +// you can use this operation to get the job status. +// +// 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 DescribePiiEntitiesDetectionJob 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/DescribePiiEntitiesDetectionJob +func (c *Comprehend) DescribePiiEntitiesDetectionJob(input *DescribePiiEntitiesDetectionJobInput) (*DescribePiiEntitiesDetectionJobOutput, error) { + req, out := c.DescribePiiEntitiesDetectionJobRequest(input) + return out, req.Send() +} + +// DescribePiiEntitiesDetectionJobWithContext is the same as DescribePiiEntitiesDetectionJob with the addition of +// the ability to pass a context and additional request options. +// +// See DescribePiiEntitiesDetectionJob 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) DescribePiiEntitiesDetectionJobWithContext(ctx aws.Context, input *DescribePiiEntitiesDetectionJobInput, opts ...request.Option) (*DescribePiiEntitiesDetectionJobOutput, error) { + req, out := c.DescribePiiEntitiesDetectionJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeResourcePolicy = "DescribeResourcePolicy" + +// DescribeResourcePolicyRequest generates a "aws/request.Request" representing the +// client's request for the DescribeResourcePolicy 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 DescribeResourcePolicy for more information on using the DescribeResourcePolicy +// 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 DescribeResourcePolicyRequest method. +// req, resp := client.DescribeResourcePolicyRequest(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/DescribeResourcePolicy +func (c *Comprehend) DescribeResourcePolicyRequest(input *DescribeResourcePolicyInput) (req *request.Request, output *DescribeResourcePolicyOutput) { + op := &request.Operation{ + Name: opDescribeResourcePolicy, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeResourcePolicyInput{} + } + + output = &DescribeResourcePolicyOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeResourcePolicy API operation for Amazon Comprehend. +// +// Gets the details of a resource-based policy that is attached to a custom +// model, including the JSON body of the policy. +// +// 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 DescribeResourcePolicy for usage and error information. +// +// Returned Error Types: +// +// - InvalidRequestException +// The request is invalid. +// +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. +// +// - InternalServerException +// An internal server error occurred. Retry your request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeResourcePolicy func (c *Comprehend) DescribeResourcePolicy(input *DescribeResourcePolicyInput) (*DescribeResourcePolicyOutput, error) { @@ -3457,34 +4072,34 @@ func (c *Comprehend) ImportModelWithContext(ctx aws.Context, input *ImportModelI return out, req.Send() } -const opListDocumentClassificationJobs = "ListDocumentClassificationJobs" +const opListDatasets = "ListDatasets" -// ListDocumentClassificationJobsRequest generates a "aws/request.Request" representing the -// client's request for the ListDocumentClassificationJobs operation. The "output" return +// ListDatasetsRequest generates a "aws/request.Request" representing the +// client's request for the ListDatasets 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 ListDocumentClassificationJobs for more information on using the ListDocumentClassificationJobs +// See ListDatasets for more information on using the ListDatasets // 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 ListDocumentClassificationJobsRequest method. -// req, resp := client.ListDocumentClassificationJobsRequest(params) +// // Example sending a request using the ListDatasetsRequest method. +// req, resp := client.ListDatasetsRequest(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/ListDocumentClassificationJobs -func (c *Comprehend) ListDocumentClassificationJobsRequest(input *ListDocumentClassificationJobsInput) (req *request.Request, output *ListDocumentClassificationJobsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDatasets +func (c *Comprehend) ListDatasetsRequest(input *ListDatasetsInput) (req *request.Request, output *ListDatasetsOutput) { op := &request.Operation{ - Name: opListDocumentClassificationJobs, + Name: opListDatasets, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ @@ -3496,24 +4111,26 @@ func (c *Comprehend) ListDocumentClassificationJobsRequest(input *ListDocumentCl } if input == nil { - input = &ListDocumentClassificationJobsInput{} + input = &ListDatasetsInput{} } - output = &ListDocumentClassificationJobsOutput{} + output = &ListDatasetsOutput{} req = c.newRequest(op, input, output) return } -// ListDocumentClassificationJobs API operation for Amazon Comprehend. +// ListDatasets API operation for Amazon Comprehend. // -// Gets a list of the documentation classification jobs that you have submitted. +// List the datasets that you have configured in this region. For more information +// about datasets, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. // // 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 ListDocumentClassificationJobs for usage and error information. +// API operation ListDatasets for usage and error information. // // Returned Error Types: // @@ -3526,67 +4143,71 @@ func (c *Comprehend) ListDocumentClassificationJobsRequest(input *ListDocumentCl // - InvalidFilterException // The filter specified for the operation is invalid. Specify a different filter. // +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. +// // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassificationJobs -func (c *Comprehend) ListDocumentClassificationJobs(input *ListDocumentClassificationJobsInput) (*ListDocumentClassificationJobsOutput, error) { - req, out := c.ListDocumentClassificationJobsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDatasets +func (c *Comprehend) ListDatasets(input *ListDatasetsInput) (*ListDatasetsOutput, error) { + req, out := c.ListDatasetsRequest(input) return out, req.Send() } -// ListDocumentClassificationJobsWithContext is the same as ListDocumentClassificationJobs with the addition of +// ListDatasetsWithContext is the same as ListDatasets with the addition of // the ability to pass a context and additional request options. // -// See ListDocumentClassificationJobs for details on how to use this API operation. +// See ListDatasets 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) ListDocumentClassificationJobsWithContext(ctx aws.Context, input *ListDocumentClassificationJobsInput, opts ...request.Option) (*ListDocumentClassificationJobsOutput, error) { - req, out := c.ListDocumentClassificationJobsRequest(input) +func (c *Comprehend) ListDatasetsWithContext(ctx aws.Context, input *ListDatasetsInput, opts ...request.Option) (*ListDatasetsOutput, error) { + req, out := c.ListDatasetsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListDocumentClassificationJobsPages iterates over the pages of a ListDocumentClassificationJobs operation, +// ListDatasetsPages iterates over the pages of a ListDatasets operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListDocumentClassificationJobs method for more information on how to use this operation. +// See ListDatasets 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 ListDocumentClassificationJobs operation. +// // Example iterating over at most 3 pages of a ListDatasets operation. // pageNum := 0 -// err := client.ListDocumentClassificationJobsPages(params, -// func(page *comprehend.ListDocumentClassificationJobsOutput, lastPage bool) bool { +// err := client.ListDatasetsPages(params, +// func(page *comprehend.ListDatasetsOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) -func (c *Comprehend) ListDocumentClassificationJobsPages(input *ListDocumentClassificationJobsInput, fn func(*ListDocumentClassificationJobsOutput, bool) bool) error { - return c.ListDocumentClassificationJobsPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *Comprehend) ListDatasetsPages(input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool) error { + return c.ListDatasetsPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListDocumentClassificationJobsPagesWithContext same as ListDocumentClassificationJobsPages except +// ListDatasetsPagesWithContext same as ListDatasetsPages 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) ListDocumentClassificationJobsPagesWithContext(ctx aws.Context, input *ListDocumentClassificationJobsInput, fn func(*ListDocumentClassificationJobsOutput, bool) bool, opts ...request.Option) error { +func (c *Comprehend) ListDatasetsPagesWithContext(ctx aws.Context, input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListDocumentClassificationJobsInput + var inCpy *ListDatasetsInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListDocumentClassificationJobsRequest(inCpy) + req, _ := c.ListDatasetsRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -3594,7 +4215,7 @@ func (c *Comprehend) ListDocumentClassificationJobsPagesWithContext(ctx aws.Cont } for p.Next() { - if !fn(p.Page().(*ListDocumentClassificationJobsOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListDatasetsOutput), !p.HasNextPage()) { break } } @@ -3602,34 +4223,34 @@ func (c *Comprehend) ListDocumentClassificationJobsPagesWithContext(ctx aws.Cont return p.Err() } -const opListDocumentClassifierSummaries = "ListDocumentClassifierSummaries" +const opListDocumentClassificationJobs = "ListDocumentClassificationJobs" -// ListDocumentClassifierSummariesRequest generates a "aws/request.Request" representing the -// client's request for the ListDocumentClassifierSummaries operation. The "output" return +// ListDocumentClassificationJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListDocumentClassificationJobs 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 ListDocumentClassifierSummaries for more information on using the ListDocumentClassifierSummaries +// See ListDocumentClassificationJobs for more information on using the ListDocumentClassificationJobs // 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 ListDocumentClassifierSummariesRequest method. -// req, resp := client.ListDocumentClassifierSummariesRequest(params) +// // Example sending a request using the ListDocumentClassificationJobsRequest method. +// req, resp := client.ListDocumentClassificationJobsRequest(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/ListDocumentClassifierSummaries -func (c *Comprehend) ListDocumentClassifierSummariesRequest(input *ListDocumentClassifierSummariesInput) (req *request.Request, output *ListDocumentClassifierSummariesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassificationJobs +func (c *Comprehend) ListDocumentClassificationJobsRequest(input *ListDocumentClassificationJobsInput) (req *request.Request, output *ListDocumentClassificationJobsOutput) { op := &request.Operation{ - Name: opListDocumentClassifierSummaries, + Name: opListDocumentClassificationJobs, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ @@ -3641,24 +4262,24 @@ func (c *Comprehend) ListDocumentClassifierSummariesRequest(input *ListDocumentC } if input == nil { - input = &ListDocumentClassifierSummariesInput{} + input = &ListDocumentClassificationJobsInput{} } - output = &ListDocumentClassifierSummariesOutput{} + output = &ListDocumentClassificationJobsOutput{} req = c.newRequest(op, input, output) return } -// ListDocumentClassifierSummaries API operation for Amazon Comprehend. +// ListDocumentClassificationJobs API operation for Amazon Comprehend. // -// # Gets a list of summaries of the document classifiers that you have created +// Gets a list of the documentation classification 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 ListDocumentClassifierSummaries for usage and error information. +// API operation ListDocumentClassificationJobs for usage and error information. // // Returned Error Types: // @@ -3668,16 +4289,161 @@ func (c *Comprehend) ListDocumentClassifierSummariesRequest(input *ListDocumentC // - 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/ListDocumentClassifierSummaries -func (c *Comprehend) ListDocumentClassifierSummaries(input *ListDocumentClassifierSummariesInput) (*ListDocumentClassifierSummariesOutput, error) { - req, out := c.ListDocumentClassifierSummariesRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassificationJobs +func (c *Comprehend) ListDocumentClassificationJobs(input *ListDocumentClassificationJobsInput) (*ListDocumentClassificationJobsOutput, error) { + req, out := c.ListDocumentClassificationJobsRequest(input) return out, req.Send() } -// ListDocumentClassifierSummariesWithContext is the same as ListDocumentClassifierSummaries with the addition of +// ListDocumentClassificationJobsWithContext is the same as ListDocumentClassificationJobs with the addition of +// the ability to pass a context and additional request options. +// +// See ListDocumentClassificationJobs 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) ListDocumentClassificationJobsWithContext(ctx aws.Context, input *ListDocumentClassificationJobsInput, opts ...request.Option) (*ListDocumentClassificationJobsOutput, error) { + req, out := c.ListDocumentClassificationJobsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListDocumentClassificationJobsPages iterates over the pages of a ListDocumentClassificationJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListDocumentClassificationJobs 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 ListDocumentClassificationJobs operation. +// pageNum := 0 +// err := client.ListDocumentClassificationJobsPages(params, +// func(page *comprehend.ListDocumentClassificationJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *Comprehend) ListDocumentClassificationJobsPages(input *ListDocumentClassificationJobsInput, fn func(*ListDocumentClassificationJobsOutput, bool) bool) error { + return c.ListDocumentClassificationJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListDocumentClassificationJobsPagesWithContext same as ListDocumentClassificationJobsPages 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) ListDocumentClassificationJobsPagesWithContext(ctx aws.Context, input *ListDocumentClassificationJobsInput, fn func(*ListDocumentClassificationJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListDocumentClassificationJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListDocumentClassificationJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListDocumentClassificationJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListDocumentClassifierSummaries = "ListDocumentClassifierSummaries" + +// ListDocumentClassifierSummariesRequest generates a "aws/request.Request" representing the +// client's request for the ListDocumentClassifierSummaries 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 ListDocumentClassifierSummaries for more information on using the ListDocumentClassifierSummaries +// 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 ListDocumentClassifierSummariesRequest method. +// req, resp := client.ListDocumentClassifierSummariesRequest(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/ListDocumentClassifierSummaries +func (c *Comprehend) ListDocumentClassifierSummariesRequest(input *ListDocumentClassifierSummariesInput) (req *request.Request, output *ListDocumentClassifierSummariesOutput) { + op := &request.Operation{ + Name: opListDocumentClassifierSummaries, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListDocumentClassifierSummariesInput{} + } + + output = &ListDocumentClassifierSummariesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListDocumentClassifierSummaries API operation for Amazon Comprehend. +// +// # Gets a list of summaries of the document classifiers that you have created +// +// 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 ListDocumentClassifierSummaries 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. +// +// - InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifierSummaries +func (c *Comprehend) ListDocumentClassifierSummaries(input *ListDocumentClassifierSummariesInput) (*ListDocumentClassifierSummariesOutput, error) { + req, out := c.ListDocumentClassifierSummariesRequest(input) + return out, req.Send() +} + +// ListDocumentClassifierSummariesWithContext is the same as ListDocumentClassifierSummaries with the addition of // the ability to pass a context and additional request options. // // See ListDocumentClassifierSummaries for details on how to use this API operation. @@ -4761,34 +5527,34 @@ func (c *Comprehend) ListEventsDetectionJobsPagesWithContext(ctx aws.Context, in return p.Err() } -const opListKeyPhrasesDetectionJobs = "ListKeyPhrasesDetectionJobs" +const opListFlywheelIterationHistory = "ListFlywheelIterationHistory" -// ListKeyPhrasesDetectionJobsRequest generates a "aws/request.Request" representing the -// client's request for the ListKeyPhrasesDetectionJobs operation. The "output" return +// ListFlywheelIterationHistoryRequest generates a "aws/request.Request" representing the +// client's request for the ListFlywheelIterationHistory 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 ListKeyPhrasesDetectionJobs for more information on using the ListKeyPhrasesDetectionJobs +// See ListFlywheelIterationHistory for more information on using the ListFlywheelIterationHistory // 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 ListKeyPhrasesDetectionJobsRequest method. -// req, resp := client.ListKeyPhrasesDetectionJobsRequest(params) +// // Example sending a request using the ListFlywheelIterationHistoryRequest method. +// req, resp := client.ListFlywheelIterationHistoryRequest(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/ListKeyPhrasesDetectionJobs -func (c *Comprehend) ListKeyPhrasesDetectionJobsRequest(input *ListKeyPhrasesDetectionJobsInput) (req *request.Request, output *ListKeyPhrasesDetectionJobsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheelIterationHistory +func (c *Comprehend) ListFlywheelIterationHistoryRequest(input *ListFlywheelIterationHistoryInput) (req *request.Request, output *ListFlywheelIterationHistoryOutput) { op := &request.Operation{ - Name: opListKeyPhrasesDetectionJobs, + Name: opListFlywheelIterationHistory, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ @@ -4800,24 +5566,26 @@ func (c *Comprehend) ListKeyPhrasesDetectionJobsRequest(input *ListKeyPhrasesDet } if input == nil { - input = &ListKeyPhrasesDetectionJobsInput{} + input = &ListFlywheelIterationHistoryInput{} } - output = &ListKeyPhrasesDetectionJobsOutput{} + output = &ListFlywheelIterationHistoryOutput{} req = c.newRequest(op, input, output) return } -// ListKeyPhrasesDetectionJobs API operation for Amazon Comprehend. +// ListFlywheelIterationHistory API operation for Amazon Comprehend. // -// Get a list of key phrase detection jobs that you have submitted. +// Information about the history of a flywheel iteration. For more information +// about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. // // 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 ListKeyPhrasesDetectionJobs for usage and error information. +// API operation ListFlywheelIterationHistory for usage and error information. // // Returned Error Types: // @@ -4830,67 +5598,71 @@ func (c *Comprehend) ListKeyPhrasesDetectionJobsRequest(input *ListKeyPhrasesDet // - InvalidFilterException // The filter specified for the operation is invalid. Specify a different filter. // +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. +// // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobs -func (c *Comprehend) ListKeyPhrasesDetectionJobs(input *ListKeyPhrasesDetectionJobsInput) (*ListKeyPhrasesDetectionJobsOutput, error) { - req, out := c.ListKeyPhrasesDetectionJobsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheelIterationHistory +func (c *Comprehend) ListFlywheelIterationHistory(input *ListFlywheelIterationHistoryInput) (*ListFlywheelIterationHistoryOutput, error) { + req, out := c.ListFlywheelIterationHistoryRequest(input) return out, req.Send() } -// ListKeyPhrasesDetectionJobsWithContext is the same as ListKeyPhrasesDetectionJobs with the addition of +// ListFlywheelIterationHistoryWithContext is the same as ListFlywheelIterationHistory with the addition of // the ability to pass a context and additional request options. // -// See ListKeyPhrasesDetectionJobs for details on how to use this API operation. +// See ListFlywheelIterationHistory 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) ListKeyPhrasesDetectionJobsWithContext(ctx aws.Context, input *ListKeyPhrasesDetectionJobsInput, opts ...request.Option) (*ListKeyPhrasesDetectionJobsOutput, error) { - req, out := c.ListKeyPhrasesDetectionJobsRequest(input) +func (c *Comprehend) ListFlywheelIterationHistoryWithContext(ctx aws.Context, input *ListFlywheelIterationHistoryInput, opts ...request.Option) (*ListFlywheelIterationHistoryOutput, error) { + req, out := c.ListFlywheelIterationHistoryRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListKeyPhrasesDetectionJobsPages iterates over the pages of a ListKeyPhrasesDetectionJobs operation, +// ListFlywheelIterationHistoryPages iterates over the pages of a ListFlywheelIterationHistory operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListKeyPhrasesDetectionJobs method for more information on how to use this operation. +// See ListFlywheelIterationHistory 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 ListKeyPhrasesDetectionJobs operation. +// // Example iterating over at most 3 pages of a ListFlywheelIterationHistory operation. // pageNum := 0 -// err := client.ListKeyPhrasesDetectionJobsPages(params, -// func(page *comprehend.ListKeyPhrasesDetectionJobsOutput, lastPage bool) bool { +// err := client.ListFlywheelIterationHistoryPages(params, +// func(page *comprehend.ListFlywheelIterationHistoryOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) -func (c *Comprehend) ListKeyPhrasesDetectionJobsPages(input *ListKeyPhrasesDetectionJobsInput, fn func(*ListKeyPhrasesDetectionJobsOutput, bool) bool) error { - return c.ListKeyPhrasesDetectionJobsPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *Comprehend) ListFlywheelIterationHistoryPages(input *ListFlywheelIterationHistoryInput, fn func(*ListFlywheelIterationHistoryOutput, bool) bool) error { + return c.ListFlywheelIterationHistoryPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListKeyPhrasesDetectionJobsPagesWithContext same as ListKeyPhrasesDetectionJobsPages except +// ListFlywheelIterationHistoryPagesWithContext same as ListFlywheelIterationHistoryPages 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) ListKeyPhrasesDetectionJobsPagesWithContext(ctx aws.Context, input *ListKeyPhrasesDetectionJobsInput, fn func(*ListKeyPhrasesDetectionJobsOutput, bool) bool, opts ...request.Option) error { +func (c *Comprehend) ListFlywheelIterationHistoryPagesWithContext(ctx aws.Context, input *ListFlywheelIterationHistoryInput, fn func(*ListFlywheelIterationHistoryOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListKeyPhrasesDetectionJobsInput + var inCpy *ListFlywheelIterationHistoryInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListKeyPhrasesDetectionJobsRequest(inCpy) + req, _ := c.ListFlywheelIterationHistoryRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -4898,7 +5670,7 @@ func (c *Comprehend) ListKeyPhrasesDetectionJobsPagesWithContext(ctx aws.Context } for p.Next() { - if !fn(p.Page().(*ListKeyPhrasesDetectionJobsOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListFlywheelIterationHistoryOutput), !p.HasNextPage()) { break } } @@ -4906,34 +5678,34 @@ func (c *Comprehend) ListKeyPhrasesDetectionJobsPagesWithContext(ctx aws.Context return p.Err() } -const opListPiiEntitiesDetectionJobs = "ListPiiEntitiesDetectionJobs" +const opListFlywheels = "ListFlywheels" -// ListPiiEntitiesDetectionJobsRequest generates a "aws/request.Request" representing the -// client's request for the ListPiiEntitiesDetectionJobs operation. The "output" return +// ListFlywheelsRequest generates a "aws/request.Request" representing the +// client's request for the ListFlywheels 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 ListPiiEntitiesDetectionJobs for more information on using the ListPiiEntitiesDetectionJobs +// See ListFlywheels for more information on using the ListFlywheels // 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 ListPiiEntitiesDetectionJobsRequest method. -// req, resp := client.ListPiiEntitiesDetectionJobsRequest(params) +// // Example sending a request using the ListFlywheelsRequest method. +// req, resp := client.ListFlywheelsRequest(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/ListPiiEntitiesDetectionJobs -func (c *Comprehend) ListPiiEntitiesDetectionJobsRequest(input *ListPiiEntitiesDetectionJobsInput) (req *request.Request, output *ListPiiEntitiesDetectionJobsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheels +func (c *Comprehend) ListFlywheelsRequest(input *ListFlywheelsInput) (req *request.Request, output *ListFlywheelsOutput) { op := &request.Operation{ - Name: opListPiiEntitiesDetectionJobs, + Name: opListFlywheels, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ @@ -4945,24 +5717,24 @@ func (c *Comprehend) ListPiiEntitiesDetectionJobsRequest(input *ListPiiEntitiesD } if input == nil { - input = &ListPiiEntitiesDetectionJobsInput{} + input = &ListFlywheelsInput{} } - output = &ListPiiEntitiesDetectionJobsOutput{} + output = &ListFlywheelsOutput{} req = c.newRequest(op, input, output) return } -// ListPiiEntitiesDetectionJobs API operation for Amazon Comprehend. +// ListFlywheels API operation for Amazon Comprehend. // -// Gets a list of the PII entity detection jobs that you have submitted. +// Gets a list of the flywheels that you have created. // // 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 ListPiiEntitiesDetectionJobs for usage and error information. +// API operation ListFlywheels for usage and error information. // // Returned Error Types: // @@ -4978,64 +5750,64 @@ func (c *Comprehend) ListPiiEntitiesDetectionJobsRequest(input *ListPiiEntitiesD // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobs -func (c *Comprehend) ListPiiEntitiesDetectionJobs(input *ListPiiEntitiesDetectionJobsInput) (*ListPiiEntitiesDetectionJobsOutput, error) { - req, out := c.ListPiiEntitiesDetectionJobsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheels +func (c *Comprehend) ListFlywheels(input *ListFlywheelsInput) (*ListFlywheelsOutput, error) { + req, out := c.ListFlywheelsRequest(input) return out, req.Send() } -// ListPiiEntitiesDetectionJobsWithContext is the same as ListPiiEntitiesDetectionJobs with the addition of +// ListFlywheelsWithContext is the same as ListFlywheels with the addition of // the ability to pass a context and additional request options. // -// See ListPiiEntitiesDetectionJobs for details on how to use this API operation. +// See ListFlywheels 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) ListPiiEntitiesDetectionJobsWithContext(ctx aws.Context, input *ListPiiEntitiesDetectionJobsInput, opts ...request.Option) (*ListPiiEntitiesDetectionJobsOutput, error) { - req, out := c.ListPiiEntitiesDetectionJobsRequest(input) +func (c *Comprehend) ListFlywheelsWithContext(ctx aws.Context, input *ListFlywheelsInput, opts ...request.Option) (*ListFlywheelsOutput, error) { + req, out := c.ListFlywheelsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListPiiEntitiesDetectionJobsPages iterates over the pages of a ListPiiEntitiesDetectionJobs operation, +// ListFlywheelsPages iterates over the pages of a ListFlywheels operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListPiiEntitiesDetectionJobs method for more information on how to use this operation. +// See ListFlywheels 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 ListPiiEntitiesDetectionJobs operation. +// // Example iterating over at most 3 pages of a ListFlywheels operation. // pageNum := 0 -// err := client.ListPiiEntitiesDetectionJobsPages(params, -// func(page *comprehend.ListPiiEntitiesDetectionJobsOutput, lastPage bool) bool { +// err := client.ListFlywheelsPages(params, +// func(page *comprehend.ListFlywheelsOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) -func (c *Comprehend) ListPiiEntitiesDetectionJobsPages(input *ListPiiEntitiesDetectionJobsInput, fn func(*ListPiiEntitiesDetectionJobsOutput, bool) bool) error { - return c.ListPiiEntitiesDetectionJobsPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *Comprehend) ListFlywheelsPages(input *ListFlywheelsInput, fn func(*ListFlywheelsOutput, bool) bool) error { + return c.ListFlywheelsPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListPiiEntitiesDetectionJobsPagesWithContext same as ListPiiEntitiesDetectionJobsPages except +// ListFlywheelsPagesWithContext same as ListFlywheelsPages 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) ListPiiEntitiesDetectionJobsPagesWithContext(ctx aws.Context, input *ListPiiEntitiesDetectionJobsInput, fn func(*ListPiiEntitiesDetectionJobsOutput, bool) bool, opts ...request.Option) error { +func (c *Comprehend) ListFlywheelsPagesWithContext(ctx aws.Context, input *ListFlywheelsInput, fn func(*ListFlywheelsOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListPiiEntitiesDetectionJobsInput + var inCpy *ListFlywheelsInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListPiiEntitiesDetectionJobsRequest(inCpy) + req, _ := c.ListFlywheelsRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -5043,7 +5815,7 @@ func (c *Comprehend) ListPiiEntitiesDetectionJobsPagesWithContext(ctx aws.Contex } for p.Next() { - if !fn(p.Page().(*ListPiiEntitiesDetectionJobsOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListFlywheelsOutput), !p.HasNextPage()) { break } } @@ -5051,34 +5823,34 @@ func (c *Comprehend) ListPiiEntitiesDetectionJobsPagesWithContext(ctx aws.Contex return p.Err() } -const opListSentimentDetectionJobs = "ListSentimentDetectionJobs" +const opListKeyPhrasesDetectionJobs = "ListKeyPhrasesDetectionJobs" -// ListSentimentDetectionJobsRequest generates a "aws/request.Request" representing the -// client's request for the ListSentimentDetectionJobs operation. The "output" return +// ListKeyPhrasesDetectionJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListKeyPhrasesDetectionJobs 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 ListSentimentDetectionJobs for more information on using the ListSentimentDetectionJobs +// See ListKeyPhrasesDetectionJobs for more information on using the ListKeyPhrasesDetectionJobs // 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 ListSentimentDetectionJobsRequest method. -// req, resp := client.ListSentimentDetectionJobsRequest(params) +// // Example sending a request using the ListKeyPhrasesDetectionJobsRequest method. +// req, resp := client.ListKeyPhrasesDetectionJobsRequest(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/ListSentimentDetectionJobs -func (c *Comprehend) ListSentimentDetectionJobsRequest(input *ListSentimentDetectionJobsInput) (req *request.Request, output *ListSentimentDetectionJobsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobs +func (c *Comprehend) ListKeyPhrasesDetectionJobsRequest(input *ListKeyPhrasesDetectionJobsInput) (req *request.Request, output *ListKeyPhrasesDetectionJobsOutput) { op := &request.Operation{ - Name: opListSentimentDetectionJobs, + Name: opListKeyPhrasesDetectionJobs, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ @@ -5090,24 +5862,24 @@ func (c *Comprehend) ListSentimentDetectionJobsRequest(input *ListSentimentDetec } if input == nil { - input = &ListSentimentDetectionJobsInput{} + input = &ListKeyPhrasesDetectionJobsInput{} } - output = &ListSentimentDetectionJobsOutput{} + output = &ListKeyPhrasesDetectionJobsOutput{} req = c.newRequest(op, input, output) return } -// ListSentimentDetectionJobs API operation for Amazon Comprehend. +// ListKeyPhrasesDetectionJobs API operation for Amazon Comprehend. // -// Gets a list of sentiment detection jobs that you have submitted. +// Get a list of key phrase 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 ListSentimentDetectionJobs for usage and error information. +// API operation ListKeyPhrasesDetectionJobs for usage and error information. // // Returned Error Types: // @@ -5123,64 +5895,64 @@ func (c *Comprehend) ListSentimentDetectionJobsRequest(input *ListSentimentDetec // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobs -func (c *Comprehend) ListSentimentDetectionJobs(input *ListSentimentDetectionJobsInput) (*ListSentimentDetectionJobsOutput, error) { - req, out := c.ListSentimentDetectionJobsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobs +func (c *Comprehend) ListKeyPhrasesDetectionJobs(input *ListKeyPhrasesDetectionJobsInput) (*ListKeyPhrasesDetectionJobsOutput, error) { + req, out := c.ListKeyPhrasesDetectionJobsRequest(input) return out, req.Send() } -// ListSentimentDetectionJobsWithContext is the same as ListSentimentDetectionJobs with the addition of +// ListKeyPhrasesDetectionJobsWithContext is the same as ListKeyPhrasesDetectionJobs with the addition of // the ability to pass a context and additional request options. // -// See ListSentimentDetectionJobs for details on how to use this API operation. +// See ListKeyPhrasesDetectionJobs 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) ListSentimentDetectionJobsWithContext(ctx aws.Context, input *ListSentimentDetectionJobsInput, opts ...request.Option) (*ListSentimentDetectionJobsOutput, error) { - req, out := c.ListSentimentDetectionJobsRequest(input) +func (c *Comprehend) ListKeyPhrasesDetectionJobsWithContext(ctx aws.Context, input *ListKeyPhrasesDetectionJobsInput, opts ...request.Option) (*ListKeyPhrasesDetectionJobsOutput, error) { + req, out := c.ListKeyPhrasesDetectionJobsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListSentimentDetectionJobsPages iterates over the pages of a ListSentimentDetectionJobs operation, +// ListKeyPhrasesDetectionJobsPages iterates over the pages of a ListKeyPhrasesDetectionJobs operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListSentimentDetectionJobs method for more information on how to use this operation. +// See ListKeyPhrasesDetectionJobs 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 ListSentimentDetectionJobs operation. +// // Example iterating over at most 3 pages of a ListKeyPhrasesDetectionJobs operation. // pageNum := 0 -// err := client.ListSentimentDetectionJobsPages(params, -// func(page *comprehend.ListSentimentDetectionJobsOutput, lastPage bool) bool { +// err := client.ListKeyPhrasesDetectionJobsPages(params, +// func(page *comprehend.ListKeyPhrasesDetectionJobsOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) -func (c *Comprehend) ListSentimentDetectionJobsPages(input *ListSentimentDetectionJobsInput, fn func(*ListSentimentDetectionJobsOutput, bool) bool) error { - return c.ListSentimentDetectionJobsPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *Comprehend) ListKeyPhrasesDetectionJobsPages(input *ListKeyPhrasesDetectionJobsInput, fn func(*ListKeyPhrasesDetectionJobsOutput, bool) bool) error { + return c.ListKeyPhrasesDetectionJobsPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListSentimentDetectionJobsPagesWithContext same as ListSentimentDetectionJobsPages except +// ListKeyPhrasesDetectionJobsPagesWithContext same as ListKeyPhrasesDetectionJobsPages 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) ListSentimentDetectionJobsPagesWithContext(ctx aws.Context, input *ListSentimentDetectionJobsInput, fn func(*ListSentimentDetectionJobsOutput, bool) bool, opts ...request.Option) error { +func (c *Comprehend) ListKeyPhrasesDetectionJobsPagesWithContext(ctx aws.Context, input *ListKeyPhrasesDetectionJobsInput, fn func(*ListKeyPhrasesDetectionJobsOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListSentimentDetectionJobsInput + var inCpy *ListKeyPhrasesDetectionJobsInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListSentimentDetectionJobsRequest(inCpy) + req, _ := c.ListKeyPhrasesDetectionJobsRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -5188,7 +5960,7 @@ func (c *Comprehend) ListSentimentDetectionJobsPagesWithContext(ctx aws.Context, } for p.Next() { - if !fn(p.Page().(*ListSentimentDetectionJobsOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListKeyPhrasesDetectionJobsOutput), !p.HasNextPage()) { break } } @@ -5196,120 +5968,34 @@ func (c *Comprehend) ListSentimentDetectionJobsPagesWithContext(ctx aws.Context, return p.Err() } -const opListTagsForResource = "ListTagsForResource" - -// ListTagsForResourceRequest generates a "aws/request.Request" representing the -// client's request for the ListTagsForResource 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 ListTagsForResource for more information on using the ListTagsForResource -// 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 ListTagsForResourceRequest method. -// req, resp := client.ListTagsForResourceRequest(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/ListTagsForResource -func (c *Comprehend) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { - op := &request.Operation{ - Name: opListTagsForResource, - HTTPMethod: "POST", - HTTPPath: "/", - } - - if input == nil { - input = &ListTagsForResourceInput{} - } - - output = &ListTagsForResourceOutput{} - req = c.newRequest(op, input, output) - return -} - -// ListTagsForResource API operation for Amazon Comprehend. -// -// Lists all tags associated with a given Amazon Comprehend resource. -// -// 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 ListTagsForResource for usage and error information. -// -// Returned Error Types: -// -// - InvalidRequestException -// The request is invalid. -// -// - ResourceNotFoundException -// The specified resource ARN was not found. Check the ARN and try your request -// again. -// -// - InternalServerException -// An internal server error occurred. Retry your request. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTagsForResource -func (c *Comprehend) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { - req, out := c.ListTagsForResourceRequest(input) - return out, req.Send() -} - -// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of -// the ability to pass a context and additional request options. -// -// See ListTagsForResource 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) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { - req, out := c.ListTagsForResourceRequest(input) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return out, req.Send() -} - -const opListTargetedSentimentDetectionJobs = "ListTargetedSentimentDetectionJobs" +const opListPiiEntitiesDetectionJobs = "ListPiiEntitiesDetectionJobs" -// ListTargetedSentimentDetectionJobsRequest generates a "aws/request.Request" representing the -// client's request for the ListTargetedSentimentDetectionJobs operation. The "output" return +// ListPiiEntitiesDetectionJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListPiiEntitiesDetectionJobs 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 +// See ListPiiEntitiesDetectionJobs for more information on using the ListPiiEntitiesDetectionJobs // 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) +// // Example sending a request using the ListPiiEntitiesDetectionJobsRequest method. +// req, resp := client.ListPiiEntitiesDetectionJobsRequest(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) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobs +func (c *Comprehend) ListPiiEntitiesDetectionJobsRequest(input *ListPiiEntitiesDetectionJobsInput) (req *request.Request, output *ListPiiEntitiesDetectionJobsOutput) { op := &request.Operation{ - Name: opListTargetedSentimentDetectionJobs, + Name: opListPiiEntitiesDetectionJobs, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ @@ -5321,24 +6007,24 @@ func (c *Comprehend) ListTargetedSentimentDetectionJobsRequest(input *ListTarget } if input == nil { - input = &ListTargetedSentimentDetectionJobsInput{} + input = &ListPiiEntitiesDetectionJobsInput{} } - output = &ListTargetedSentimentDetectionJobsOutput{} + output = &ListPiiEntitiesDetectionJobsOutput{} req = c.newRequest(op, input, output) return } -// ListTargetedSentimentDetectionJobs API operation for Amazon Comprehend. +// ListPiiEntitiesDetectionJobs API operation for Amazon Comprehend. // -// Gets a list of targeted sentiment detection jobs that you have submitted. +// Gets a list of the PII entity 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. +// API operation ListPiiEntitiesDetectionJobs for usage and error information. // // Returned Error Types: // @@ -5354,64 +6040,64 @@ func (c *Comprehend) ListTargetedSentimentDetectionJobsRequest(input *ListTarget // - 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) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobs +func (c *Comprehend) ListPiiEntitiesDetectionJobs(input *ListPiiEntitiesDetectionJobsInput) (*ListPiiEntitiesDetectionJobsOutput, error) { + req, out := c.ListPiiEntitiesDetectionJobsRequest(input) return out, req.Send() } -// ListTargetedSentimentDetectionJobsWithContext is the same as ListTargetedSentimentDetectionJobs with the addition of +// ListPiiEntitiesDetectionJobsWithContext is the same as ListPiiEntitiesDetectionJobs 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. +// See ListPiiEntitiesDetectionJobs 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) +func (c *Comprehend) ListPiiEntitiesDetectionJobsWithContext(ctx aws.Context, input *ListPiiEntitiesDetectionJobsInput, opts ...request.Option) (*ListPiiEntitiesDetectionJobsOutput, error) { + req, out := c.ListPiiEntitiesDetectionJobsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListTargetedSentimentDetectionJobsPages iterates over the pages of a ListTargetedSentimentDetectionJobs operation, +// ListPiiEntitiesDetectionJobsPages iterates over the pages of a ListPiiEntitiesDetectionJobs 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. +// See ListPiiEntitiesDetectionJobs 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. +// // Example iterating over at most 3 pages of a ListPiiEntitiesDetectionJobs operation. // pageNum := 0 -// err := client.ListTargetedSentimentDetectionJobsPages(params, -// func(page *comprehend.ListTargetedSentimentDetectionJobsOutput, lastPage bool) bool { +// err := client.ListPiiEntitiesDetectionJobsPages(params, +// func(page *comprehend.ListPiiEntitiesDetectionJobsOutput, 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) +func (c *Comprehend) ListPiiEntitiesDetectionJobsPages(input *ListPiiEntitiesDetectionJobsInput, fn func(*ListPiiEntitiesDetectionJobsOutput, bool) bool) error { + return c.ListPiiEntitiesDetectionJobsPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListTargetedSentimentDetectionJobsPagesWithContext same as ListTargetedSentimentDetectionJobsPages except +// ListPiiEntitiesDetectionJobsPagesWithContext same as ListPiiEntitiesDetectionJobsPages 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 { +func (c *Comprehend) ListPiiEntitiesDetectionJobsPagesWithContext(ctx aws.Context, input *ListPiiEntitiesDetectionJobsInput, fn func(*ListPiiEntitiesDetectionJobsOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListTargetedSentimentDetectionJobsInput + var inCpy *ListPiiEntitiesDetectionJobsInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListTargetedSentimentDetectionJobsRequest(inCpy) + req, _ := c.ListPiiEntitiesDetectionJobsRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -5419,7 +6105,7 @@ func (c *Comprehend) ListTargetedSentimentDetectionJobsPagesWithContext(ctx aws. } for p.Next() { - if !fn(p.Page().(*ListTargetedSentimentDetectionJobsOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListPiiEntitiesDetectionJobsOutput), !p.HasNextPage()) { break } } @@ -5427,34 +6113,34 @@ func (c *Comprehend) ListTargetedSentimentDetectionJobsPagesWithContext(ctx aws. return p.Err() } -const opListTopicsDetectionJobs = "ListTopicsDetectionJobs" +const opListSentimentDetectionJobs = "ListSentimentDetectionJobs" -// ListTopicsDetectionJobsRequest generates a "aws/request.Request" representing the -// client's request for the ListTopicsDetectionJobs operation. The "output" return +// ListSentimentDetectionJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListSentimentDetectionJobs 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 ListTopicsDetectionJobs for more information on using the ListTopicsDetectionJobs +// See ListSentimentDetectionJobs for more information on using the ListSentimentDetectionJobs // 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 ListTopicsDetectionJobsRequest method. -// req, resp := client.ListTopicsDetectionJobsRequest(params) +// // Example sending a request using the ListSentimentDetectionJobsRequest method. +// req, resp := client.ListSentimentDetectionJobsRequest(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/ListTopicsDetectionJobs -func (c *Comprehend) ListTopicsDetectionJobsRequest(input *ListTopicsDetectionJobsInput) (req *request.Request, output *ListTopicsDetectionJobsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobs +func (c *Comprehend) ListSentimentDetectionJobsRequest(input *ListSentimentDetectionJobsInput) (req *request.Request, output *ListSentimentDetectionJobsOutput) { op := &request.Operation{ - Name: opListTopicsDetectionJobs, + Name: opListSentimentDetectionJobs, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ @@ -5466,24 +6152,24 @@ func (c *Comprehend) ListTopicsDetectionJobsRequest(input *ListTopicsDetectionJo } if input == nil { - input = &ListTopicsDetectionJobsInput{} + input = &ListSentimentDetectionJobsInput{} } - output = &ListTopicsDetectionJobsOutput{} + output = &ListSentimentDetectionJobsOutput{} req = c.newRequest(op, input, output) return } -// ListTopicsDetectionJobs API operation for Amazon Comprehend. +// ListSentimentDetectionJobs API operation for Amazon Comprehend. // -// Gets a list of the topic detection jobs that you have submitted. +// Gets a list of 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 ListTopicsDetectionJobs for usage and error information. +// API operation ListSentimentDetectionJobs for usage and error information. // // Returned Error Types: // @@ -5499,64 +6185,64 @@ func (c *Comprehend) ListTopicsDetectionJobsRequest(input *ListTopicsDetectionJo // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobs -func (c *Comprehend) ListTopicsDetectionJobs(input *ListTopicsDetectionJobsInput) (*ListTopicsDetectionJobsOutput, error) { - req, out := c.ListTopicsDetectionJobsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobs +func (c *Comprehend) ListSentimentDetectionJobs(input *ListSentimentDetectionJobsInput) (*ListSentimentDetectionJobsOutput, error) { + req, out := c.ListSentimentDetectionJobsRequest(input) return out, req.Send() } -// ListTopicsDetectionJobsWithContext is the same as ListTopicsDetectionJobs with the addition of +// ListSentimentDetectionJobsWithContext is the same as ListSentimentDetectionJobs with the addition of // the ability to pass a context and additional request options. // -// See ListTopicsDetectionJobs for details on how to use this API operation. +// See ListSentimentDetectionJobs 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) ListTopicsDetectionJobsWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, opts ...request.Option) (*ListTopicsDetectionJobsOutput, error) { - req, out := c.ListTopicsDetectionJobsRequest(input) +func (c *Comprehend) ListSentimentDetectionJobsWithContext(ctx aws.Context, input *ListSentimentDetectionJobsInput, opts ...request.Option) (*ListSentimentDetectionJobsOutput, error) { + req, out := c.ListSentimentDetectionJobsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListTopicsDetectionJobsPages iterates over the pages of a ListTopicsDetectionJobs operation, +// ListSentimentDetectionJobsPages iterates over the pages of a ListSentimentDetectionJobs operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListTopicsDetectionJobs method for more information on how to use this operation. +// See ListSentimentDetectionJobs 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 ListTopicsDetectionJobs operation. +// // Example iterating over at most 3 pages of a ListSentimentDetectionJobs operation. // pageNum := 0 -// err := client.ListTopicsDetectionJobsPages(params, -// func(page *comprehend.ListTopicsDetectionJobsOutput, lastPage bool) bool { +// err := client.ListSentimentDetectionJobsPages(params, +// func(page *comprehend.ListSentimentDetectionJobsOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) -func (c *Comprehend) ListTopicsDetectionJobsPages(input *ListTopicsDetectionJobsInput, fn func(*ListTopicsDetectionJobsOutput, bool) bool) error { - return c.ListTopicsDetectionJobsPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *Comprehend) ListSentimentDetectionJobsPages(input *ListSentimentDetectionJobsInput, fn func(*ListSentimentDetectionJobsOutput, bool) bool) error { + return c.ListSentimentDetectionJobsPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListTopicsDetectionJobsPagesWithContext same as ListTopicsDetectionJobsPages except +// ListSentimentDetectionJobsPagesWithContext same as ListSentimentDetectionJobsPages 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) ListTopicsDetectionJobsPagesWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, fn func(*ListTopicsDetectionJobsOutput, bool) bool, opts ...request.Option) error { +func (c *Comprehend) ListSentimentDetectionJobsPagesWithContext(ctx aws.Context, input *ListSentimentDetectionJobsInput, fn func(*ListSentimentDetectionJobsOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListTopicsDetectionJobsInput + var inCpy *ListSentimentDetectionJobsInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListTopicsDetectionJobsRequest(inCpy) + req, _ := c.ListSentimentDetectionJobsRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -5564,7 +6250,7 @@ func (c *Comprehend) ListTopicsDetectionJobsPagesWithContext(ctx aws.Context, in } for p.Next() { - if !fn(p.Page().(*ListTopicsDetectionJobsOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListSentimentDetectionJobsOutput), !p.HasNextPage()) { break } } @@ -5572,59 +6258,57 @@ func (c *Comprehend) ListTopicsDetectionJobsPagesWithContext(ctx aws.Context, in return p.Err() } -const opPutResourcePolicy = "PutResourcePolicy" +const opListTagsForResource = "ListTagsForResource" -// PutResourcePolicyRequest generates a "aws/request.Request" representing the -// client's request for the PutResourcePolicy operation. The "output" return +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource 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 PutResourcePolicy for more information on using the PutResourcePolicy +// See ListTagsForResource for more information on using the ListTagsForResource // 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 PutResourcePolicyRequest method. -// req, resp := client.PutResourcePolicyRequest(params) +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(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/PutResourcePolicy -func (c *Comprehend) PutResourcePolicyRequest(input *PutResourcePolicyInput) (req *request.Request, output *PutResourcePolicyOutput) { - op := &request.Operation{ - Name: opPutResourcePolicy, +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTagsForResource +func (c *Comprehend) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { + op := &request.Operation{ + Name: opListTagsForResource, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &PutResourcePolicyInput{} + input = &ListTagsForResourceInput{} } - output = &PutResourcePolicyOutput{} + output = &ListTagsForResourceOutput{} req = c.newRequest(op, input, output) return } -// PutResourcePolicy API operation for Amazon Comprehend. +// ListTagsForResource API operation for Amazon Comprehend. // -// 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. +// Lists all tags associated with a given Amazon Comprehend resource. // // 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 PutResourcePolicy for usage and error information. +// API operation ListTagsForResource for usage and error information. // // Returned Error Types: // @@ -5638,80 +6322,85 @@ func (c *Comprehend) PutResourcePolicyRequest(input *PutResourcePolicyInput) (re // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PutResourcePolicy -func (c *Comprehend) PutResourcePolicy(input *PutResourcePolicyInput) (*PutResourcePolicyOutput, error) { - req, out := c.PutResourcePolicyRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTagsForResource +func (c *Comprehend) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) return out, req.Send() } -// PutResourcePolicyWithContext is the same as PutResourcePolicy with the addition of +// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of // the ability to pass a context and additional request options. // -// See PutResourcePolicy for details on how to use this API operation. +// See ListTagsForResource 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) PutResourcePolicyWithContext(ctx aws.Context, input *PutResourcePolicyInput, opts ...request.Option) (*PutResourcePolicyOutput, error) { - req, out := c.PutResourcePolicyRequest(input) +func (c *Comprehend) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStartDocumentClassificationJob = "StartDocumentClassificationJob" +const opListTargetedSentimentDetectionJobs = "ListTargetedSentimentDetectionJobs" -// StartDocumentClassificationJobRequest generates a "aws/request.Request" representing the -// client's request for the StartDocumentClassificationJob operation. The "output" return +// 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 StartDocumentClassificationJob for more information on using the StartDocumentClassificationJob +// 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 StartDocumentClassificationJobRequest method. -// req, resp := client.StartDocumentClassificationJobRequest(params) +// // 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/StartDocumentClassificationJob -func (c *Comprehend) StartDocumentClassificationJobRequest(input *StartDocumentClassificationJobInput) (req *request.Request, output *StartDocumentClassificationJobOutput) { +// 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: opStartDocumentClassificationJob, + Name: opListTargetedSentimentDetectionJobs, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } if input == nil { - input = &StartDocumentClassificationJobInput{} + input = &ListTargetedSentimentDetectionJobsInput{} } - output = &StartDocumentClassificationJobOutput{} + output = &ListTargetedSentimentDetectionJobsOutput{} req = c.newRequest(op, input, output) return } -// StartDocumentClassificationJob API operation for Amazon Comprehend. +// ListTargetedSentimentDetectionJobs API operation for Amazon Comprehend. // -// Starts an asynchronous document classification job. Use the operation to -// track the progress of the job. +// 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 StartDocumentClassificationJob for usage and error information. +// API operation ListTargetedSentimentDetectionJobs for usage and error information. // // Returned Error Types: // @@ -5721,100 +6410,142 @@ func (c *Comprehend) StartDocumentClassificationJobRequest(input *StartDocumentC // - TooManyRequestsException // The number of requests exceeds the limit. Resubmit your request later. // -// - ResourceNotFoundException -// The specified resource ARN was not found. Check the ARN and try your request -// again. -// -// - ResourceUnavailableException -// The specified resource is not available. Check the resource and try your -// request again. -// -// - 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. +// - 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/StartDocumentClassificationJob -func (c *Comprehend) StartDocumentClassificationJob(input *StartDocumentClassificationJobInput) (*StartDocumentClassificationJobOutput, error) { - req, out := c.StartDocumentClassificationJobRequest(input) +// 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() } -// StartDocumentClassificationJobWithContext is the same as StartDocumentClassificationJob with the addition of +// ListTargetedSentimentDetectionJobsWithContext is the same as ListTargetedSentimentDetectionJobs with the addition of // the ability to pass a context and additional request options. // -// See StartDocumentClassificationJob for details on how to use this API operation. +// 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) StartDocumentClassificationJobWithContext(ctx aws.Context, input *StartDocumentClassificationJobInput, opts ...request.Option) (*StartDocumentClassificationJobOutput, error) { - req, out := c.StartDocumentClassificationJobRequest(input) +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() } -const opStartDominantLanguageDetectionJob = "StartDominantLanguageDetectionJob" +// 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) +} -// StartDominantLanguageDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StartDominantLanguageDetectionJob operation. The "output" return +// 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 +// client's request for the ListTopicsDetectionJobs 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 StartDominantLanguageDetectionJob for more information on using the StartDominantLanguageDetectionJob +// See ListTopicsDetectionJobs for more information on using the ListTopicsDetectionJobs // 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 StartDominantLanguageDetectionJobRequest method. -// req, resp := client.StartDominantLanguageDetectionJobRequest(params) +// // Example sending a request using the ListTopicsDetectionJobsRequest method. +// req, resp := client.ListTopicsDetectionJobsRequest(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/StartDominantLanguageDetectionJob -func (c *Comprehend) StartDominantLanguageDetectionJobRequest(input *StartDominantLanguageDetectionJobInput) (req *request.Request, output *StartDominantLanguageDetectionJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobs +func (c *Comprehend) ListTopicsDetectionJobsRequest(input *ListTopicsDetectionJobsInput) (req *request.Request, output *ListTopicsDetectionJobsOutput) { op := &request.Operation{ - Name: opStartDominantLanguageDetectionJob, + Name: opListTopicsDetectionJobs, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } if input == nil { - input = &StartDominantLanguageDetectionJobInput{} + input = &ListTopicsDetectionJobsInput{} } - output = &StartDominantLanguageDetectionJobOutput{} + output = &ListTopicsDetectionJobsOutput{} req = c.newRequest(op, input, output) return } -// StartDominantLanguageDetectionJob API operation for Amazon Comprehend. +// ListTopicsDetectionJobs API operation for Amazon Comprehend. // -// Starts an asynchronous dominant language detection job for a collection of -// documents. Use the operation to track the status of a job. +// Gets a list of the topic 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 StartDominantLanguageDetectionJob for usage and error information. +// API operation ListTopicsDetectionJobs for usage and error information. // // Returned Error Types: // @@ -5824,199 +6555,225 @@ func (c *Comprehend) StartDominantLanguageDetectionJobRequest(input *StartDomina // - 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. +// - 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/StartDominantLanguageDetectionJob -func (c *Comprehend) StartDominantLanguageDetectionJob(input *StartDominantLanguageDetectionJobInput) (*StartDominantLanguageDetectionJobOutput, error) { - req, out := c.StartDominantLanguageDetectionJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobs +func (c *Comprehend) ListTopicsDetectionJobs(input *ListTopicsDetectionJobsInput) (*ListTopicsDetectionJobsOutput, error) { + req, out := c.ListTopicsDetectionJobsRequest(input) return out, req.Send() } -// StartDominantLanguageDetectionJobWithContext is the same as StartDominantLanguageDetectionJob with the addition of +// ListTopicsDetectionJobsWithContext is the same as ListTopicsDetectionJobs with the addition of // the ability to pass a context and additional request options. // -// See StartDominantLanguageDetectionJob for details on how to use this API operation. +// See ListTopicsDetectionJobs 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) StartDominantLanguageDetectionJobWithContext(ctx aws.Context, input *StartDominantLanguageDetectionJobInput, opts ...request.Option) (*StartDominantLanguageDetectionJobOutput, error) { - req, out := c.StartDominantLanguageDetectionJobRequest(input) +func (c *Comprehend) ListTopicsDetectionJobsWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, opts ...request.Option) (*ListTopicsDetectionJobsOutput, error) { + req, out := c.ListTopicsDetectionJobsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStartEntitiesDetectionJob = "StartEntitiesDetectionJob" - -// StartEntitiesDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StartEntitiesDetectionJob 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 StartEntitiesDetectionJob for more information on using the StartEntitiesDetectionJob -// 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. +// ListTopicsDetectionJobsPages iterates over the pages of a ListTopicsDetectionJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. // -// // Example sending a request using the StartEntitiesDetectionJobRequest method. -// req, resp := client.StartEntitiesDetectionJobRequest(params) +// See ListTopicsDetectionJobs method for more information on how to use this operation. // -// err := req.Send() -// if err == nil { // resp is now filled -// fmt.Println(resp) -// } +// Note: This operation can generate multiple requests to a service. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob -func (c *Comprehend) StartEntitiesDetectionJobRequest(input *StartEntitiesDetectionJobInput) (req *request.Request, output *StartEntitiesDetectionJobOutput) { - op := &request.Operation{ - Name: opStartEntitiesDetectionJob, - HTTPMethod: "POST", - HTTPPath: "/", - } - - if input == nil { - input = &StartEntitiesDetectionJobInput{} - } +// // Example iterating over at most 3 pages of a ListTopicsDetectionJobs operation. +// pageNum := 0 +// err := client.ListTopicsDetectionJobsPages(params, +// func(page *comprehend.ListTopicsDetectionJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *Comprehend) ListTopicsDetectionJobsPages(input *ListTopicsDetectionJobsInput, fn func(*ListTopicsDetectionJobsOutput, bool) bool) error { + return c.ListTopicsDetectionJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} - output = &StartEntitiesDetectionJobOutput{} - req = c.newRequest(op, input, output) - return +// ListTopicsDetectionJobsPagesWithContext same as ListTopicsDetectionJobsPages 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) ListTopicsDetectionJobsPagesWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, fn func(*ListTopicsDetectionJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListTopicsDetectionJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListTopicsDetectionJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListTopicsDetectionJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() } -// StartEntitiesDetectionJob API operation for Amazon Comprehend. +const opPutResourcePolicy = "PutResourcePolicy" + +// PutResourcePolicyRequest generates a "aws/request.Request" representing the +// client's request for the PutResourcePolicy operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. // -// Starts an asynchronous entity detection job for a collection of documents. -// Use the operation to track the status of a job. +// 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. // -// This API can be used for either standard entity detection or custom entity -// recognition. In order to be used for custom entity recognition, the optional -// EntityRecognizerArn must be used in order to provide access to the recognizer -// being used to detect the custom entity. +// See PutResourcePolicy for more information on using the PutResourcePolicy +// 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 PutResourcePolicyRequest method. +// req, resp := client.PutResourcePolicyRequest(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/PutResourcePolicy +func (c *Comprehend) PutResourcePolicyRequest(input *PutResourcePolicyInput) (req *request.Request, output *PutResourcePolicyOutput) { + op := &request.Operation{ + Name: opPutResourcePolicy, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &PutResourcePolicyInput{} + } + + output = &PutResourcePolicyOutput{} + req = c.newRequest(op, input, output) + return +} + +// PutResourcePolicy API operation for Amazon Comprehend. +// +// 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. // // 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 StartEntitiesDetectionJob for usage and error information. +// API operation PutResourcePolicy 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. -// // - ResourceNotFoundException // The specified resource ARN was not found. Check the ARN and try your request // again. // -// - ResourceUnavailableException -// The specified resource is not available. Check the resource and try your -// request again. -// -// - 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/StartEntitiesDetectionJob -func (c *Comprehend) StartEntitiesDetectionJob(input *StartEntitiesDetectionJobInput) (*StartEntitiesDetectionJobOutput, error) { - req, out := c.StartEntitiesDetectionJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PutResourcePolicy +func (c *Comprehend) PutResourcePolicy(input *PutResourcePolicyInput) (*PutResourcePolicyOutput, error) { + req, out := c.PutResourcePolicyRequest(input) return out, req.Send() } -// StartEntitiesDetectionJobWithContext is the same as StartEntitiesDetectionJob with the addition of +// PutResourcePolicyWithContext is the same as PutResourcePolicy with the addition of // the ability to pass a context and additional request options. // -// See StartEntitiesDetectionJob for details on how to use this API operation. +// See PutResourcePolicy 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) StartEntitiesDetectionJobWithContext(ctx aws.Context, input *StartEntitiesDetectionJobInput, opts ...request.Option) (*StartEntitiesDetectionJobOutput, error) { - req, out := c.StartEntitiesDetectionJobRequest(input) +func (c *Comprehend) PutResourcePolicyWithContext(ctx aws.Context, input *PutResourcePolicyInput, opts ...request.Option) (*PutResourcePolicyOutput, error) { + req, out := c.PutResourcePolicyRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStartEventsDetectionJob = "StartEventsDetectionJob" +const opStartDocumentClassificationJob = "StartDocumentClassificationJob" -// StartEventsDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StartEventsDetectionJob operation. The "output" return +// StartDocumentClassificationJobRequest generates a "aws/request.Request" representing the +// client's request for the StartDocumentClassificationJob 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 StartEventsDetectionJob for more information on using the StartEventsDetectionJob +// See StartDocumentClassificationJob for more information on using the StartDocumentClassificationJob // 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 StartEventsDetectionJobRequest method. -// req, resp := client.StartEventsDetectionJobRequest(params) +// // Example sending a request using the StartDocumentClassificationJobRequest method. +// req, resp := client.StartDocumentClassificationJobRequest(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/StartEventsDetectionJob -func (c *Comprehend) StartEventsDetectionJobRequest(input *StartEventsDetectionJobInput) (req *request.Request, output *StartEventsDetectionJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJob +func (c *Comprehend) StartDocumentClassificationJobRequest(input *StartDocumentClassificationJobInput) (req *request.Request, output *StartDocumentClassificationJobOutput) { op := &request.Operation{ - Name: opStartEventsDetectionJob, + Name: opStartDocumentClassificationJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StartEventsDetectionJobInput{} + input = &StartDocumentClassificationJobInput{} } - output = &StartEventsDetectionJobOutput{} + output = &StartDocumentClassificationJobOutput{} req = c.newRequest(op, input, output) return } -// StartEventsDetectionJob API operation for Amazon Comprehend. +// StartDocumentClassificationJob API operation for Amazon Comprehend. // -// Starts an asynchronous event detection job for a collection of documents. +// Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob +// operation to track the progress 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 StartEventsDetectionJob for usage and error information. +// API operation StartDocumentClassificationJob for usage and error information. // // Returned Error Types: // @@ -6026,6 +6783,14 @@ func (c *Comprehend) StartEventsDetectionJobRequest(input *StartEventsDetectionJ // - TooManyRequestsException // The number of requests exceeds the limit. Resubmit your request later. // +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. +// +// - ResourceUnavailableException +// The specified resource is not available. Check the resource and try your +// request again. +// // - KmsKeyValidationException // The KMS customer managed key (CMK) entered cannot be validated. Verify the // key and re-enter it. @@ -6038,80 +6803,80 @@ func (c *Comprehend) StartEventsDetectionJobRequest(input *StartEventsDetectionJ // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJob -func (c *Comprehend) StartEventsDetectionJob(input *StartEventsDetectionJobInput) (*StartEventsDetectionJobOutput, error) { - req, out := c.StartEventsDetectionJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJob +func (c *Comprehend) StartDocumentClassificationJob(input *StartDocumentClassificationJobInput) (*StartDocumentClassificationJobOutput, error) { + req, out := c.StartDocumentClassificationJobRequest(input) return out, req.Send() } -// StartEventsDetectionJobWithContext is the same as StartEventsDetectionJob with the addition of +// StartDocumentClassificationJobWithContext is the same as StartDocumentClassificationJob with the addition of // the ability to pass a context and additional request options. // -// See StartEventsDetectionJob for details on how to use this API operation. +// See StartDocumentClassificationJob 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) StartEventsDetectionJobWithContext(ctx aws.Context, input *StartEventsDetectionJobInput, opts ...request.Option) (*StartEventsDetectionJobOutput, error) { - req, out := c.StartEventsDetectionJobRequest(input) +func (c *Comprehend) StartDocumentClassificationJobWithContext(ctx aws.Context, input *StartDocumentClassificationJobInput, opts ...request.Option) (*StartDocumentClassificationJobOutput, error) { + req, out := c.StartDocumentClassificationJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStartKeyPhrasesDetectionJob = "StartKeyPhrasesDetectionJob" +const opStartDominantLanguageDetectionJob = "StartDominantLanguageDetectionJob" -// StartKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StartKeyPhrasesDetectionJob operation. The "output" return +// StartDominantLanguageDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StartDominantLanguageDetectionJob 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 StartKeyPhrasesDetectionJob for more information on using the StartKeyPhrasesDetectionJob +// See StartDominantLanguageDetectionJob for more information on using the StartDominantLanguageDetectionJob // 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 StartKeyPhrasesDetectionJobRequest method. -// req, resp := client.StartKeyPhrasesDetectionJobRequest(params) +// // Example sending a request using the StartDominantLanguageDetectionJobRequest method. +// req, resp := client.StartDominantLanguageDetectionJobRequest(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/StartKeyPhrasesDetectionJob -func (c *Comprehend) StartKeyPhrasesDetectionJobRequest(input *StartKeyPhrasesDetectionJobInput) (req *request.Request, output *StartKeyPhrasesDetectionJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJob +func (c *Comprehend) StartDominantLanguageDetectionJobRequest(input *StartDominantLanguageDetectionJobInput) (req *request.Request, output *StartDominantLanguageDetectionJobOutput) { op := &request.Operation{ - Name: opStartKeyPhrasesDetectionJob, + Name: opStartDominantLanguageDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StartKeyPhrasesDetectionJobInput{} + input = &StartDominantLanguageDetectionJobInput{} } - output = &StartKeyPhrasesDetectionJobOutput{} + output = &StartDominantLanguageDetectionJobOutput{} req = c.newRequest(op, input, output) return } -// StartKeyPhrasesDetectionJob API operation for Amazon Comprehend. +// StartDominantLanguageDetectionJob API operation for Amazon Comprehend. // -// Starts an asynchronous key phrase detection job for a collection of documents. -// Use the operation to track the status of a job. +// Starts an asynchronous dominant language 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 StartKeyPhrasesDetectionJob for usage and error information. +// API operation StartDominantLanguageDetectionJob for usage and error information. // // Returned Error Types: // @@ -6133,79 +6898,85 @@ func (c *Comprehend) StartKeyPhrasesDetectionJobRequest(input *StartKeyPhrasesDe // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJob -func (c *Comprehend) StartKeyPhrasesDetectionJob(input *StartKeyPhrasesDetectionJobInput) (*StartKeyPhrasesDetectionJobOutput, error) { - req, out := c.StartKeyPhrasesDetectionJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJob +func (c *Comprehend) StartDominantLanguageDetectionJob(input *StartDominantLanguageDetectionJobInput) (*StartDominantLanguageDetectionJobOutput, error) { + req, out := c.StartDominantLanguageDetectionJobRequest(input) return out, req.Send() } -// StartKeyPhrasesDetectionJobWithContext is the same as StartKeyPhrasesDetectionJob with the addition of +// StartDominantLanguageDetectionJobWithContext is the same as StartDominantLanguageDetectionJob with the addition of // the ability to pass a context and additional request options. // -// See StartKeyPhrasesDetectionJob for details on how to use this API operation. +// See StartDominantLanguageDetectionJob 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) StartKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *StartKeyPhrasesDetectionJobInput, opts ...request.Option) (*StartKeyPhrasesDetectionJobOutput, error) { - req, out := c.StartKeyPhrasesDetectionJobRequest(input) +func (c *Comprehend) StartDominantLanguageDetectionJobWithContext(ctx aws.Context, input *StartDominantLanguageDetectionJobInput, opts ...request.Option) (*StartDominantLanguageDetectionJobOutput, error) { + req, out := c.StartDominantLanguageDetectionJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStartPiiEntitiesDetectionJob = "StartPiiEntitiesDetectionJob" +const opStartEntitiesDetectionJob = "StartEntitiesDetectionJob" -// StartPiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StartPiiEntitiesDetectionJob operation. The "output" return +// StartEntitiesDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StartEntitiesDetectionJob 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 StartPiiEntitiesDetectionJob for more information on using the StartPiiEntitiesDetectionJob +// See StartEntitiesDetectionJob for more information on using the StartEntitiesDetectionJob // 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 StartPiiEntitiesDetectionJobRequest method. -// req, resp := client.StartPiiEntitiesDetectionJobRequest(params) +// // Example sending a request using the StartEntitiesDetectionJobRequest method. +// req, resp := client.StartEntitiesDetectionJobRequest(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/StartPiiEntitiesDetectionJob -func (c *Comprehend) StartPiiEntitiesDetectionJobRequest(input *StartPiiEntitiesDetectionJobInput) (req *request.Request, output *StartPiiEntitiesDetectionJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob +func (c *Comprehend) StartEntitiesDetectionJobRequest(input *StartEntitiesDetectionJobInput) (req *request.Request, output *StartEntitiesDetectionJobOutput) { op := &request.Operation{ - Name: opStartPiiEntitiesDetectionJob, + Name: opStartEntitiesDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StartPiiEntitiesDetectionJobInput{} + input = &StartEntitiesDetectionJobInput{} } - output = &StartPiiEntitiesDetectionJobOutput{} + output = &StartEntitiesDetectionJobOutput{} req = c.newRequest(op, input, output) return } -// StartPiiEntitiesDetectionJob API operation for Amazon Comprehend. +// StartEntitiesDetectionJob API operation for Amazon Comprehend. // -// Starts an asynchronous PII entity detection job for a collection of documents. +// Starts an asynchronous entity detection job for a collection of documents. +// Use the operation to track the status of a job. +// +// This API can be used for either standard entity detection or custom entity +// recognition. In order to be used for custom entity recognition, the optional +// EntityRecognizerArn must be used in order to provide access to the recognizer +// being used to detect the custom entity. // // 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 StartPiiEntitiesDetectionJob for usage and error information. +// API operation StartEntitiesDetectionJob for usage and error information. // // Returned Error Types: // @@ -6215,6 +6986,14 @@ func (c *Comprehend) StartPiiEntitiesDetectionJobRequest(input *StartPiiEntities // - TooManyRequestsException // The number of requests exceeds the limit. Resubmit your request later. // +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. +// +// - ResourceUnavailableException +// The specified resource is not available. Check the resource and try your +// request again. +// // - KmsKeyValidationException // The KMS customer managed key (CMK) entered cannot be validated. Verify the // key and re-enter it. @@ -6227,80 +7006,79 @@ func (c *Comprehend) StartPiiEntitiesDetectionJobRequest(input *StartPiiEntities // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob -func (c *Comprehend) StartPiiEntitiesDetectionJob(input *StartPiiEntitiesDetectionJobInput) (*StartPiiEntitiesDetectionJobOutput, error) { - req, out := c.StartPiiEntitiesDetectionJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob +func (c *Comprehend) StartEntitiesDetectionJob(input *StartEntitiesDetectionJobInput) (*StartEntitiesDetectionJobOutput, error) { + req, out := c.StartEntitiesDetectionJobRequest(input) return out, req.Send() } -// StartPiiEntitiesDetectionJobWithContext is the same as StartPiiEntitiesDetectionJob with the addition of +// StartEntitiesDetectionJobWithContext is the same as StartEntitiesDetectionJob with the addition of // the ability to pass a context and additional request options. // -// See StartPiiEntitiesDetectionJob for details on how to use this API operation. +// See StartEntitiesDetectionJob 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) StartPiiEntitiesDetectionJobWithContext(ctx aws.Context, input *StartPiiEntitiesDetectionJobInput, opts ...request.Option) (*StartPiiEntitiesDetectionJobOutput, error) { - req, out := c.StartPiiEntitiesDetectionJobRequest(input) +func (c *Comprehend) StartEntitiesDetectionJobWithContext(ctx aws.Context, input *StartEntitiesDetectionJobInput, opts ...request.Option) (*StartEntitiesDetectionJobOutput, error) { + req, out := c.StartEntitiesDetectionJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStartSentimentDetectionJob = "StartSentimentDetectionJob" +const opStartEventsDetectionJob = "StartEventsDetectionJob" -// StartSentimentDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StartSentimentDetectionJob operation. The "output" return +// StartEventsDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StartEventsDetectionJob 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 StartSentimentDetectionJob for more information on using the StartSentimentDetectionJob +// See StartEventsDetectionJob for more information on using the StartEventsDetectionJob // 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 StartSentimentDetectionJobRequest method. -// req, resp := client.StartSentimentDetectionJobRequest(params) +// // Example sending a request using the StartEventsDetectionJobRequest method. +// req, resp := client.StartEventsDetectionJobRequest(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/StartSentimentDetectionJob -func (c *Comprehend) StartSentimentDetectionJobRequest(input *StartSentimentDetectionJobInput) (req *request.Request, output *StartSentimentDetectionJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJob +func (c *Comprehend) StartEventsDetectionJobRequest(input *StartEventsDetectionJobInput) (req *request.Request, output *StartEventsDetectionJobOutput) { op := &request.Operation{ - Name: opStartSentimentDetectionJob, + Name: opStartEventsDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StartSentimentDetectionJobInput{} + input = &StartEventsDetectionJobInput{} } - output = &StartSentimentDetectionJobOutput{} + output = &StartEventsDetectionJobOutput{} req = c.newRequest(op, input, output) return } -// StartSentimentDetectionJob API operation for Amazon Comprehend. +// StartEventsDetectionJob 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. +// Starts an asynchronous event detection job for a collection of documents. // // 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 StartSentimentDetectionJob for usage and error information. +// API operation StartEventsDetectionJob for usage and error information. // // Returned Error Types: // @@ -6322,80 +7100,82 @@ func (c *Comprehend) StartSentimentDetectionJobRequest(input *StartSentimentDete // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob -func (c *Comprehend) StartSentimentDetectionJob(input *StartSentimentDetectionJobInput) (*StartSentimentDetectionJobOutput, error) { - req, out := c.StartSentimentDetectionJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJob +func (c *Comprehend) StartEventsDetectionJob(input *StartEventsDetectionJobInput) (*StartEventsDetectionJobOutput, error) { + req, out := c.StartEventsDetectionJobRequest(input) return out, req.Send() } -// StartSentimentDetectionJobWithContext is the same as StartSentimentDetectionJob with the addition of +// StartEventsDetectionJobWithContext is the same as StartEventsDetectionJob with the addition of // the ability to pass a context and additional request options. // -// See StartSentimentDetectionJob for details on how to use this API operation. +// See StartEventsDetectionJob 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) StartSentimentDetectionJobWithContext(ctx aws.Context, input *StartSentimentDetectionJobInput, opts ...request.Option) (*StartSentimentDetectionJobOutput, error) { - req, out := c.StartSentimentDetectionJobRequest(input) +func (c *Comprehend) StartEventsDetectionJobWithContext(ctx aws.Context, input *StartEventsDetectionJobInput, opts ...request.Option) (*StartEventsDetectionJobOutput, error) { + req, out := c.StartEventsDetectionJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStartTargetedSentimentDetectionJob = "StartTargetedSentimentDetectionJob" +const opStartFlywheelIteration = "StartFlywheelIteration" -// StartTargetedSentimentDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StartTargetedSentimentDetectionJob operation. The "output" return +// StartFlywheelIterationRequest generates a "aws/request.Request" representing the +// client's request for the StartFlywheelIteration 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 +// See StartFlywheelIteration for more information on using the StartFlywheelIteration // 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) +// // Example sending a request using the StartFlywheelIterationRequest method. +// req, resp := client.StartFlywheelIterationRequest(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) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartFlywheelIteration +func (c *Comprehend) StartFlywheelIterationRequest(input *StartFlywheelIterationInput) (req *request.Request, output *StartFlywheelIterationOutput) { op := &request.Operation{ - Name: opStartTargetedSentimentDetectionJob, + Name: opStartFlywheelIteration, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StartTargetedSentimentDetectionJobInput{} + input = &StartFlywheelIterationInput{} } - output = &StartTargetedSentimentDetectionJobOutput{} + output = &StartFlywheelIterationOutput{} req = c.newRequest(op, input, output) return } -// StartTargetedSentimentDetectionJob API operation for Amazon Comprehend. +// StartFlywheelIteration 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. +// Start the flywheel iteration.This operation uses any new datasets to train +// a new model version. For more information about flywheels, see Flywheel overview +// (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in +// the Amazon Comprehend Developer Guide. // // 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. +// API operation StartFlywheelIteration for usage and error information. // // Returned Error Types: // @@ -6405,92 +7185,91 @@ func (c *Comprehend) StartTargetedSentimentDetectionJobRequest(input *StartTarge // - 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. +// - ResourceInUseException +// The specified resource name is already in use. Use a different name and try +// your request again. // -// - 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. +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - 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) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartFlywheelIteration +func (c *Comprehend) StartFlywheelIteration(input *StartFlywheelIterationInput) (*StartFlywheelIterationOutput, error) { + req, out := c.StartFlywheelIterationRequest(input) return out, req.Send() } -// StartTargetedSentimentDetectionJobWithContext is the same as StartTargetedSentimentDetectionJob with the addition of +// StartFlywheelIterationWithContext is the same as StartFlywheelIteration 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. +// See StartFlywheelIteration 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) +func (c *Comprehend) StartFlywheelIterationWithContext(ctx aws.Context, input *StartFlywheelIterationInput, opts ...request.Option) (*StartFlywheelIterationOutput, error) { + req, out := c.StartFlywheelIterationRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStartTopicsDetectionJob = "StartTopicsDetectionJob" +const opStartKeyPhrasesDetectionJob = "StartKeyPhrasesDetectionJob" -// StartTopicsDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StartTopicsDetectionJob operation. The "output" return +// StartKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StartKeyPhrasesDetectionJob 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 StartTopicsDetectionJob for more information on using the StartTopicsDetectionJob +// See StartKeyPhrasesDetectionJob for more information on using the StartKeyPhrasesDetectionJob // 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 StartTopicsDetectionJobRequest method. -// req, resp := client.StartTopicsDetectionJobRequest(params) +// // Example sending a request using the StartKeyPhrasesDetectionJobRequest method. +// req, resp := client.StartKeyPhrasesDetectionJobRequest(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/StartTopicsDetectionJob -func (c *Comprehend) StartTopicsDetectionJobRequest(input *StartTopicsDetectionJobInput) (req *request.Request, output *StartTopicsDetectionJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJob +func (c *Comprehend) StartKeyPhrasesDetectionJobRequest(input *StartKeyPhrasesDetectionJobInput) (req *request.Request, output *StartKeyPhrasesDetectionJobOutput) { op := &request.Operation{ - Name: opStartTopicsDetectionJob, + Name: opStartKeyPhrasesDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StartTopicsDetectionJobInput{} + input = &StartKeyPhrasesDetectionJobInput{} } - output = &StartTopicsDetectionJobOutput{} + output = &StartKeyPhrasesDetectionJobOutput{} req = c.newRequest(op, input, output) return } -// StartTopicsDetectionJob API operation for Amazon Comprehend. +// StartKeyPhrasesDetectionJob API operation for Amazon Comprehend. // -// Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob -// operation to track the status of a job. +// Starts an asynchronous key phrase 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 StartTopicsDetectionJob for usage and error information. +// API operation StartKeyPhrasesDetectionJob for usage and error information. // // Returned Error Types: // @@ -6512,452 +7291,470 @@ func (c *Comprehend) StartTopicsDetectionJobRequest(input *StartTopicsDetectionJ // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob -func (c *Comprehend) StartTopicsDetectionJob(input *StartTopicsDetectionJobInput) (*StartTopicsDetectionJobOutput, error) { - req, out := c.StartTopicsDetectionJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJob +func (c *Comprehend) StartKeyPhrasesDetectionJob(input *StartKeyPhrasesDetectionJobInput) (*StartKeyPhrasesDetectionJobOutput, error) { + req, out := c.StartKeyPhrasesDetectionJobRequest(input) return out, req.Send() } -// StartTopicsDetectionJobWithContext is the same as StartTopicsDetectionJob with the addition of +// StartKeyPhrasesDetectionJobWithContext is the same as StartKeyPhrasesDetectionJob with the addition of // the ability to pass a context and additional request options. // -// See StartTopicsDetectionJob for details on how to use this API operation. +// See StartKeyPhrasesDetectionJob 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) StartTopicsDetectionJobWithContext(ctx aws.Context, input *StartTopicsDetectionJobInput, opts ...request.Option) (*StartTopicsDetectionJobOutput, error) { - req, out := c.StartTopicsDetectionJobRequest(input) +func (c *Comprehend) StartKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *StartKeyPhrasesDetectionJobInput, opts ...request.Option) (*StartKeyPhrasesDetectionJobOutput, error) { + req, out := c.StartKeyPhrasesDetectionJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStopDominantLanguageDetectionJob = "StopDominantLanguageDetectionJob" +const opStartPiiEntitiesDetectionJob = "StartPiiEntitiesDetectionJob" -// StopDominantLanguageDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StopDominantLanguageDetectionJob operation. The "output" return +// StartPiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StartPiiEntitiesDetectionJob 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 StopDominantLanguageDetectionJob for more information on using the StopDominantLanguageDetectionJob +// See StartPiiEntitiesDetectionJob for more information on using the StartPiiEntitiesDetectionJob // 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 StopDominantLanguageDetectionJobRequest method. -// req, resp := client.StopDominantLanguageDetectionJobRequest(params) +// // Example sending a request using the StartPiiEntitiesDetectionJobRequest method. +// req, resp := client.StartPiiEntitiesDetectionJobRequest(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/StopDominantLanguageDetectionJob -func (c *Comprehend) StopDominantLanguageDetectionJobRequest(input *StopDominantLanguageDetectionJobInput) (req *request.Request, output *StopDominantLanguageDetectionJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob +func (c *Comprehend) StartPiiEntitiesDetectionJobRequest(input *StartPiiEntitiesDetectionJobInput) (req *request.Request, output *StartPiiEntitiesDetectionJobOutput) { op := &request.Operation{ - Name: opStopDominantLanguageDetectionJob, + Name: opStartPiiEntitiesDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StopDominantLanguageDetectionJobInput{} + input = &StartPiiEntitiesDetectionJobInput{} } - output = &StopDominantLanguageDetectionJobOutput{} + output = &StartPiiEntitiesDetectionJobOutput{} req = c.newRequest(op, input, output) return } -// StopDominantLanguageDetectionJob API operation for Amazon Comprehend. -// -// 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. +// StartPiiEntitiesDetectionJob API operation for Amazon Comprehend. // -// When a job is stopped, any documents already processed are written to the -// output location. +// Starts an asynchronous PII entity detection job for a collection of documents. // // 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 StopDominantLanguageDetectionJob for usage and error information. +// API operation StartPiiEntitiesDetectionJob 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. +// +// - 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/StopDominantLanguageDetectionJob -func (c *Comprehend) StopDominantLanguageDetectionJob(input *StopDominantLanguageDetectionJobInput) (*StopDominantLanguageDetectionJobOutput, error) { - req, out := c.StopDominantLanguageDetectionJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob +func (c *Comprehend) StartPiiEntitiesDetectionJob(input *StartPiiEntitiesDetectionJobInput) (*StartPiiEntitiesDetectionJobOutput, error) { + req, out := c.StartPiiEntitiesDetectionJobRequest(input) return out, req.Send() } -// StopDominantLanguageDetectionJobWithContext is the same as StopDominantLanguageDetectionJob with the addition of +// StartPiiEntitiesDetectionJobWithContext is the same as StartPiiEntitiesDetectionJob with the addition of // the ability to pass a context and additional request options. // -// See StopDominantLanguageDetectionJob for details on how to use this API operation. +// See StartPiiEntitiesDetectionJob 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) StopDominantLanguageDetectionJobWithContext(ctx aws.Context, input *StopDominantLanguageDetectionJobInput, opts ...request.Option) (*StopDominantLanguageDetectionJobOutput, error) { - req, out := c.StopDominantLanguageDetectionJobRequest(input) +func (c *Comprehend) StartPiiEntitiesDetectionJobWithContext(ctx aws.Context, input *StartPiiEntitiesDetectionJobInput, opts ...request.Option) (*StartPiiEntitiesDetectionJobOutput, error) { + req, out := c.StartPiiEntitiesDetectionJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStopEntitiesDetectionJob = "StopEntitiesDetectionJob" +const opStartSentimentDetectionJob = "StartSentimentDetectionJob" -// StopEntitiesDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StopEntitiesDetectionJob operation. The "output" return +// StartSentimentDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StartSentimentDetectionJob 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 StopEntitiesDetectionJob for more information on using the StopEntitiesDetectionJob +// See StartSentimentDetectionJob for more information on using the StartSentimentDetectionJob // 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 StopEntitiesDetectionJobRequest method. -// req, resp := client.StopEntitiesDetectionJobRequest(params) +// // Example sending a request using the StartSentimentDetectionJobRequest method. +// req, resp := client.StartSentimentDetectionJobRequest(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/StopEntitiesDetectionJob -func (c *Comprehend) StopEntitiesDetectionJobRequest(input *StopEntitiesDetectionJobInput) (req *request.Request, output *StopEntitiesDetectionJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob +func (c *Comprehend) StartSentimentDetectionJobRequest(input *StartSentimentDetectionJobInput) (req *request.Request, output *StartSentimentDetectionJobOutput) { op := &request.Operation{ - Name: opStopEntitiesDetectionJob, + Name: opStartSentimentDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StopEntitiesDetectionJobInput{} + input = &StartSentimentDetectionJobInput{} } - output = &StopEntitiesDetectionJobOutput{} + output = &StartSentimentDetectionJobOutput{} req = c.newRequest(op, input, output) return } -// StopEntitiesDetectionJob API operation for Amazon Comprehend. -// -// 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. +// StartSentimentDetectionJob API operation for Amazon Comprehend. // -// When a job is stopped, any documents already processed are written to the -// output location. +// Starts an asynchronous 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 StopEntitiesDetectionJob for usage and error information. +// API operation StartSentimentDetectionJob 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. +// +// - 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/StopEntitiesDetectionJob -func (c *Comprehend) StopEntitiesDetectionJob(input *StopEntitiesDetectionJobInput) (*StopEntitiesDetectionJobOutput, error) { - req, out := c.StopEntitiesDetectionJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob +func (c *Comprehend) StartSentimentDetectionJob(input *StartSentimentDetectionJobInput) (*StartSentimentDetectionJobOutput, error) { + req, out := c.StartSentimentDetectionJobRequest(input) return out, req.Send() } -// StopEntitiesDetectionJobWithContext is the same as StopEntitiesDetectionJob with the addition of +// StartSentimentDetectionJobWithContext is the same as StartSentimentDetectionJob with the addition of // the ability to pass a context and additional request options. // -// See StopEntitiesDetectionJob for details on how to use this API operation. +// See StartSentimentDetectionJob 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) StopEntitiesDetectionJobWithContext(ctx aws.Context, input *StopEntitiesDetectionJobInput, opts ...request.Option) (*StopEntitiesDetectionJobOutput, error) { - req, out := c.StopEntitiesDetectionJobRequest(input) +func (c *Comprehend) StartSentimentDetectionJobWithContext(ctx aws.Context, input *StartSentimentDetectionJobInput, opts ...request.Option) (*StartSentimentDetectionJobOutput, error) { + req, out := c.StartSentimentDetectionJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStopEventsDetectionJob = "StopEventsDetectionJob" +const opStartTargetedSentimentDetectionJob = "StartTargetedSentimentDetectionJob" -// StopEventsDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StopEventsDetectionJob operation. The "output" return +// 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 StopEventsDetectionJob for more information on using the StopEventsDetectionJob +// 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 StopEventsDetectionJobRequest method. -// req, resp := client.StopEventsDetectionJobRequest(params) +// // 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/StopEventsDetectionJob -func (c *Comprehend) StopEventsDetectionJobRequest(input *StopEventsDetectionJobInput) (req *request.Request, output *StopEventsDetectionJobOutput) { +// 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: opStopEventsDetectionJob, + Name: opStartTargetedSentimentDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StopEventsDetectionJobInput{} + input = &StartTargetedSentimentDetectionJobInput{} } - output = &StopEventsDetectionJobOutput{} + output = &StartTargetedSentimentDetectionJobOutput{} req = c.newRequest(op, input, output) return } -// StopEventsDetectionJob API operation for Amazon Comprehend. +// StartTargetedSentimentDetectionJob API operation for Amazon Comprehend. // -// Stops an events detection job in progress. +// Starts an asynchronous targeted sentiment detection job for a collection +// of documents. Use the DescribeTargetedSentimentDetectionJob 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 StopEventsDetectionJob for usage and error information. +// API operation StartTargetedSentimentDetectionJob 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. +// +// - 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/StopEventsDetectionJob -func (c *Comprehend) StopEventsDetectionJob(input *StopEventsDetectionJobInput) (*StopEventsDetectionJobOutput, error) { - req, out := c.StopEventsDetectionJobRequest(input) +// 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() } -// StopEventsDetectionJobWithContext is the same as StopEventsDetectionJob with the addition of +// StartTargetedSentimentDetectionJobWithContext is the same as StartTargetedSentimentDetectionJob with the addition of // the ability to pass a context and additional request options. // -// See StopEventsDetectionJob for details on how to use this API operation. +// 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) StopEventsDetectionJobWithContext(ctx aws.Context, input *StopEventsDetectionJobInput, opts ...request.Option) (*StopEventsDetectionJobOutput, error) { - req, out := c.StopEventsDetectionJobRequest(input) +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 opStopKeyPhrasesDetectionJob = "StopKeyPhrasesDetectionJob" +const opStartTopicsDetectionJob = "StartTopicsDetectionJob" -// StopKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StopKeyPhrasesDetectionJob operation. The "output" return +// StartTopicsDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StartTopicsDetectionJob 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 StopKeyPhrasesDetectionJob for more information on using the StopKeyPhrasesDetectionJob +// See StartTopicsDetectionJob for more information on using the StartTopicsDetectionJob // 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 StopKeyPhrasesDetectionJobRequest method. -// req, resp := client.StopKeyPhrasesDetectionJobRequest(params) +// // Example sending a request using the StartTopicsDetectionJobRequest method. +// req, resp := client.StartTopicsDetectionJobRequest(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/StopKeyPhrasesDetectionJob -func (c *Comprehend) StopKeyPhrasesDetectionJobRequest(input *StopKeyPhrasesDetectionJobInput) (req *request.Request, output *StopKeyPhrasesDetectionJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob +func (c *Comprehend) StartTopicsDetectionJobRequest(input *StartTopicsDetectionJobInput) (req *request.Request, output *StartTopicsDetectionJobOutput) { op := &request.Operation{ - Name: opStopKeyPhrasesDetectionJob, + Name: opStartTopicsDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StopKeyPhrasesDetectionJobInput{} + input = &StartTopicsDetectionJobInput{} } - output = &StopKeyPhrasesDetectionJobOutput{} + output = &StartTopicsDetectionJobOutput{} req = c.newRequest(op, input, output) return } -// StopKeyPhrasesDetectionJob API operation for Amazon Comprehend. -// -// 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. +// StartTopicsDetectionJob API operation for Amazon Comprehend. // -// When a job is stopped, any documents already processed are written to the -// output location. +// Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob +// 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 StopKeyPhrasesDetectionJob for usage and error information. +// API operation StartTopicsDetectionJob 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. +// +// - 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/StopKeyPhrasesDetectionJob -func (c *Comprehend) StopKeyPhrasesDetectionJob(input *StopKeyPhrasesDetectionJobInput) (*StopKeyPhrasesDetectionJobOutput, error) { - req, out := c.StopKeyPhrasesDetectionJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob +func (c *Comprehend) StartTopicsDetectionJob(input *StartTopicsDetectionJobInput) (*StartTopicsDetectionJobOutput, error) { + req, out := c.StartTopicsDetectionJobRequest(input) return out, req.Send() } -// StopKeyPhrasesDetectionJobWithContext is the same as StopKeyPhrasesDetectionJob with the addition of +// StartTopicsDetectionJobWithContext is the same as StartTopicsDetectionJob with the addition of // the ability to pass a context and additional request options. // -// See StopKeyPhrasesDetectionJob for details on how to use this API operation. +// See StartTopicsDetectionJob 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) StopKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *StopKeyPhrasesDetectionJobInput, opts ...request.Option) (*StopKeyPhrasesDetectionJobOutput, error) { - req, out := c.StopKeyPhrasesDetectionJobRequest(input) +func (c *Comprehend) StartTopicsDetectionJobWithContext(ctx aws.Context, input *StartTopicsDetectionJobInput, opts ...request.Option) (*StartTopicsDetectionJobOutput, error) { + req, out := c.StartTopicsDetectionJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStopPiiEntitiesDetectionJob = "StopPiiEntitiesDetectionJob" +const opStopDominantLanguageDetectionJob = "StopDominantLanguageDetectionJob" -// StopPiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StopPiiEntitiesDetectionJob operation. The "output" return +// StopDominantLanguageDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StopDominantLanguageDetectionJob 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 StopPiiEntitiesDetectionJob for more information on using the StopPiiEntitiesDetectionJob +// See StopDominantLanguageDetectionJob for more information on using the StopDominantLanguageDetectionJob // 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 StopPiiEntitiesDetectionJobRequest method. -// req, resp := client.StopPiiEntitiesDetectionJobRequest(params) +// // Example sending a request using the StopDominantLanguageDetectionJobRequest method. +// req, resp := client.StopDominantLanguageDetectionJobRequest(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/StopPiiEntitiesDetectionJob -func (c *Comprehend) StopPiiEntitiesDetectionJobRequest(input *StopPiiEntitiesDetectionJobInput) (req *request.Request, output *StopPiiEntitiesDetectionJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopDominantLanguageDetectionJob +func (c *Comprehend) StopDominantLanguageDetectionJobRequest(input *StopDominantLanguageDetectionJobInput) (req *request.Request, output *StopDominantLanguageDetectionJobOutput) { op := &request.Operation{ - Name: opStopPiiEntitiesDetectionJob, + Name: opStopDominantLanguageDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StopPiiEntitiesDetectionJobInput{} + input = &StopDominantLanguageDetectionJobInput{} } - output = &StopPiiEntitiesDetectionJobOutput{} + output = &StopDominantLanguageDetectionJobOutput{} req = c.newRequest(op, input, output) return } -// StopPiiEntitiesDetectionJob API operation for Amazon Comprehend. +// StopDominantLanguageDetectionJob API operation for Amazon Comprehend. // -// Stops a PII entities detection job in progress. +// 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. // // 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 StopPiiEntitiesDetectionJob for usage and error information. +// API operation StopDominantLanguageDetectionJob for usage and error information. // // Returned Error Types: // @@ -6970,76 +7767,76 @@ func (c *Comprehend) StopPiiEntitiesDetectionJobRequest(input *StopPiiEntitiesDe // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJob -func (c *Comprehend) StopPiiEntitiesDetectionJob(input *StopPiiEntitiesDetectionJobInput) (*StopPiiEntitiesDetectionJobOutput, error) { - req, out := c.StopPiiEntitiesDetectionJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopDominantLanguageDetectionJob +func (c *Comprehend) StopDominantLanguageDetectionJob(input *StopDominantLanguageDetectionJobInput) (*StopDominantLanguageDetectionJobOutput, error) { + req, out := c.StopDominantLanguageDetectionJobRequest(input) return out, req.Send() } -// StopPiiEntitiesDetectionJobWithContext is the same as StopPiiEntitiesDetectionJob with the addition of +// StopDominantLanguageDetectionJobWithContext is the same as StopDominantLanguageDetectionJob with the addition of // the ability to pass a context and additional request options. // -// See StopPiiEntitiesDetectionJob for details on how to use this API operation. +// See StopDominantLanguageDetectionJob 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) StopPiiEntitiesDetectionJobWithContext(ctx aws.Context, input *StopPiiEntitiesDetectionJobInput, opts ...request.Option) (*StopPiiEntitiesDetectionJobOutput, error) { - req, out := c.StopPiiEntitiesDetectionJobRequest(input) +func (c *Comprehend) StopDominantLanguageDetectionJobWithContext(ctx aws.Context, input *StopDominantLanguageDetectionJobInput, opts ...request.Option) (*StopDominantLanguageDetectionJobOutput, error) { + req, out := c.StopDominantLanguageDetectionJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStopSentimentDetectionJob = "StopSentimentDetectionJob" +const opStopEntitiesDetectionJob = "StopEntitiesDetectionJob" -// StopSentimentDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StopSentimentDetectionJob operation. The "output" return +// StopEntitiesDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StopEntitiesDetectionJob 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 StopSentimentDetectionJob for more information on using the StopSentimentDetectionJob +// See StopEntitiesDetectionJob for more information on using the StopEntitiesDetectionJob // 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 StopSentimentDetectionJobRequest method. -// req, resp := client.StopSentimentDetectionJobRequest(params) +// // Example sending a request using the StopEntitiesDetectionJobRequest method. +// req, resp := client.StopEntitiesDetectionJobRequest(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/StopSentimentDetectionJob -func (c *Comprehend) StopSentimentDetectionJobRequest(input *StopSentimentDetectionJobInput) (req *request.Request, output *StopSentimentDetectionJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEntitiesDetectionJob +func (c *Comprehend) StopEntitiesDetectionJobRequest(input *StopEntitiesDetectionJobInput) (req *request.Request, output *StopEntitiesDetectionJobOutput) { op := &request.Operation{ - Name: opStopSentimentDetectionJob, + Name: opStopEntitiesDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StopSentimentDetectionJobInput{} + input = &StopEntitiesDetectionJobInput{} } - output = &StopSentimentDetectionJobOutput{} + output = &StopEntitiesDetectionJobOutput{} req = c.newRequest(op, input, output) return } -// StopSentimentDetectionJob API operation for Amazon Comprehend. +// StopEntitiesDetectionJob API operation for Amazon Comprehend. // -// Stops a sentiment detection job in progress. +// Stops an entities detection job in progress. // -// If the job state is IN_PROGRESS, the job is marked for termination and put +// 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 +// 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 @@ -7053,7 +7850,7 @@ func (c *Comprehend) StopSentimentDetectionJobRequest(input *StopSentimentDetect // the error. // // See the AWS API reference guide for Amazon Comprehend's -// API operation StopSentimentDetectionJob for usage and error information. +// API operation StopEntitiesDetectionJob for usage and error information. // // Returned Error Types: // @@ -7066,90 +7863,79 @@ func (c *Comprehend) StopSentimentDetectionJobRequest(input *StopSentimentDetect // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopSentimentDetectionJob -func (c *Comprehend) StopSentimentDetectionJob(input *StopSentimentDetectionJobInput) (*StopSentimentDetectionJobOutput, error) { - req, out := c.StopSentimentDetectionJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEntitiesDetectionJob +func (c *Comprehend) StopEntitiesDetectionJob(input *StopEntitiesDetectionJobInput) (*StopEntitiesDetectionJobOutput, error) { + req, out := c.StopEntitiesDetectionJobRequest(input) return out, req.Send() } -// StopSentimentDetectionJobWithContext is the same as StopSentimentDetectionJob with the addition of +// StopEntitiesDetectionJobWithContext is the same as StopEntitiesDetectionJob with the addition of // the ability to pass a context and additional request options. // -// See StopSentimentDetectionJob for details on how to use this API operation. +// See StopEntitiesDetectionJob 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) StopSentimentDetectionJobWithContext(ctx aws.Context, input *StopSentimentDetectionJobInput, opts ...request.Option) (*StopSentimentDetectionJobOutput, error) { - req, out := c.StopSentimentDetectionJobRequest(input) +func (c *Comprehend) StopEntitiesDetectionJobWithContext(ctx aws.Context, input *StopEntitiesDetectionJobInput, opts ...request.Option) (*StopEntitiesDetectionJobOutput, error) { + req, out := c.StopEntitiesDetectionJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStopTargetedSentimentDetectionJob = "StopTargetedSentimentDetectionJob" +const opStopEventsDetectionJob = "StopEventsDetectionJob" -// StopTargetedSentimentDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StopTargetedSentimentDetectionJob operation. The "output" return +// StopEventsDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StopEventsDetectionJob 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 +// See StopEventsDetectionJob for more information on using the StopEventsDetectionJob // 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) +// // Example sending a request using the StopEventsDetectionJobRequest method. +// req, resp := client.StopEventsDetectionJobRequest(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) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJob +func (c *Comprehend) StopEventsDetectionJobRequest(input *StopEventsDetectionJobInput) (req *request.Request, output *StopEventsDetectionJobOutput) { op := &request.Operation{ - Name: opStopTargetedSentimentDetectionJob, + Name: opStopEventsDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StopTargetedSentimentDetectionJobInput{} + input = &StopEventsDetectionJobInput{} } - output = &StopTargetedSentimentDetectionJobOutput{} + output = &StopEventsDetectionJobOutput{} req = c.newRequest(op, input, output) return } -// StopTargetedSentimentDetectionJob API operation for Amazon Comprehend. -// -// Stops a targeted sentiment detection job in progress. +// StopEventsDetectionJob API operation for Amazon Comprehend. // -// 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. +// Stops an events detection job in progress. // // 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. +// API operation StopEventsDetectionJob for usage and error information. // // Returned Error Types: // @@ -7162,467 +7948,459 @@ func (c *Comprehend) StopTargetedSentimentDetectionJobRequest(input *StopTargete // - 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) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJob +func (c *Comprehend) StopEventsDetectionJob(input *StopEventsDetectionJobInput) (*StopEventsDetectionJobOutput, error) { + req, out := c.StopEventsDetectionJobRequest(input) return out, req.Send() } -// StopTargetedSentimentDetectionJobWithContext is the same as StopTargetedSentimentDetectionJob with the addition of +// StopEventsDetectionJobWithContext is the same as StopEventsDetectionJob 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. +// See StopEventsDetectionJob 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) +func (c *Comprehend) StopEventsDetectionJobWithContext(ctx aws.Context, input *StopEventsDetectionJobInput, opts ...request.Option) (*StopEventsDetectionJobOutput, error) { + req, out := c.StopEventsDetectionJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStopTrainingDocumentClassifier = "StopTrainingDocumentClassifier" +const opStopKeyPhrasesDetectionJob = "StopKeyPhrasesDetectionJob" -// StopTrainingDocumentClassifierRequest generates a "aws/request.Request" representing the -// client's request for the StopTrainingDocumentClassifier operation. The "output" return +// StopKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StopKeyPhrasesDetectionJob 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 StopTrainingDocumentClassifier for more information on using the StopTrainingDocumentClassifier +// See StopKeyPhrasesDetectionJob for more information on using the StopKeyPhrasesDetectionJob // 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 StopTrainingDocumentClassifierRequest method. -// req, resp := client.StopTrainingDocumentClassifierRequest(params) +// // Example sending a request using the StopKeyPhrasesDetectionJobRequest method. +// req, resp := client.StopKeyPhrasesDetectionJobRequest(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/StopTrainingDocumentClassifier -func (c *Comprehend) StopTrainingDocumentClassifierRequest(input *StopTrainingDocumentClassifierInput) (req *request.Request, output *StopTrainingDocumentClassifierOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopKeyPhrasesDetectionJob +func (c *Comprehend) StopKeyPhrasesDetectionJobRequest(input *StopKeyPhrasesDetectionJobInput) (req *request.Request, output *StopKeyPhrasesDetectionJobOutput) { op := &request.Operation{ - Name: opStopTrainingDocumentClassifier, + Name: opStopKeyPhrasesDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StopTrainingDocumentClassifierInput{} + input = &StopKeyPhrasesDetectionJobInput{} } - output = &StopTrainingDocumentClassifierOutput{} + output = &StopKeyPhrasesDetectionJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// StopTrainingDocumentClassifier API operation for Amazon Comprehend. +// StopKeyPhrasesDetectionJob API operation for Amazon Comprehend. // -// Stops a document classifier training job while in progress. +// Stops a key phrases detection job 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. +// 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. // // 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 StopTrainingDocumentClassifier for usage and error information. +// API operation StopKeyPhrasesDetectionJob 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. -// -// - ResourceNotFoundException -// The specified resource ARN was not found. Check the ARN and try your request -// again. +// - 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/StopTrainingDocumentClassifier -func (c *Comprehend) StopTrainingDocumentClassifier(input *StopTrainingDocumentClassifierInput) (*StopTrainingDocumentClassifierOutput, error) { - req, out := c.StopTrainingDocumentClassifierRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopKeyPhrasesDetectionJob +func (c *Comprehend) StopKeyPhrasesDetectionJob(input *StopKeyPhrasesDetectionJobInput) (*StopKeyPhrasesDetectionJobOutput, error) { + req, out := c.StopKeyPhrasesDetectionJobRequest(input) return out, req.Send() } -// StopTrainingDocumentClassifierWithContext is the same as StopTrainingDocumentClassifier with the addition of +// StopKeyPhrasesDetectionJobWithContext is the same as StopKeyPhrasesDetectionJob with the addition of // the ability to pass a context and additional request options. // -// See StopTrainingDocumentClassifier for details on how to use this API operation. +// See StopKeyPhrasesDetectionJob 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) StopTrainingDocumentClassifierWithContext(ctx aws.Context, input *StopTrainingDocumentClassifierInput, opts ...request.Option) (*StopTrainingDocumentClassifierOutput, error) { - req, out := c.StopTrainingDocumentClassifierRequest(input) +func (c *Comprehend) StopKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *StopKeyPhrasesDetectionJobInput, opts ...request.Option) (*StopKeyPhrasesDetectionJobOutput, error) { + req, out := c.StopKeyPhrasesDetectionJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStopTrainingEntityRecognizer = "StopTrainingEntityRecognizer" +const opStopPiiEntitiesDetectionJob = "StopPiiEntitiesDetectionJob" -// StopTrainingEntityRecognizerRequest generates a "aws/request.Request" representing the -// client's request for the StopTrainingEntityRecognizer operation. The "output" return +// StopPiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StopPiiEntitiesDetectionJob 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 StopTrainingEntityRecognizer for more information on using the StopTrainingEntityRecognizer +// See StopPiiEntitiesDetectionJob for more information on using the StopPiiEntitiesDetectionJob // 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 StopTrainingEntityRecognizerRequest method. -// req, resp := client.StopTrainingEntityRecognizerRequest(params) +// // Example sending a request using the StopPiiEntitiesDetectionJobRequest method. +// req, resp := client.StopPiiEntitiesDetectionJobRequest(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/StopTrainingEntityRecognizer -func (c *Comprehend) StopTrainingEntityRecognizerRequest(input *StopTrainingEntityRecognizerInput) (req *request.Request, output *StopTrainingEntityRecognizerOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJob +func (c *Comprehend) StopPiiEntitiesDetectionJobRequest(input *StopPiiEntitiesDetectionJobInput) (req *request.Request, output *StopPiiEntitiesDetectionJobOutput) { op := &request.Operation{ - Name: opStopTrainingEntityRecognizer, + Name: opStopPiiEntitiesDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StopTrainingEntityRecognizerInput{} + input = &StopPiiEntitiesDetectionJobInput{} } - output = &StopTrainingEntityRecognizerOutput{} + output = &StopPiiEntitiesDetectionJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// StopTrainingEntityRecognizer API operation for Amazon Comprehend. -// -// Stops an entity recognizer training job while in progress. +// StopPiiEntitiesDetectionJob API operation for Amazon Comprehend. // -// 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. +// Stops a PII entities detection job in progress. // // 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 StopTrainingEntityRecognizer for usage and error information. +// API operation StopPiiEntitiesDetectionJob 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. -// -// - ResourceNotFoundException -// The specified resource ARN was not found. Check the ARN and try your request -// again. +// - 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/StopTrainingEntityRecognizer -func (c *Comprehend) StopTrainingEntityRecognizer(input *StopTrainingEntityRecognizerInput) (*StopTrainingEntityRecognizerOutput, error) { - req, out := c.StopTrainingEntityRecognizerRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJob +func (c *Comprehend) StopPiiEntitiesDetectionJob(input *StopPiiEntitiesDetectionJobInput) (*StopPiiEntitiesDetectionJobOutput, error) { + req, out := c.StopPiiEntitiesDetectionJobRequest(input) return out, req.Send() } -// StopTrainingEntityRecognizerWithContext is the same as StopTrainingEntityRecognizer with the addition of +// StopPiiEntitiesDetectionJobWithContext is the same as StopPiiEntitiesDetectionJob with the addition of // the ability to pass a context and additional request options. // -// See StopTrainingEntityRecognizer for details on how to use this API operation. +// See StopPiiEntitiesDetectionJob 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) StopTrainingEntityRecognizerWithContext(ctx aws.Context, input *StopTrainingEntityRecognizerInput, opts ...request.Option) (*StopTrainingEntityRecognizerOutput, error) { - req, out := c.StopTrainingEntityRecognizerRequest(input) +func (c *Comprehend) StopPiiEntitiesDetectionJobWithContext(ctx aws.Context, input *StopPiiEntitiesDetectionJobInput, opts ...request.Option) (*StopPiiEntitiesDetectionJobOutput, error) { + req, out := c.StopPiiEntitiesDetectionJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opTagResource = "TagResource" +const opStopSentimentDetectionJob = "StopSentimentDetectionJob" -// TagResourceRequest generates a "aws/request.Request" representing the -// client's request for the TagResource operation. The "output" return +// StopSentimentDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StopSentimentDetectionJob 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 TagResource for more information on using the TagResource +// See StopSentimentDetectionJob for more information on using the StopSentimentDetectionJob // 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 TagResourceRequest method. -// req, resp := client.TagResourceRequest(params) +// // Example sending a request using the StopSentimentDetectionJobRequest method. +// req, resp := client.StopSentimentDetectionJobRequest(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/TagResource -func (c *Comprehend) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopSentimentDetectionJob +func (c *Comprehend) StopSentimentDetectionJobRequest(input *StopSentimentDetectionJobInput) (req *request.Request, output *StopSentimentDetectionJobOutput) { op := &request.Operation{ - Name: opTagResource, + Name: opStopSentimentDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &TagResourceInput{} + input = &StopSentimentDetectionJobInput{} } - output = &TagResourceOutput{} + output = &StopSentimentDetectionJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// TagResource API operation for Amazon Comprehend. +// StopSentimentDetectionJob API operation for Amazon Comprehend. // -// 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. +// 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. // // 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 TagResource for usage and error information. +// API operation StopSentimentDetectionJob for usage and error information. // // Returned Error Types: // // - InvalidRequestException // The request is invalid. // -// - ConcurrentModificationException -// Concurrent modification of the tags associated with an Amazon Comprehend -// resource is not supported. -// -// - ResourceNotFoundException -// The specified resource ARN was not found. Check the ARN and try your request -// again. -// -// - 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. +// - 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/TagResource -func (c *Comprehend) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopSentimentDetectionJob +func (c *Comprehend) StopSentimentDetectionJob(input *StopSentimentDetectionJobInput) (*StopSentimentDetectionJobOutput, error) { + req, out := c.StopSentimentDetectionJobRequest(input) return out, req.Send() } -// TagResourceWithContext is the same as TagResource with the addition of +// StopSentimentDetectionJobWithContext is the same as StopSentimentDetectionJob with the addition of // the ability to pass a context and additional request options. // -// See TagResource for details on how to use this API operation. +// See StopSentimentDetectionJob 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) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) +func (c *Comprehend) StopSentimentDetectionJobWithContext(ctx aws.Context, input *StopSentimentDetectionJobInput, opts ...request.Option) (*StopSentimentDetectionJobOutput, error) { + req, out := c.StopSentimentDetectionJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUntagResource = "UntagResource" +const opStopTargetedSentimentDetectionJob = "StopTargetedSentimentDetectionJob" -// UntagResourceRequest generates a "aws/request.Request" representing the -// client's request for the UntagResource operation. The "output" return +// 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 UntagResource for more information on using the UntagResource +// 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 UntagResourceRequest method. -// req, resp := client.UntagResourceRequest(params) +// // 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/UntagResource -func (c *Comprehend) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { +// 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: opUntagResource, + Name: opStopTargetedSentimentDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UntagResourceInput{} + input = &StopTargetedSentimentDetectionJobInput{} } - output = &UntagResourceOutput{} + output = &StopTargetedSentimentDetectionJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UntagResource API operation for Amazon Comprehend. +// StopTargetedSentimentDetectionJob API operation for Amazon Comprehend. // -// Removes a specific tag associated with an Amazon Comprehend resource. +// 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 UntagResource for usage and error information. +// API operation StopTargetedSentimentDetectionJob for usage and error information. // // Returned Error Types: // -// - TooManyTagKeysException -// The request contains more tag keys than can be associated with a resource -// (50 tag keys per resource). -// // - InvalidRequestException // The request is invalid. // -// - ConcurrentModificationException -// Concurrent modification of the tags associated with an Amazon Comprehend -// resource is not supported. -// -// - ResourceNotFoundException -// The specified resource ARN was not found. Check the ARN and try your request -// again. +// - 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/UntagResource -func (c *Comprehend) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) +// 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() } -// UntagResourceWithContext is the same as UntagResource with the addition of +// StopTargetedSentimentDetectionJobWithContext is the same as StopTargetedSentimentDetectionJob with the addition of // the ability to pass a context and additional request options. // -// See UntagResource for details on how to use this API operation. +// 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) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) +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 opUpdateEndpoint = "UpdateEndpoint" +const opStopTrainingDocumentClassifier = "StopTrainingDocumentClassifier" -// UpdateEndpointRequest generates a "aws/request.Request" representing the -// client's request for the UpdateEndpoint operation. The "output" return +// 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. // // 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 UpdateEndpoint for more information on using the UpdateEndpoint +// See StopTrainingDocumentClassifier for more information on using the StopTrainingDocumentClassifier // 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 UpdateEndpointRequest method. -// req, resp := client.UpdateEndpointRequest(params) +// // Example sending a request using the StopTrainingDocumentClassifierRequest method. +// req, resp := client.StopTrainingDocumentClassifierRequest(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/UpdateEndpoint -func (c *Comprehend) UpdateEndpointRequest(input *UpdateEndpointInput) (req *request.Request, output *UpdateEndpointOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingDocumentClassifier +func (c *Comprehend) StopTrainingDocumentClassifierRequest(input *StopTrainingDocumentClassifierInput) (req *request.Request, output *StopTrainingDocumentClassifierOutput) { op := &request.Operation{ - Name: opUpdateEndpoint, + Name: opStopTrainingDocumentClassifier, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UpdateEndpointInput{} + input = &StopTrainingDocumentClassifierInput{} } - output = &UpdateEndpointOutput{} + output = &StopTrainingDocumentClassifierOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateEndpoint API operation for Amazon Comprehend. +// StopTrainingDocumentClassifier API operation for Amazon Comprehend. // -// Updates information about the specified endpoint. For information about endpoints, -// see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). +// 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. // // 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 UpdateEndpoint for usage and error information. +// API operation StopTrainingDocumentClassifier for usage and error information. // // Returned Error Types: // @@ -7632,186 +8410,2774 @@ func (c *Comprehend) UpdateEndpointRequest(input *UpdateEndpointInput) (req *req // - TooManyRequestsException // The number of requests exceeds the limit. Resubmit your request later. // -// - ResourceInUseException -// The specified resource name is already in use. Use a different name and try -// your request again. -// -// - ResourceLimitExceededException -// The maximum number of resources per account has been exceeded. Review the -// resources, and then try your request again. -// // - ResourceNotFoundException // The specified resource ARN was not found. Check the ARN and try your request // again. // -// - ResourceUnavailableException -// The specified resource is not available. Check the resource and try your -// request again. -// // - InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpoint -func (c *Comprehend) UpdateEndpoint(input *UpdateEndpointInput) (*UpdateEndpointOutput, error) { - req, out := c.UpdateEndpointRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingDocumentClassifier +func (c *Comprehend) StopTrainingDocumentClassifier(input *StopTrainingDocumentClassifierInput) (*StopTrainingDocumentClassifierOutput, error) { + req, out := c.StopTrainingDocumentClassifierRequest(input) return out, req.Send() } -// UpdateEndpointWithContext is the same as UpdateEndpoint with the addition of +// StopTrainingDocumentClassifierWithContext is the same as StopTrainingDocumentClassifier with the addition of // the ability to pass a context and additional request options. // -// See UpdateEndpoint for details on how to use this API operation. +// See StopTrainingDocumentClassifier 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) UpdateEndpointWithContext(ctx aws.Context, input *UpdateEndpointInput, opts ...request.Option) (*UpdateEndpointOutput, error) { - req, out := c.UpdateEndpointRequest(input) +func (c *Comprehend) StopTrainingDocumentClassifierWithContext(ctx aws.Context, input *StopTrainingDocumentClassifierInput, opts ...request.Option) (*StopTrainingDocumentClassifierOutput, error) { + req, out := c.StopTrainingDocumentClassifierRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// An augmented manifest file that provides training data for your custom model. -// An augmented manifest file is a labeled dataset that is produced by Amazon -// SageMaker Ground Truth. -type AugmentedManifestsListItem struct { - _ struct{} `type:"structure"` - - // The S3 prefix to the annotation files that are referred in the augmented - // manifest file. - AnnotationDataS3Uri *string `type:"string"` - - // The JSON attribute that contains the annotations for your training documents. - // The number of attribute names that you specify depends on whether your augmented - // manifest file is the output of a single labeling job or a chained labeling - // job. - // - // If your file is the output of a single labeling job, specify the LabelAttributeName - // key that was used when the job was created in Ground Truth. - // - // If your file is the output of a chained labeling job, specify the LabelAttributeName - // key for one or more jobs in the chain. Each LabelAttributeName key provides - // the annotations from an individual job. - // - // AttributeNames is a required field - AttributeNames []*string `type:"list" required:"true"` - - // The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. - // If you don't specify, the default is PlainTextDocument. - // - // * PLAIN_TEXT_DOCUMENT A document type that represents any unicode text - // that is encoded in UTF-8. - // - // * SEMI_STRUCTURED_DOCUMENT A document type with positional and structural - // context, like a PDF. For training with Amazon Comprehend, only PDFs are - // supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT. - DocumentType *string `type:"string" enum:"AugmentedManifestsDocumentTypeFormat"` +const opStopTrainingEntityRecognizer = "StopTrainingEntityRecognizer" - // The Amazon S3 location of the augmented manifest file. - // - // S3Uri is a required field - S3Uri *string `type:"string" required:"true"` +// StopTrainingEntityRecognizerRequest generates a "aws/request.Request" representing the +// client's request for the StopTrainingEntityRecognizer 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 StopTrainingEntityRecognizer for more information on using the StopTrainingEntityRecognizer +// 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 StopTrainingEntityRecognizerRequest method. +// req, resp := client.StopTrainingEntityRecognizerRequest(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/StopTrainingEntityRecognizer +func (c *Comprehend) StopTrainingEntityRecognizerRequest(input *StopTrainingEntityRecognizerInput) (req *request.Request, output *StopTrainingEntityRecognizerOutput) { + op := &request.Operation{ + Name: opStopTrainingEntityRecognizer, + HTTPMethod: "POST", + HTTPPath: "/", + } - // The S3 prefix to the source files (PDFs) that are referred to in the augmented - // manifest file. - SourceDocumentsS3Uri *string `type:"string"` + if input == nil { + input = &StopTrainingEntityRecognizerInput{} + } - // The purpose of the data you've provided in the augmented manifest. You can - // either train or test this data. If you don't specify, the default is train. - // - // TRAIN - all of the documents in the manifest will be used for training. If - // no test documents are provided, Amazon Comprehend will automatically reserve - // a portion of the training documents for testing. - // - // TEST - all of the documents in the manifest will be used for testing. - Split *string `type:"string" enum:"Split"` + output = &StopTrainingEntityRecognizerOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return } -// String returns the string representation. +// StopTrainingEntityRecognizer API operation for Amazon Comprehend. // -// 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 AugmentedManifestsListItem) String() string { - return awsutil.Prettify(s) +// 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. +// +// 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 StopTrainingEntityRecognizer 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. +// +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. +// +// - InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingEntityRecognizer +func (c *Comprehend) StopTrainingEntityRecognizer(input *StopTrainingEntityRecognizerInput) (*StopTrainingEntityRecognizerOutput, error) { + req, out := c.StopTrainingEntityRecognizerRequest(input) + return out, req.Send() } -// GoString returns the string representation. +// StopTrainingEntityRecognizerWithContext is the same as StopTrainingEntityRecognizer with the addition of +// the ability to pass a context and additional request options. // -// 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 AugmentedManifestsListItem) GoString() string { - return s.String() +// See StopTrainingEntityRecognizer 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) StopTrainingEntityRecognizerWithContext(ctx aws.Context, input *StopTrainingEntityRecognizerInput, opts ...request.Option) (*StopTrainingEntityRecognizerOutput, error) { + req, out := c.StopTrainingEntityRecognizerRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *AugmentedManifestsListItem) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "AugmentedManifestsListItem"} - if s.AttributeNames == nil { - invalidParams.Add(request.NewErrParamRequired("AttributeNames")) - } - if s.S3Uri == nil { - invalidParams.Add(request.NewErrParamRequired("S3Uri")) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} +const opTagResource = "TagResource" -// SetAnnotationDataS3Uri sets the AnnotationDataS3Uri field's value. -func (s *AugmentedManifestsListItem) SetAnnotationDataS3Uri(v string) *AugmentedManifestsListItem { - s.AnnotationDataS3Uri = &v - return s +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource 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 TagResource for more information on using the TagResource +// 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 TagResourceRequest method. +// req, resp := client.TagResourceRequest(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/TagResource +func (c *Comprehend) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { + op := &request.Operation{ + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &TagResourceInput{} + } + + output = &TagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// TagResource API operation for Amazon Comprehend. +// +// 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. +// +// 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 TagResource for usage and error information. +// +// Returned Error Types: +// +// - InvalidRequestException +// The request is invalid. +// +// - ConcurrentModificationException +// Concurrent modification of the tags associated with an Amazon Comprehend +// resource is not supported. +// +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. +// +// - 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/TagResource +func (c *Comprehend) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + return out, req.Send() +} + +// TagResourceWithContext is the same as TagResource with the addition of +// the ability to pass a context and additional request options. +// +// See TagResource 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) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUntagResource = "UntagResource" + +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource 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 UntagResource for more information on using the UntagResource +// 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 UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(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/UntagResource +func (c *Comprehend) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UntagResource API operation for Amazon Comprehend. +// +// Removes a specific tag associated with an Amazon Comprehend resource. +// +// 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 UntagResource for usage and error information. +// +// Returned Error Types: +// +// - TooManyTagKeysException +// The request contains more tag keys than can be associated with a resource +// (50 tag keys per resource). +// +// - InvalidRequestException +// The request is invalid. +// +// - ConcurrentModificationException +// Concurrent modification of the tags associated with an Amazon Comprehend +// resource is not supported. +// +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. +// +// - InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UntagResource +func (c *Comprehend) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource with the addition of +// the ability to pass a context and additional request options. +// +// See UntagResource 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) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateEndpoint = "UpdateEndpoint" + +// UpdateEndpointRequest generates a "aws/request.Request" representing the +// client's request for the UpdateEndpoint 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 UpdateEndpoint for more information on using the UpdateEndpoint +// 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 UpdateEndpointRequest method. +// req, resp := client.UpdateEndpointRequest(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/UpdateEndpoint +func (c *Comprehend) UpdateEndpointRequest(input *UpdateEndpointInput) (req *request.Request, output *UpdateEndpointOutput) { + op := &request.Operation{ + Name: opUpdateEndpoint, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateEndpointInput{} + } + + output = &UpdateEndpointOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateEndpoint API operation for Amazon Comprehend. +// +// Updates information about the specified endpoint. For information about endpoints, +// see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). +// +// 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 UpdateEndpoint 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. +// +// - ResourceInUseException +// The specified resource name is already in use. Use a different name and try +// your request again. +// +// - ResourceLimitExceededException +// The maximum number of resources per account has been exceeded. Review the +// resources, and then try your request again. +// +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. +// +// - ResourceUnavailableException +// The specified resource is not available. Check the resource and try your +// request again. +// +// - InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpoint +func (c *Comprehend) UpdateEndpoint(input *UpdateEndpointInput) (*UpdateEndpointOutput, error) { + req, out := c.UpdateEndpointRequest(input) + return out, req.Send() +} + +// UpdateEndpointWithContext is the same as UpdateEndpoint with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateEndpoint 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) UpdateEndpointWithContext(ctx aws.Context, input *UpdateEndpointInput, opts ...request.Option) (*UpdateEndpointOutput, error) { + req, out := c.UpdateEndpointRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateFlywheel = "UpdateFlywheel" + +// UpdateFlywheelRequest generates a "aws/request.Request" representing the +// client's request for the UpdateFlywheel 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 UpdateFlywheel for more information on using the UpdateFlywheel +// 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 UpdateFlywheelRequest method. +// req, resp := client.UpdateFlywheelRequest(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/UpdateFlywheel +func (c *Comprehend) UpdateFlywheelRequest(input *UpdateFlywheelInput) (req *request.Request, output *UpdateFlywheelOutput) { + op := &request.Operation{ + Name: opUpdateFlywheel, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateFlywheelInput{} + } + + output = &UpdateFlywheelOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateFlywheel API operation for Amazon Comprehend. +// +// Update the configuration information for an existing flywheel. +// +// 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 UpdateFlywheel 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. +// +// - ResourceNotFoundException +// The specified resource ARN was not found. Check the ARN and try your request +// again. +// +// - InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateFlywheel +func (c *Comprehend) UpdateFlywheel(input *UpdateFlywheelInput) (*UpdateFlywheelOutput, error) { + req, out := c.UpdateFlywheelRequest(input) + return out, req.Send() +} + +// UpdateFlywheelWithContext is the same as UpdateFlywheel with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateFlywheel 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) UpdateFlywheelWithContext(ctx aws.Context, input *UpdateFlywheelInput, opts ...request.Option) (*UpdateFlywheelOutput, error) { + req, out := c.UpdateFlywheelRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// An augmented manifest file that provides training data for your custom model. +// An augmented manifest file is a labeled dataset that is produced by Amazon +// SageMaker Ground Truth. +type AugmentedManifestsListItem struct { + _ struct{} `type:"structure"` + + // The S3 prefix to the annotation files that are referred in the augmented + // manifest file. + AnnotationDataS3Uri *string `type:"string"` + + // The JSON attribute that contains the annotations for your training documents. + // The number of attribute names that you specify depends on whether your augmented + // manifest file is the output of a single labeling job or a chained labeling + // job. + // + // If your file is the output of a single labeling job, specify the LabelAttributeName + // key that was used when the job was created in Ground Truth. + // + // If your file is the output of a chained labeling job, specify the LabelAttributeName + // key for one or more jobs in the chain. Each LabelAttributeName key provides + // the annotations from an individual job. + // + // AttributeNames is a required field + AttributeNames []*string `type:"list" required:"true"` + + // The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. + // If you don't specify, the default is PlainTextDocument. + // + // * PLAIN_TEXT_DOCUMENT A document type that represents any unicode text + // that is encoded in UTF-8. + // + // * SEMI_STRUCTURED_DOCUMENT A document type with positional and structural + // context, like a PDF. For training with Amazon Comprehend, only PDFs are + // supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT. + DocumentType *string `type:"string" enum:"AugmentedManifestsDocumentTypeFormat"` + + // The Amazon S3 location of the augmented manifest file. + // + // S3Uri is a required field + S3Uri *string `type:"string" required:"true"` + + // The S3 prefix to the source files (PDFs) that are referred to in the augmented + // manifest file. + SourceDocumentsS3Uri *string `type:"string"` + + // The purpose of the data you've provided in the augmented manifest. You can + // either train or test this data. If you don't specify, the default is train. + // + // TRAIN - all of the documents in the manifest will be used for training. If + // no test documents are provided, Amazon Comprehend will automatically reserve + // a portion of the training documents for testing. + // + // TEST - all of the documents in the manifest will be used for testing. + Split *string `type:"string" enum:"Split"` +} + +// 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 AugmentedManifestsListItem) 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 AugmentedManifestsListItem) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AugmentedManifestsListItem) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AugmentedManifestsListItem"} + if s.AttributeNames == nil { + invalidParams.Add(request.NewErrParamRequired("AttributeNames")) + } + if s.S3Uri == nil { + invalidParams.Add(request.NewErrParamRequired("S3Uri")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAnnotationDataS3Uri sets the AnnotationDataS3Uri field's value. +func (s *AugmentedManifestsListItem) SetAnnotationDataS3Uri(v string) *AugmentedManifestsListItem { + s.AnnotationDataS3Uri = &v + return s +} + +// SetAttributeNames sets the AttributeNames field's value. +func (s *AugmentedManifestsListItem) SetAttributeNames(v []*string) *AugmentedManifestsListItem { + s.AttributeNames = v + return s +} + +// SetDocumentType sets the DocumentType field's value. +func (s *AugmentedManifestsListItem) SetDocumentType(v string) *AugmentedManifestsListItem { + s.DocumentType = &v + return s +} + +// SetS3Uri sets the S3Uri field's value. +func (s *AugmentedManifestsListItem) SetS3Uri(v string) *AugmentedManifestsListItem { + s.S3Uri = &v + return s +} + +// SetSourceDocumentsS3Uri sets the SourceDocumentsS3Uri field's value. +func (s *AugmentedManifestsListItem) SetSourceDocumentsS3Uri(v string) *AugmentedManifestsListItem { + s.SourceDocumentsS3Uri = &v + return s +} + +// SetSplit sets the Split field's value. +func (s *AugmentedManifestsListItem) SetSplit(v string) *AugmentedManifestsListItem { + s.Split = &v + return s +} + +type BatchDetectDominantLanguageInput struct { + _ struct{} `type:"structure"` + + // A list containing the UTF-8 encoded text of the input documents. The list + // can contain a maximum of 25 documents. Each document should contain at least + // 20 characters. The maximum size of each document is 5 KB. + // + // TextList is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by BatchDetectDominantLanguageInput's + // String and GoString methods. + // + // TextList is a required field + TextList []*string `min:"1" type:"list" required:"true" sensitive:"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 BatchDetectDominantLanguageInput) 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 BatchDetectDominantLanguageInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchDetectDominantLanguageInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchDetectDominantLanguageInput"} + if s.TextList == nil { + invalidParams.Add(request.NewErrParamRequired("TextList")) + } + if s.TextList != nil && len(s.TextList) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TextList", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetTextList sets the TextList field's value. +func (s *BatchDetectDominantLanguageInput) SetTextList(v []*string) *BatchDetectDominantLanguageInput { + s.TextList = v + return s +} + +// The result of calling the operation. The operation returns one object for +// each document that is successfully processed by the operation. +type BatchDetectDominantLanguageItemResult struct { + _ struct{} `type:"structure"` + + // The zero-based index of the document in the input list. + Index *int64 `type:"integer"` + + // One or more DominantLanguage objects describing the dominant languages in + // the document. + Languages []*DominantLanguage `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 BatchDetectDominantLanguageItemResult) 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 BatchDetectDominantLanguageItemResult) GoString() string { + return s.String() +} + +// SetIndex sets the Index field's value. +func (s *BatchDetectDominantLanguageItemResult) SetIndex(v int64) *BatchDetectDominantLanguageItemResult { + s.Index = &v + return s +} + +// SetLanguages sets the Languages field's value. +func (s *BatchDetectDominantLanguageItemResult) SetLanguages(v []*DominantLanguage) *BatchDetectDominantLanguageItemResult { + s.Languages = v + return s +} + +type BatchDetectDominantLanguageOutput struct { + _ struct{} `type:"structure" sensitive:"true"` + + // A list containing one object for each document that contained an error. The + // results are sorted in ascending order by the Index field and match the order + // of the documents in the input list. If there are no errors in the batch, + // the ErrorList is empty. + // + // ErrorList is a required field + ErrorList []*BatchItemError `type:"list" required:"true"` + + // A list of objects containing the results of the operation. The results are + // sorted in ascending order by the Index field and match the order of the documents + // in the input list. If all of the documents contain an error, the ResultList + // is empty. + // + // ResultList is a required field + ResultList []*BatchDetectDominantLanguageItemResult `type:"list" 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 BatchDetectDominantLanguageOutput) 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 BatchDetectDominantLanguageOutput) GoString() string { + return s.String() +} + +// SetErrorList sets the ErrorList field's value. +func (s *BatchDetectDominantLanguageOutput) SetErrorList(v []*BatchItemError) *BatchDetectDominantLanguageOutput { + s.ErrorList = v + return s +} + +// SetResultList sets the ResultList field's value. +func (s *BatchDetectDominantLanguageOutput) SetResultList(v []*BatchDetectDominantLanguageItemResult) *BatchDetectDominantLanguageOutput { + s.ResultList = v + return s +} + +type BatchDetectEntitiesInput struct { + _ struct{} `type:"structure"` + + // 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"` + + // A list containing the UTF-8 encoded text of the input documents. The list + // can contain a maximum of 25 documents. The maximum size of each document + // is 5 KB. + // + // TextList is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by BatchDetectEntitiesInput's + // String and GoString methods. + // + // TextList is a required field + TextList []*string `min:"1" type:"list" required:"true" sensitive:"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 BatchDetectEntitiesInput) 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 BatchDetectEntitiesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchDetectEntitiesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchDetectEntitiesInput"} + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) + } + if s.TextList == nil { + invalidParams.Add(request.NewErrParamRequired("TextList")) + } + if s.TextList != nil && len(s.TextList) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TextList", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *BatchDetectEntitiesInput) SetLanguageCode(v string) *BatchDetectEntitiesInput { + s.LanguageCode = &v + return s +} + +// SetTextList sets the TextList field's value. +func (s *BatchDetectEntitiesInput) SetTextList(v []*string) *BatchDetectEntitiesInput { + s.TextList = v + return s +} + +// The result of calling the operation. The operation returns one object for +// each document that is successfully processed by the operation. +type BatchDetectEntitiesItemResult struct { + _ struct{} `type:"structure"` + + // One or more Entity objects, one for each entity detected in the document. + Entities []*Entity `type:"list"` + + // The zero-based index of the document in the input list. + Index *int64 `type:"integer"` +} + +// 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 BatchDetectEntitiesItemResult) 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 BatchDetectEntitiesItemResult) GoString() string { + return s.String() +} + +// SetEntities sets the Entities field's value. +func (s *BatchDetectEntitiesItemResult) SetEntities(v []*Entity) *BatchDetectEntitiesItemResult { + s.Entities = v + return s +} + +// SetIndex sets the Index field's value. +func (s *BatchDetectEntitiesItemResult) SetIndex(v int64) *BatchDetectEntitiesItemResult { + s.Index = &v + return s +} + +type BatchDetectEntitiesOutput struct { + _ struct{} `type:"structure" sensitive:"true"` + + // A list containing one object for each document that contained an error. The + // results are sorted in ascending order by the Index field and match the order + // of the documents in the input list. If there are no errors in the batch, + // the ErrorList is empty. + // + // ErrorList is a required field + ErrorList []*BatchItemError `type:"list" required:"true"` + + // A list of objects containing the results of the operation. The results are + // sorted in ascending order by the Index field and match the order of the documents + // in the input list. If all of the documents contain an error, the ResultList + // is empty. + // + // ResultList is a required field + ResultList []*BatchDetectEntitiesItemResult `type:"list" 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 BatchDetectEntitiesOutput) 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 BatchDetectEntitiesOutput) GoString() string { + return s.String() +} + +// SetErrorList sets the ErrorList field's value. +func (s *BatchDetectEntitiesOutput) SetErrorList(v []*BatchItemError) *BatchDetectEntitiesOutput { + s.ErrorList = v + return s +} + +// SetResultList sets the ResultList field's value. +func (s *BatchDetectEntitiesOutput) SetResultList(v []*BatchDetectEntitiesItemResult) *BatchDetectEntitiesOutput { + s.ResultList = v + return s +} + +type BatchDetectKeyPhrasesInput struct { + _ struct{} `type:"structure"` + + // 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"` + + // A list containing the UTF-8 encoded text of the input documents. The list + // can contain a maximum of 25 documents. The maximum size of each document + // is 5 KB. + // + // TextList is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by BatchDetectKeyPhrasesInput's + // String and GoString methods. + // + // TextList is a required field + TextList []*string `min:"1" type:"list" required:"true" sensitive:"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 BatchDetectKeyPhrasesInput) 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 BatchDetectKeyPhrasesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchDetectKeyPhrasesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchDetectKeyPhrasesInput"} + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) + } + if s.TextList == nil { + invalidParams.Add(request.NewErrParamRequired("TextList")) + } + if s.TextList != nil && len(s.TextList) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TextList", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *BatchDetectKeyPhrasesInput) SetLanguageCode(v string) *BatchDetectKeyPhrasesInput { + s.LanguageCode = &v + return s +} + +// SetTextList sets the TextList field's value. +func (s *BatchDetectKeyPhrasesInput) SetTextList(v []*string) *BatchDetectKeyPhrasesInput { + s.TextList = v + return s +} + +// The result of calling the operation. The operation returns one object for +// each document that is successfully processed by the operation. +type BatchDetectKeyPhrasesItemResult struct { + _ struct{} `type:"structure"` + + // The zero-based index of the document in the input list. + Index *int64 `type:"integer"` + + // One or more KeyPhrase objects, one for each key phrase detected in the document. + KeyPhrases []*KeyPhrase `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 BatchDetectKeyPhrasesItemResult) 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 BatchDetectKeyPhrasesItemResult) GoString() string { + return s.String() +} + +// SetIndex sets the Index field's value. +func (s *BatchDetectKeyPhrasesItemResult) SetIndex(v int64) *BatchDetectKeyPhrasesItemResult { + s.Index = &v + return s +} + +// SetKeyPhrases sets the KeyPhrases field's value. +func (s *BatchDetectKeyPhrasesItemResult) SetKeyPhrases(v []*KeyPhrase) *BatchDetectKeyPhrasesItemResult { + s.KeyPhrases = v + return s +} + +type BatchDetectKeyPhrasesOutput struct { + _ struct{} `type:"structure" sensitive:"true"` + + // A list containing one object for each document that contained an error. The + // results are sorted in ascending order by the Index field and match the order + // of the documents in the input list. If there are no errors in the batch, + // the ErrorList is empty. + // + // ErrorList is a required field + ErrorList []*BatchItemError `type:"list" required:"true"` + + // A list of objects containing the results of the operation. The results are + // sorted in ascending order by the Index field and match the order of the documents + // in the input list. If all of the documents contain an error, the ResultList + // is empty. + // + // ResultList is a required field + ResultList []*BatchDetectKeyPhrasesItemResult `type:"list" 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 BatchDetectKeyPhrasesOutput) 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 BatchDetectKeyPhrasesOutput) GoString() string { + return s.String() +} + +// SetErrorList sets the ErrorList field's value. +func (s *BatchDetectKeyPhrasesOutput) SetErrorList(v []*BatchItemError) *BatchDetectKeyPhrasesOutput { + s.ErrorList = v + return s +} + +// SetResultList sets the ResultList field's value. +func (s *BatchDetectKeyPhrasesOutput) SetResultList(v []*BatchDetectKeyPhrasesItemResult) *BatchDetectKeyPhrasesOutput { + s.ResultList = v + return s +} + +type BatchDetectSentimentInput struct { + _ struct{} `type:"structure"` + + // 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"` + + // A list containing the UTF-8 encoded text of the input documents. The list + // can contain a maximum of 25 documents. The maximum size of each document + // is 5 KB. + // + // Amazon Comprehend performs real-time sentiment analysis on the first 500 + // characters of the input text and ignores any additional text in the input. + // + // TextList is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by BatchDetectSentimentInput's + // String and GoString methods. + // + // TextList is a required field + TextList []*string `min:"1" type:"list" required:"true" sensitive:"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 BatchDetectSentimentInput) 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 BatchDetectSentimentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchDetectSentimentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchDetectSentimentInput"} + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) + } + if s.TextList == nil { + invalidParams.Add(request.NewErrParamRequired("TextList")) + } + if s.TextList != nil && len(s.TextList) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TextList", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *BatchDetectSentimentInput) SetLanguageCode(v string) *BatchDetectSentimentInput { + s.LanguageCode = &v + return s +} + +// SetTextList sets the TextList field's value. +func (s *BatchDetectSentimentInput) SetTextList(v []*string) *BatchDetectSentimentInput { + s.TextList = v + return s +} + +// The result of calling the operation. The operation returns one object for +// each document that is successfully processed by the operation. +type BatchDetectSentimentItemResult struct { + _ struct{} `type:"structure"` + + // The zero-based index of the document in the input list. + Index *int64 `type:"integer"` + + // The sentiment detected in the document. + Sentiment *string `type:"string" enum:"SentimentType"` + + // The level of confidence that Amazon Comprehend has in the accuracy of its + // sentiment detection. + SentimentScore *SentimentScore `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 BatchDetectSentimentItemResult) 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 BatchDetectSentimentItemResult) GoString() string { + return s.String() +} + +// SetIndex sets the Index field's value. +func (s *BatchDetectSentimentItemResult) SetIndex(v int64) *BatchDetectSentimentItemResult { + s.Index = &v + return s +} + +// SetSentiment sets the Sentiment field's value. +func (s *BatchDetectSentimentItemResult) SetSentiment(v string) *BatchDetectSentimentItemResult { + s.Sentiment = &v + return s +} + +// SetSentimentScore sets the SentimentScore field's value. +func (s *BatchDetectSentimentItemResult) SetSentimentScore(v *SentimentScore) *BatchDetectSentimentItemResult { + s.SentimentScore = v + return s +} + +type BatchDetectSentimentOutput struct { + _ struct{} `type:"structure" sensitive:"true"` + + // A list containing one object for each document that contained an error. The + // results are sorted in ascending order by the Index field and match the order + // of the documents in the input list. If there are no errors in the batch, + // the ErrorList is empty. + // + // ErrorList is a required field + ErrorList []*BatchItemError `type:"list" required:"true"` + + // A list of objects containing the results of the operation. The results are + // sorted in ascending order by the Index field and match the order of the documents + // in the input list. If all of the documents contain an error, the ResultList + // is empty. + // + // ResultList is a required field + ResultList []*BatchDetectSentimentItemResult `type:"list" 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 BatchDetectSentimentOutput) 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 BatchDetectSentimentOutput) GoString() string { + return s.String() +} + +// SetErrorList sets the ErrorList field's value. +func (s *BatchDetectSentimentOutput) SetErrorList(v []*BatchItemError) *BatchDetectSentimentOutput { + s.ErrorList = v + return s +} + +// SetResultList sets the ResultList field's value. +func (s *BatchDetectSentimentOutput) SetResultList(v []*BatchDetectSentimentItemResult) *BatchDetectSentimentOutput { + s.ResultList = v + return s +} + +type BatchDetectSyntaxInput struct { + _ struct{} `type:"structure"` + + // The language of the input documents. You can specify any of the following + // languages supported by Amazon Comprehend: German ("de"), English ("en"), + // Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All + // documents must be in the same language. + // + // LanguageCode is a required field + LanguageCode *string `type:"string" required:"true" enum:"SyntaxLanguageCode"` + + // A list containing the UTF-8 encoded text of the input documents. The list + // can contain a maximum of 25 documents. The maximum size for each document + // is 5 KB. + // + // TextList is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by BatchDetectSyntaxInput's + // String and GoString methods. + // + // TextList is a required field + TextList []*string `min:"1" type:"list" required:"true" sensitive:"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 BatchDetectSyntaxInput) 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 BatchDetectSyntaxInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchDetectSyntaxInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchDetectSyntaxInput"} + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) + } + if s.TextList == nil { + invalidParams.Add(request.NewErrParamRequired("TextList")) + } + if s.TextList != nil && len(s.TextList) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TextList", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *BatchDetectSyntaxInput) SetLanguageCode(v string) *BatchDetectSyntaxInput { + s.LanguageCode = &v + return s +} + +// SetTextList sets the TextList field's value. +func (s *BatchDetectSyntaxInput) SetTextList(v []*string) *BatchDetectSyntaxInput { + s.TextList = v + return s +} + +// The result of calling the operation. The operation returns one object that +// is successfully processed by the operation. +type BatchDetectSyntaxItemResult struct { + _ struct{} `type:"structure"` + + // The zero-based index of the document in the input list. + Index *int64 `type:"integer"` + + // The syntax tokens for the words in the document, one token for each word. + SyntaxTokens []*SyntaxToken `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 BatchDetectSyntaxItemResult) 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 BatchDetectSyntaxItemResult) GoString() string { + return s.String() +} + +// SetIndex sets the Index field's value. +func (s *BatchDetectSyntaxItemResult) SetIndex(v int64) *BatchDetectSyntaxItemResult { + s.Index = &v + return s +} + +// SetSyntaxTokens sets the SyntaxTokens field's value. +func (s *BatchDetectSyntaxItemResult) SetSyntaxTokens(v []*SyntaxToken) *BatchDetectSyntaxItemResult { + s.SyntaxTokens = v + return s +} + +type BatchDetectSyntaxOutput struct { + _ struct{} `type:"structure" sensitive:"true"` + + // A list containing one object for each document that contained an error. The + // results are sorted in ascending order by the Index field and match the order + // of the documents in the input list. If there are no errors in the batch, + // the ErrorList is empty. + // + // ErrorList is a required field + ErrorList []*BatchItemError `type:"list" required:"true"` + + // A list of objects containing the results of the operation. The results are + // sorted in ascending order by the Index field and match the order of the documents + // in the input list. If all of the documents contain an error, the ResultList + // is empty. + // + // ResultList is a required field + ResultList []*BatchDetectSyntaxItemResult `type:"list" 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 BatchDetectSyntaxOutput) 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 BatchDetectSyntaxOutput) GoString() string { + return s.String() +} + +// SetErrorList sets the ErrorList field's value. +func (s *BatchDetectSyntaxOutput) SetErrorList(v []*BatchItemError) *BatchDetectSyntaxOutput { + s.ErrorList = v + return s +} + +// SetResultList sets the ResultList field's value. +func (s *BatchDetectSyntaxOutput) SetResultList(v []*BatchDetectSyntaxItemResult) *BatchDetectSyntaxOutput { + s.ResultList = v + return s +} + +type BatchDetectTargetedSentimentInput struct { + _ struct{} `type:"structure"` + + // The language of the input documents. Currently, English is the only supported + // language. + // + // LanguageCode is a required field + LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` + + // A list containing the UTF-8 encoded text of the input documents. The list + // can contain a maximum of 25 documents. The maximum size of each document + // is 5 KB. + // + // TextList is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by BatchDetectTargetedSentimentInput's + // String and GoString methods. + // + // TextList is a required field + TextList []*string `min:"1" type:"list" required:"true" sensitive:"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 BatchDetectTargetedSentimentInput) 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 BatchDetectTargetedSentimentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchDetectTargetedSentimentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchDetectTargetedSentimentInput"} + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) + } + if s.TextList == nil { + invalidParams.Add(request.NewErrParamRequired("TextList")) + } + if s.TextList != nil && len(s.TextList) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TextList", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *BatchDetectTargetedSentimentInput) SetLanguageCode(v string) *BatchDetectTargetedSentimentInput { + s.LanguageCode = &v + return s +} + +// SetTextList sets the TextList field's value. +func (s *BatchDetectTargetedSentimentInput) SetTextList(v []*string) *BatchDetectTargetedSentimentInput { + s.TextList = v + return s +} + +// Analysis results for one of the documents in the batch. +type BatchDetectTargetedSentimentItemResult struct { + _ struct{} `type:"structure"` + + // An array of targeted sentiment entities. + Entities []*TargetedSentimentEntity `type:"list"` + + // The zero-based index of this result in the input list. + Index *int64 `type:"integer"` +} + +// 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 BatchDetectTargetedSentimentItemResult) 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 BatchDetectTargetedSentimentItemResult) GoString() string { + return s.String() +} + +// SetEntities sets the Entities field's value. +func (s *BatchDetectTargetedSentimentItemResult) SetEntities(v []*TargetedSentimentEntity) *BatchDetectTargetedSentimentItemResult { + s.Entities = v + return s +} + +// SetIndex sets the Index field's value. +func (s *BatchDetectTargetedSentimentItemResult) SetIndex(v int64) *BatchDetectTargetedSentimentItemResult { + s.Index = &v + return s +} + +type BatchDetectTargetedSentimentOutput struct { + _ struct{} `type:"structure" sensitive:"true"` + + // List of errors that the operation can return. + // + // ErrorList is a required field + ErrorList []*BatchItemError `type:"list" required:"true"` + + // A list of objects containing the results of the operation. The results are + // sorted in ascending order by the Index field and match the order of the documents + // in the input list. If all of the documents contain an error, the ResultList + // is empty. + // + // ResultList is a required field + ResultList []*BatchDetectTargetedSentimentItemResult `type:"list" 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 BatchDetectTargetedSentimentOutput) 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 BatchDetectTargetedSentimentOutput) GoString() string { + return s.String() +} + +// SetErrorList sets the ErrorList field's value. +func (s *BatchDetectTargetedSentimentOutput) SetErrorList(v []*BatchItemError) *BatchDetectTargetedSentimentOutput { + s.ErrorList = v + return s +} + +// SetResultList sets the ResultList field's value. +func (s *BatchDetectTargetedSentimentOutput) SetResultList(v []*BatchDetectTargetedSentimentItemResult) *BatchDetectTargetedSentimentOutput { + s.ResultList = v + return s +} + +// Describes an error that occurred while processing a document in a batch. +// The operation returns on BatchItemError object for each document that contained +// an error. +type BatchItemError struct { + _ struct{} `type:"structure"` + + // The numeric error code of the error. + ErrorCode *string `min:"1" type:"string"` + + // A text description of the error. + ErrorMessage *string `min:"1" type:"string"` + + // The zero-based index of the document in the input list. + Index *int64 `type:"integer"` +} + +// 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 BatchItemError) 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 BatchItemError) GoString() string { + return s.String() +} + +// SetErrorCode sets the ErrorCode field's value. +func (s *BatchItemError) SetErrorCode(v string) *BatchItemError { + s.ErrorCode = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *BatchItemError) SetErrorMessage(v string) *BatchItemError { + s.ErrorMessage = &v + return s +} + +// SetIndex sets the Index field's value. +func (s *BatchItemError) SetIndex(v int64) *BatchItemError { + s.Index = &v + return s +} + +// The number of documents in the request exceeds the limit of 25. Try your +// request again with fewer documents. +type BatchSizeLimitExceededException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" 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 BatchSizeLimitExceededException) 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 BatchSizeLimitExceededException) GoString() string { + return s.String() +} + +func newErrorBatchSizeLimitExceededException(v protocol.ResponseMetadata) error { + return &BatchSizeLimitExceededException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *BatchSizeLimitExceededException) Code() string { + return "BatchSizeLimitExceededException" +} + +// Message returns the exception's message. +func (s *BatchSizeLimitExceededException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *BatchSizeLimitExceededException) OrigErr() error { + return nil +} + +func (s *BatchSizeLimitExceededException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *BatchSizeLimitExceededException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *BatchSizeLimitExceededException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Information about each word or line of text in the input document. +// +// For additional information, see Block (https://docs.aws.amazon.com/textract/latest/dg/API_Block.html) +// in the Amazon Textract API reference. +type Block struct { + _ struct{} `type:"structure"` + + // The block represents a line of text or one word of text. + // + // * WORD - A word that's detected on a document page. A word is one or more + // ISO basic Latin script characters that aren't separated by spaces. + // + // * LINE - A string of tab-delimited, contiguous words that are detected + // on a document page + BlockType *string `type:"string" enum:"BlockType"` + + // Co-ordinates of the rectangle or polygon that contains the text. + Geometry *Geometry `type:"structure"` + + // Unique identifier for the block. + Id *string `min:"1" type:"string"` + + // Page number where the block appears. + Page *int64 `type:"integer"` + + // A list of child blocks of the current block. For example, a LINE object has + // child blocks for each WORD block that's part of the line of text. + Relationships []*RelationshipsListItem `type:"list"` + + // The word or line of text extracted from the block. + Text *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 Block) 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 Block) GoString() string { + return s.String() +} + +// SetBlockType sets the BlockType field's value. +func (s *Block) SetBlockType(v string) *Block { + s.BlockType = &v + return s +} + +// SetGeometry sets the Geometry field's value. +func (s *Block) SetGeometry(v *Geometry) *Block { + s.Geometry = v + return s +} + +// SetId sets the Id field's value. +func (s *Block) SetId(v string) *Block { + s.Id = &v + return s +} + +// SetPage sets the Page field's value. +func (s *Block) SetPage(v int64) *Block { + s.Page = &v + return s +} + +// SetRelationships sets the Relationships field's value. +func (s *Block) SetRelationships(v []*RelationshipsListItem) *Block { + s.Relationships = v + return s +} + +// SetText sets the Text field's value. +func (s *Block) SetText(v string) *Block { + s.Text = &v + return s +} + +// A reference to a block. +type BlockReference struct { + _ struct{} `type:"structure"` + + // Offset of the start of the block within its parent block. + BeginOffset *int64 `type:"integer"` + + // Unique identifier for the block. + BlockId *string `min:"1" type:"string"` + + // List of child blocks within this block. + ChildBlocks []*ChildBlock `type:"list"` + + // Offset of the end of the block within its parent block. + EndOffset *int64 `type:"integer"` +} + +// 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 BlockReference) 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 BlockReference) GoString() string { + return s.String() +} + +// SetBeginOffset sets the BeginOffset field's value. +func (s *BlockReference) SetBeginOffset(v int64) *BlockReference { + s.BeginOffset = &v + return s +} + +// SetBlockId sets the BlockId field's value. +func (s *BlockReference) SetBlockId(v string) *BlockReference { + s.BlockId = &v + return s +} + +// SetChildBlocks sets the ChildBlocks field's value. +func (s *BlockReference) SetChildBlocks(v []*ChildBlock) *BlockReference { + s.ChildBlocks = v + return s +} + +// SetEndOffset sets the EndOffset field's value. +func (s *BlockReference) SetEndOffset(v int64) *BlockReference { + s.EndOffset = &v + return s +} + +// The bounding box around the detected page or around an element on a document +// page. The left (x-coordinate) and top (y-coordinate) are coordinates that +// represent the top and left sides of the bounding box. Note that the upper-left +// corner of the image is the origin (0,0). +// +// For additional information, see BoundingBox (https://docs.aws.amazon.com/textract/latest/dg/API_BoundingBox.html) +// in the Amazon Textract API reference. +type BoundingBox struct { + _ struct{} `type:"structure"` + + // The height of the bounding box as a ratio of the overall document page height. + Height *float64 `type:"float"` + + // The left coordinate of the bounding box as a ratio of overall document page + // width. + Left *float64 `type:"float"` + + // The top coordinate of the bounding box as a ratio of overall document page + // height. + Top *float64 `type:"float"` + + // The width of the bounding box as a ratio of the overall document page width. + Width *float64 `type:"float"` +} + +// 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 BoundingBox) 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 BoundingBox) GoString() string { + return s.String() +} + +// SetHeight sets the Height field's value. +func (s *BoundingBox) SetHeight(v float64) *BoundingBox { + s.Height = &v + return s +} + +// SetLeft sets the Left field's value. +func (s *BoundingBox) SetLeft(v float64) *BoundingBox { + s.Left = &v + return s +} + +// SetTop sets the Top field's value. +func (s *BoundingBox) SetTop(v float64) *BoundingBox { + s.Top = &v + return s +} + +// SetWidth sets the Width field's value. +func (s *BoundingBox) SetWidth(v float64) *BoundingBox { + s.Width = &v + return s +} + +// Nested block contained within a block. +type ChildBlock struct { + _ struct{} `type:"structure"` + + // Offset of the start of the child block within its parent block. + BeginOffset *int64 `type:"integer"` + + // Unique identifier for the child block. + ChildBlockId *string `min:"1" type:"string"` + + // Offset of the end of the child block within its parent block. + EndOffset *int64 `type:"integer"` +} + +// 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 ChildBlock) 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 ChildBlock) GoString() string { + return s.String() +} + +// SetBeginOffset sets the BeginOffset field's value. +func (s *ChildBlock) SetBeginOffset(v int64) *ChildBlock { + s.BeginOffset = &v + return s +} + +// SetChildBlockId sets the ChildBlockId field's value. +func (s *ChildBlock) SetChildBlockId(v string) *ChildBlock { + s.ChildBlockId = &v + return s +} + +// SetEndOffset sets the EndOffset field's value. +func (s *ChildBlock) SetEndOffset(v int64) *ChildBlock { + s.EndOffset = &v + return s +} + +// Describes the result metrics for the test data associated with an documentation +// classifier. +type ClassifierEvaluationMetrics struct { + _ struct{} `type:"structure"` + + // The fraction of the labels that were correct recognized. It is computed by + // dividing the number of labels in the test documents that were correctly recognized + // by the total number of labels in the test documents. + Accuracy *float64 `type:"double"` + + // A measure of how accurate the classifier 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. + F1Score *float64 `type:"double"` + + // 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. + HammingLoss *float64 `type:"double"` + + // A measure of how accurate the classifier results are for the test data. It + // is a combination of the Micro Precision and Micro Recall values. The Micro + // F1Score is the harmonic mean of the two scores. The highest score is 1, and + // the worst score is 0. + MicroF1Score *float64 `type:"double"` + + // 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. Unlike the Precision metric which comes from + // averaging the precision of all available labels, this is based on the overall + // score of all precision scores added together. + MicroPrecision *float64 `type:"double"` + + // A measure of how complete the classifier results are for the test data. High + // recall means that the classifier returned most of the relevant results. Specifically, + // this indicates how many of the correct categories in the text that the model + // can predict. It is a percentage of correct categories in the text that can + // found. Instead of averaging the recall scores of all labels (as with Recall), + // micro Recall is based on the overall score of all recall scores added together. + MicroRecall *float64 `type:"double"` + + // A measure of the usefulness of the classifier results in the test data. High + // precision means that the classifier returned substantially more relevant + // results than irrelevant ones. + Precision *float64 `type:"double"` + + // A measure of how complete the classifier results are for the test data. High + // recall means that the classifier returned most of the relevant results. + Recall *float64 `type:"double"` +} + +// 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 ClassifierEvaluationMetrics) 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 ClassifierEvaluationMetrics) GoString() string { + return s.String() +} + +// SetAccuracy sets the Accuracy field's value. +func (s *ClassifierEvaluationMetrics) SetAccuracy(v float64) *ClassifierEvaluationMetrics { + s.Accuracy = &v + return s +} + +// SetF1Score sets the F1Score field's value. +func (s *ClassifierEvaluationMetrics) SetF1Score(v float64) *ClassifierEvaluationMetrics { + s.F1Score = &v + return s +} + +// SetHammingLoss sets the HammingLoss field's value. +func (s *ClassifierEvaluationMetrics) SetHammingLoss(v float64) *ClassifierEvaluationMetrics { + s.HammingLoss = &v + return s +} + +// SetMicroF1Score sets the MicroF1Score field's value. +func (s *ClassifierEvaluationMetrics) SetMicroF1Score(v float64) *ClassifierEvaluationMetrics { + s.MicroF1Score = &v + return s +} + +// SetMicroPrecision sets the MicroPrecision field's value. +func (s *ClassifierEvaluationMetrics) SetMicroPrecision(v float64) *ClassifierEvaluationMetrics { + s.MicroPrecision = &v + return s +} + +// SetMicroRecall sets the MicroRecall field's value. +func (s *ClassifierEvaluationMetrics) SetMicroRecall(v float64) *ClassifierEvaluationMetrics { + s.MicroRecall = &v + return s +} + +// SetPrecision sets the Precision field's value. +func (s *ClassifierEvaluationMetrics) SetPrecision(v float64) *ClassifierEvaluationMetrics { + s.Precision = &v + return s +} + +// SetRecall sets the Recall field's value. +func (s *ClassifierEvaluationMetrics) SetRecall(v float64) *ClassifierEvaluationMetrics { + s.Recall = &v + return s +} + +// Provides information about a document classifier. +type ClassifierMetadata struct { + _ struct{} `type:"structure" sensitive:"true"` + + // Describes the result metrics for the test data associated with an documentation + // classifier. + EvaluationMetrics *ClassifierEvaluationMetrics `type:"structure"` + + // The number of labels in the input data. + NumberOfLabels *int64 `type:"integer"` + + // The number of documents in the input data that were used to test the classifier. + // Typically this is 10 to 20 percent of the input documents, up to 10,000 documents. + NumberOfTestDocuments *int64 `type:"integer"` + + // The number of documents in the input data that were used to train the classifier. + // Typically this is 80 to 90 percent of the input documents. + NumberOfTrainedDocuments *int64 `type:"integer"` +} + +// 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 ClassifierMetadata) 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 ClassifierMetadata) GoString() string { + return s.String() +} + +// SetEvaluationMetrics sets the EvaluationMetrics field's value. +func (s *ClassifierMetadata) SetEvaluationMetrics(v *ClassifierEvaluationMetrics) *ClassifierMetadata { + s.EvaluationMetrics = v + return s +} + +// SetNumberOfLabels sets the NumberOfLabels field's value. +func (s *ClassifierMetadata) SetNumberOfLabels(v int64) *ClassifierMetadata { + s.NumberOfLabels = &v + return s +} + +// SetNumberOfTestDocuments sets the NumberOfTestDocuments field's value. +func (s *ClassifierMetadata) SetNumberOfTestDocuments(v int64) *ClassifierMetadata { + s.NumberOfTestDocuments = &v + return s +} + +// SetNumberOfTrainedDocuments sets the NumberOfTrainedDocuments field's value. +func (s *ClassifierMetadata) SetNumberOfTrainedDocuments(v int64) *ClassifierMetadata { + s.NumberOfTrainedDocuments = &v + return s +} + +type ClassifyDocumentInput struct { + _ struct{} `type:"structure"` + + // Use the Bytes parameter to input a text, PDF, Word or image file. You can + // also use the Bytes parameter to input an Amazon Textract DetectDocumentText + // or AnalyzeDocument output file. + // + // Provide the input document as a sequence of base64-encoded bytes. If your + // code uses an Amazon Web Services SDK to classify documents, the SDK may encode + // the document file bytes for you. + // + // The maximum length of this field depends on the input document type. For + // details, see Inputs for real-time custom analysis (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html) + // in the Comprehend Developer Guide. + // + // If you use the Bytes parameter, do not use the Text parameter. + // Bytes is automatically base64 encoded/decoded by the SDK. + Bytes []byte `min:"1" type:"blob"` + + // Provides configuration parameters to override the default actions for extracting + // text from PDF documents and image files. + DocumentReaderConfig *DocumentReaderConfig `type:"structure"` + + // The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, + // see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). + // + // EndpointArn is a required field + EndpointArn *string `type:"string" required:"true"` + + // The document text to be analyzed. If you enter text using this parameter, + // do not use the Bytes parameter. + // + // Text is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ClassifyDocumentInput's + // String and GoString methods. + Text *string `min:"1" type:"string" sensitive:"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 ClassifyDocumentInput) 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 ClassifyDocumentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ClassifyDocumentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ClassifyDocumentInput"} + if s.Bytes != nil && len(s.Bytes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Bytes", 1)) + } + if s.EndpointArn == nil { + invalidParams.Add(request.NewErrParamRequired("EndpointArn")) + } + if s.Text != nil && len(*s.Text) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Text", 1)) + } + if s.DocumentReaderConfig != nil { + if err := s.DocumentReaderConfig.Validate(); err != nil { + invalidParams.AddNested("DocumentReaderConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBytes sets the Bytes field's value. +func (s *ClassifyDocumentInput) SetBytes(v []byte) *ClassifyDocumentInput { + s.Bytes = v + return s +} + +// SetDocumentReaderConfig sets the DocumentReaderConfig field's value. +func (s *ClassifyDocumentInput) SetDocumentReaderConfig(v *DocumentReaderConfig) *ClassifyDocumentInput { + s.DocumentReaderConfig = v + return s +} + +// SetEndpointArn sets the EndpointArn field's value. +func (s *ClassifyDocumentInput) SetEndpointArn(v string) *ClassifyDocumentInput { + s.EndpointArn = &v + return s +} + +// SetText sets the Text field's value. +func (s *ClassifyDocumentInput) SetText(v string) *ClassifyDocumentInput { + s.Text = &v + return s +} + +type ClassifyDocumentOutput struct { + _ struct{} `type:"structure" sensitive:"true"` + + // The classes used by the document being analyzed. These are used for multi-class + // trained models. Individual classes are mutually exclusive and each document + // is expected to have only a single class assigned to it. For example, an animal + // can be a dog or a cat, but not both at the same time. + Classes []*DocumentClass `type:"list"` + + // Extraction information about the document. This field is present in the response + // only if your request includes the Byte parameter. + DocumentMetadata *DocumentMetadata `type:"structure"` + + // The document type for each page in the input document. This field is present + // in the response only if your request includes the Byte parameter. + DocumentType []*DocumentTypeListItem `type:"list"` + + // Page-level errors that the system detected while processing the input document. + // The field is empty if the system encountered no errors. + Errors []*ErrorsListItem `type:"list"` + + // The labels used the document being analyzed. These are used for multi-label + // trained models. Individual labels represent different categories that are + // related in some manner and are not mutually exclusive. For example, a movie + // can be just an action movie, or it can be an action movie, a science fiction + // movie, and a comedy, all at the same time. + Labels []*DocumentLabel `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 ClassifyDocumentOutput) 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 ClassifyDocumentOutput) GoString() string { + return s.String() +} + +// SetClasses sets the Classes field's value. +func (s *ClassifyDocumentOutput) SetClasses(v []*DocumentClass) *ClassifyDocumentOutput { + s.Classes = v + return s +} + +// SetDocumentMetadata sets the DocumentMetadata field's value. +func (s *ClassifyDocumentOutput) SetDocumentMetadata(v *DocumentMetadata) *ClassifyDocumentOutput { + s.DocumentMetadata = v + return s +} + +// SetDocumentType sets the DocumentType field's value. +func (s *ClassifyDocumentOutput) SetDocumentType(v []*DocumentTypeListItem) *ClassifyDocumentOutput { + s.DocumentType = v + return s +} + +// SetErrors sets the Errors field's value. +func (s *ClassifyDocumentOutput) SetErrors(v []*ErrorsListItem) *ClassifyDocumentOutput { + s.Errors = v + return s +} + +// SetLabels sets the Labels field's value. +func (s *ClassifyDocumentOutput) SetLabels(v []*DocumentLabel) *ClassifyDocumentOutput { + s.Labels = v + return s +} + +// Concurrent modification of the tags associated with an Amazon Comprehend +// resource is not supported. +type ConcurrentModificationException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" 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 ConcurrentModificationException) 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 ConcurrentModificationException) GoString() string { + return s.String() +} + +func newErrorConcurrentModificationException(v protocol.ResponseMetadata) error { + return &ConcurrentModificationException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ConcurrentModificationException) Code() string { + return "ConcurrentModificationException" +} + +// Message returns the exception's message. +func (s *ConcurrentModificationException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ConcurrentModificationException) OrigErr() error { + return nil +} + +func (s *ConcurrentModificationException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ConcurrentModificationException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ConcurrentModificationException) RequestID() string { + return s.RespMetadata.RequestID +} + +type ContainsPiiEntitiesInput struct { + _ struct{} `type:"structure"` + + // The language of the input documents. Currently, English is the only valid + // language. + // + // LanguageCode is a required field + LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` + + // A UTF-8 text string. The maximum string size is 100 KB. + // + // Text is a required field + Text *string `min:"1" type:"string" required:"true"` } -// SetAttributeNames sets the AttributeNames field's value. -func (s *AugmentedManifestsListItem) SetAttributeNames(v []*string) *AugmentedManifestsListItem { - s.AttributeNames = v +// 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 ContainsPiiEntitiesInput) 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 ContainsPiiEntitiesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ContainsPiiEntitiesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ContainsPiiEntitiesInput"} + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) + } + if s.Text == nil { + invalidParams.Add(request.NewErrParamRequired("Text")) + } + if s.Text != nil && len(*s.Text) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Text", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *ContainsPiiEntitiesInput) SetLanguageCode(v string) *ContainsPiiEntitiesInput { + s.LanguageCode = &v return s } -// SetDocumentType sets the DocumentType field's value. -func (s *AugmentedManifestsListItem) SetDocumentType(v string) *AugmentedManifestsListItem { - s.DocumentType = &v +// SetText sets the Text field's value. +func (s *ContainsPiiEntitiesInput) SetText(v string) *ContainsPiiEntitiesInput { + s.Text = &v return s } -// SetS3Uri sets the S3Uri field's value. -func (s *AugmentedManifestsListItem) SetS3Uri(v string) *AugmentedManifestsListItem { - s.S3Uri = &v +type ContainsPiiEntitiesOutput struct { + _ struct{} `type:"structure"` + + // The labels used in the document being analyzed. Individual labels represent + // personally identifiable information (PII) entity types. + Labels []*EntityLabel `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 ContainsPiiEntitiesOutput) 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 ContainsPiiEntitiesOutput) GoString() string { + return s.String() +} + +// SetLabels sets the Labels field's value. +func (s *ContainsPiiEntitiesOutput) SetLabels(v []*EntityLabel) *ContainsPiiEntitiesOutput { + s.Labels = v + return s +} + +type CreateDatasetInput struct { + _ struct{} `type:"structure"` + + // 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"` + + // Name of the dataset. + // + // DatasetName is a required field + DatasetName *string `type:"string" required:"true"` + + // The dataset type. You can specify that the data in a dataset is for training + // the model or for testing the model. + DatasetType *string `type:"string" enum:"DatasetType"` + + // Description of the dataset. + Description *string `type:"string"` + + // The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive + // the data. + // + // FlywheelArn is a required field + FlywheelArn *string `type:"string" required:"true"` + + // Information about the input data configuration. The type of input data varies + // based on the format of the input and whether the data is for a classifier + // model or an entity recognition model. + // + // InputDataConfig is a required field + InputDataConfig *DatasetInputDataConfig `type:"structure" required:"true"` + + // Tags for the dataset. + Tags []*Tag `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 CreateDatasetInput) 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 CreateDatasetInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateDatasetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateDatasetInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) + } + if s.DatasetName == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetName")) + } + if s.FlywheelArn == nil { + invalidParams.Add(request.NewErrParamRequired("FlywheelArn")) + } + if s.InputDataConfig == nil { + invalidParams.Add(request.NewErrParamRequired("InputDataConfig")) + } + if s.InputDataConfig != nil { + if err := s.InputDataConfig.Validate(); err != nil { + invalidParams.AddNested("InputDataConfig", 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 invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *CreateDatasetInput) SetClientRequestToken(v string) *CreateDatasetInput { + s.ClientRequestToken = &v + return s +} + +// SetDatasetName sets the DatasetName field's value. +func (s *CreateDatasetInput) SetDatasetName(v string) *CreateDatasetInput { + s.DatasetName = &v + return s +} + +// SetDatasetType sets the DatasetType field's value. +func (s *CreateDatasetInput) SetDatasetType(v string) *CreateDatasetInput { + s.DatasetType = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateDatasetInput) SetDescription(v string) *CreateDatasetInput { + s.Description = &v + return s +} + +// SetFlywheelArn sets the FlywheelArn field's value. +func (s *CreateDatasetInput) SetFlywheelArn(v string) *CreateDatasetInput { + s.FlywheelArn = &v + return s +} + +// SetInputDataConfig sets the InputDataConfig field's value. +func (s *CreateDatasetInput) SetInputDataConfig(v *DatasetInputDataConfig) *CreateDatasetInput { + s.InputDataConfig = v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateDatasetInput) SetTags(v []*Tag) *CreateDatasetInput { + s.Tags = v + return s +} + +type CreateDatasetOutput struct { + _ struct{} `type:"structure"` + + // The ARN of the dataset. + DatasetArn *string `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 CreateDatasetOutput) 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 CreateDatasetOutput) GoString() string { + return s.String() +} + +// SetDatasetArn sets the DatasetArn field's value. +func (s *CreateDatasetOutput) SetDatasetArn(v string) *CreateDatasetOutput { + s.DatasetArn = &v return s } -// SetSourceDocumentsS3Uri sets the SourceDocumentsS3Uri field's value. -func (s *AugmentedManifestsListItem) SetSourceDocumentsS3Uri(v string) *AugmentedManifestsListItem { - s.SourceDocumentsS3Uri = &v - return s -} +type CreateDocumentClassifierInput struct { + _ struct{} `type:"structure"` + + // 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. + // + // DataAccessRoleArn is a required field + DataAccessRoleArn *string `min:"20" type:"string" required:"true"` + + // The name of the document classifier. + // + // DocumentClassifierName is a required field + DocumentClassifierName *string `type:"string" required:"true"` + + // Specifies the format and location of the input data for the job. + // + // InputDataConfig is a required field + InputDataConfig *DocumentClassifierInputDataConfig `type:"structure" required:"true"` + + // The language of the input documents. You can specify any of the 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"` + + // Indicates the mode in which the classifier will be trained. The classifier + // can be trained in multi-class mode, which identifies one and only one class + // for each document, or multi-label mode, which identifies one or more labels + // for each document. In multi-label mode, multiple labels for an individual + // document are separated by a delimiter. The default delimiter between labels + // is a pipe (|). + Mode *string `type:"string" enum:"DocumentClassifierMode"` + + // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses + // to encrypt trained custom models. The ModelKmsKeyId 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" + ModelKmsKeyId *string `type:"string"` + + // The resource-based policy to attach to your custom document classifier model. + // You can use this policy to allow another AWS account to import your custom + // model. + // + // Provide your policy as a JSON body that you enter as a UTF-8 encoded string + // without line breaks. To provide valid JSON, enclose the attribute names and + // values in double quotes. If the JSON body is also enclosed in double quotes, + // then you must escape the double quotes that are inside the policy: + // + // "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" + // + // To avoid escaping quotes, you can use single quotes to enclose the policy + // and double quotes to enclose the JSON names and values: + // + // '{"attribute": "value", "attribute": ["value"]}' + ModelPolicy *string `min:"1" type:"string"` + + // Enables the addition of output results configuration parameters for custom + // classifier jobs. + OutputDataConfig *DocumentClassifierOutputDataConfig `type:"structure"` -// SetSplit sets the Split field's value. -func (s *AugmentedManifestsListItem) SetSplit(v string) *AugmentedManifestsListItem { - s.Split = &v - return s -} + // Tags to associate with the document classifier. 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. + Tags []*Tag `type:"list"` -type BatchDetectDominantLanguageInput struct { - _ struct{} `type:"structure"` + // The version name given to the newly created classifier. Version names can + // have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and + // underscores (_) are allowed. The version name must be unique among all models + // with the same classifier name in the account/AWS Region. + VersionName *string `type:"string"` - // A list containing the UTF-8 encoded text of the input documents. The list - // can contain a maximum of 25 documents. Each document should contain at least - // 20 characters. The maximum size of each document is 5 KB. + // 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: // - // TextList is a sensitive parameter and its value will be - // replaced with "sensitive" in string returned by BatchDetectDominantLanguageInput's - // String and GoString methods. + // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" // - // TextList is a required field - TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"` + // * 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 your custom classifier. 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. @@ -7819,7 +11185,7 @@ type BatchDetectDominantLanguageInput struct { // 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 BatchDetectDominantLanguageInput) String() string { +func (s CreateDocumentClassifierInput) String() string { return awsutil.Prettify(s) } @@ -7828,18 +11194,53 @@ func (s BatchDetectDominantLanguageInput) String() string { // 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 BatchDetectDominantLanguageInput) GoString() string { +func (s CreateDocumentClassifierInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *BatchDetectDominantLanguageInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchDetectDominantLanguageInput"} - if s.TextList == nil { - invalidParams.Add(request.NewErrParamRequired("TextList")) +func (s *CreateDocumentClassifierInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateDocumentClassifierInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) } - if s.TextList != nil && len(s.TextList) < 1 { - invalidParams.Add(request.NewErrParamMinLen("TextList", 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.DocumentClassifierName == nil { + invalidParams.Add(request.NewErrParamRequired("DocumentClassifierName")) + } + if s.InputDataConfig == nil { + invalidParams.Add(request.NewErrParamRequired("InputDataConfig")) + } + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) + } + if s.ModelPolicy != nil && len(*s.ModelPolicy) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ModelPolicy", 1)) + } + if s.InputDataConfig != nil { + if err := s.InputDataConfig.Validate(); err != nil { + invalidParams.AddNested("InputDataConfig", 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 { @@ -7848,73 +11249,89 @@ func (s *BatchDetectDominantLanguageInput) Validate() error { return nil } -// SetTextList sets the TextList field's value. -func (s *BatchDetectDominantLanguageInput) SetTextList(v []*string) *BatchDetectDominantLanguageInput { - s.TextList = v +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *CreateDocumentClassifierInput) SetClientRequestToken(v string) *CreateDocumentClassifierInput { + s.ClientRequestToken = &v return s } -// The result of calling the operation. The operation returns one object for -// each document that is successfully processed by the operation. -type BatchDetectDominantLanguageItemResult struct { - _ struct{} `type:"structure"` +// SetDataAccessRoleArn sets the DataAccessRoleArn field's value. +func (s *CreateDocumentClassifierInput) SetDataAccessRoleArn(v string) *CreateDocumentClassifierInput { + s.DataAccessRoleArn = &v + return s +} - // The zero-based index of the document in the input list. - Index *int64 `type:"integer"` +// SetDocumentClassifierName sets the DocumentClassifierName field's value. +func (s *CreateDocumentClassifierInput) SetDocumentClassifierName(v string) *CreateDocumentClassifierInput { + s.DocumentClassifierName = &v + return s +} - // One or more DominantLanguage objects describing the dominant languages in - // the document. - Languages []*DominantLanguage `type:"list"` +// SetInputDataConfig sets the InputDataConfig field's value. +func (s *CreateDocumentClassifierInput) SetInputDataConfig(v *DocumentClassifierInputDataConfig) *CreateDocumentClassifierInput { + s.InputDataConfig = v + return s } -// 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 BatchDetectDominantLanguageItemResult) String() string { - return awsutil.Prettify(s) +// SetLanguageCode sets the LanguageCode field's value. +func (s *CreateDocumentClassifierInput) SetLanguageCode(v string) *CreateDocumentClassifierInput { + s.LanguageCode = &v + return 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 BatchDetectDominantLanguageItemResult) GoString() string { - return s.String() +// SetMode sets the Mode field's value. +func (s *CreateDocumentClassifierInput) SetMode(v string) *CreateDocumentClassifierInput { + s.Mode = &v + return s } -// SetIndex sets the Index field's value. -func (s *BatchDetectDominantLanguageItemResult) SetIndex(v int64) *BatchDetectDominantLanguageItemResult { - s.Index = &v +// SetModelKmsKeyId sets the ModelKmsKeyId field's value. +func (s *CreateDocumentClassifierInput) SetModelKmsKeyId(v string) *CreateDocumentClassifierInput { + s.ModelKmsKeyId = &v return s } -// SetLanguages sets the Languages field's value. -func (s *BatchDetectDominantLanguageItemResult) SetLanguages(v []*DominantLanguage) *BatchDetectDominantLanguageItemResult { - s.Languages = v +// SetModelPolicy sets the ModelPolicy field's value. +func (s *CreateDocumentClassifierInput) SetModelPolicy(v string) *CreateDocumentClassifierInput { + s.ModelPolicy = &v return s } -type BatchDetectDominantLanguageOutput struct { - _ struct{} `type:"structure" sensitive:"true"` +// SetOutputDataConfig sets the OutputDataConfig field's value. +func (s *CreateDocumentClassifierInput) SetOutputDataConfig(v *DocumentClassifierOutputDataConfig) *CreateDocumentClassifierInput { + s.OutputDataConfig = v + return s +} - // A list containing one object for each document that contained an error. The - // results are sorted in ascending order by the Index field and match the order - // of the documents in the input list. If there are no errors in the batch, - // the ErrorList is empty. - // - // ErrorList is a required field - ErrorList []*BatchItemError `type:"list" required:"true"` +// SetTags sets the Tags field's value. +func (s *CreateDocumentClassifierInput) SetTags(v []*Tag) *CreateDocumentClassifierInput { + s.Tags = v + return s +} - // A list of objects containing the results of the operation. The results are - // sorted in ascending order by the Index field and match the order of the documents - // in the input list. If all of the documents contain an error, the ResultList - // is empty. - // - // ResultList is a required field - ResultList []*BatchDetectDominantLanguageItemResult `type:"list" required:"true"` +// SetVersionName sets the VersionName field's value. +func (s *CreateDocumentClassifierInput) SetVersionName(v string) *CreateDocumentClassifierInput { + s.VersionName = &v + return s +} + +// SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value. +func (s *CreateDocumentClassifierInput) SetVolumeKmsKeyId(v string) *CreateDocumentClassifierInput { + s.VolumeKmsKeyId = &v + return s +} + +// SetVpcConfig sets the VpcConfig field's value. +func (s *CreateDocumentClassifierInput) SetVpcConfig(v *VpcConfig) *CreateDocumentClassifierInput { + s.VpcConfig = v + return s +} + +type CreateDocumentClassifierOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) that identifies the document classifier. + DocumentClassifierArn *string `type:"string"` } // String returns the string representation. @@ -7922,7 +11339,7 @@ type BatchDetectDominantLanguageOutput struct { // 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 BatchDetectDominantLanguageOutput) String() string { +func (s CreateDocumentClassifierOutput) String() string { return awsutil.Prettify(s) } @@ -7931,41 +11348,53 @@ func (s BatchDetectDominantLanguageOutput) String() string { // 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 BatchDetectDominantLanguageOutput) GoString() string { +func (s CreateDocumentClassifierOutput) GoString() string { return s.String() } -// SetErrorList sets the ErrorList field's value. -func (s *BatchDetectDominantLanguageOutput) SetErrorList(v []*BatchItemError) *BatchDetectDominantLanguageOutput { - s.ErrorList = v +// SetDocumentClassifierArn sets the DocumentClassifierArn field's value. +func (s *CreateDocumentClassifierOutput) SetDocumentClassifierArn(v string) *CreateDocumentClassifierOutput { + s.DocumentClassifierArn = &v return s } -// SetResultList sets the ResultList field's value. -func (s *BatchDetectDominantLanguageOutput) SetResultList(v []*BatchDetectDominantLanguageItemResult) *BatchDetectDominantLanguageOutput { - s.ResultList = v - return s -} +type CreateEndpointInput struct { + _ struct{} `type:"structure"` + + // An idempotency token provided by the customer. If this token matches a previous + // endpoint creation request, Amazon Comprehend will not return a ResourceInUseException. + 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 trained custom models + // encrypted with a customer managed key (ModelKmsKeyId). + DataAccessRoleArn *string `min:"20" type:"string"` + + // The desired number of inference units to be used by the model using this + // endpoint. Each inference unit represents of a throughput of 100 characters + // per second. + // + // DesiredInferenceUnits is a required field + DesiredInferenceUnits *int64 `min:"1" type:"integer" required:"true"` + + // This is the descriptive suffix that becomes part of the EndpointArn used + // for all subsequent requests to this resource. + // + // EndpointName is a required field + EndpointName *string `type:"string" required:"true"` -type BatchDetectEntitiesInput struct { - _ struct{} `type:"structure"` + // The Amazon Resource Number (ARN) of the flywheel to which the endpoint will + // be attached. + FlywheelArn *string `type:"string"` - // 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"` + // The Amazon Resource Number (ARN) of the model to which the endpoint will + // be attached. + ModelArn *string `type:"string"` - // A list containing the UTF-8 encoded text of the input documents. The list - // can contain a maximum of 25 documents. The maximum size of each document - // is 5 KB. - // - // TextList is a sensitive parameter and its value will be - // replaced with "sensitive" in string returned by BatchDetectEntitiesInput's - // String and GoString methods. - // - // TextList is a required field - TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"` + // Tags to associate with the endpoint. A tag is a key-value pair that adds + // metadata to the endpoint. For example, a tag with "Sales" as the key might + // be added to an endpoint to indicate its use by the sales department. + Tags []*Tag `type:"list"` } // String returns the string representation. @@ -7973,7 +11402,7 @@ type BatchDetectEntitiesInput struct { // 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 BatchDetectEntitiesInput) String() string { +func (s CreateEndpointInput) String() string { return awsutil.Prettify(s) } @@ -7982,21 +11411,37 @@ func (s BatchDetectEntitiesInput) String() string { // 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 BatchDetectEntitiesInput) GoString() string { +func (s CreateEndpointInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *BatchDetectEntitiesInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchDetectEntitiesInput"} - if s.LanguageCode == nil { - invalidParams.Add(request.NewErrParamRequired("LanguageCode")) +func (s *CreateEndpointInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateEndpointInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) } - if s.TextList == nil { - invalidParams.Add(request.NewErrParamRequired("TextList")) + if s.DataAccessRoleArn != nil && len(*s.DataAccessRoleArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("DataAccessRoleArn", 20)) } - if s.TextList != nil && len(s.TextList) < 1 { - invalidParams.Add(request.NewErrParamMinLen("TextList", 1)) + if s.DesiredInferenceUnits == nil { + invalidParams.Add(request.NewErrParamRequired("DesiredInferenceUnits")) + } + if s.DesiredInferenceUnits != nil && *s.DesiredInferenceUnits < 1 { + invalidParams.Add(request.NewErrParamMinValue("DesiredInferenceUnits", 1)) + } + if s.EndpointName == nil { + invalidParams.Add(request.NewErrParamRequired("EndpointName")) + } + 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 invalidParams.Len() > 0 { @@ -8005,78 +11450,56 @@ func (s *BatchDetectEntitiesInput) Validate() error { return nil } -// SetLanguageCode sets the LanguageCode field's value. -func (s *BatchDetectEntitiesInput) SetLanguageCode(v string) *BatchDetectEntitiesInput { - s.LanguageCode = &v +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *CreateEndpointInput) SetClientRequestToken(v string) *CreateEndpointInput { + s.ClientRequestToken = &v return s } -// SetTextList sets the TextList field's value. -func (s *BatchDetectEntitiesInput) SetTextList(v []*string) *BatchDetectEntitiesInput { - s.TextList = v +// SetDataAccessRoleArn sets the DataAccessRoleArn field's value. +func (s *CreateEndpointInput) SetDataAccessRoleArn(v string) *CreateEndpointInput { + s.DataAccessRoleArn = &v return s } -// The result of calling the operation. The operation returns one object for -// each document that is successfully processed by the operation. -type BatchDetectEntitiesItemResult struct { - _ struct{} `type:"structure"` - - // One or more Entity objects, one for each entity detected in the document. - Entities []*Entity `type:"list"` - - // The zero-based index of the document in the input list. - Index *int64 `type:"integer"` +// SetDesiredInferenceUnits sets the DesiredInferenceUnits field's value. +func (s *CreateEndpointInput) SetDesiredInferenceUnits(v int64) *CreateEndpointInput { + s.DesiredInferenceUnits = &v + return s } -// 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 BatchDetectEntitiesItemResult) String() string { - return awsutil.Prettify(s) +// SetEndpointName sets the EndpointName field's value. +func (s *CreateEndpointInput) SetEndpointName(v string) *CreateEndpointInput { + s.EndpointName = &v + return 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 BatchDetectEntitiesItemResult) GoString() string { - return s.String() +// SetFlywheelArn sets the FlywheelArn field's value. +func (s *CreateEndpointInput) SetFlywheelArn(v string) *CreateEndpointInput { + s.FlywheelArn = &v + return s } -// SetEntities sets the Entities field's value. -func (s *BatchDetectEntitiesItemResult) SetEntities(v []*Entity) *BatchDetectEntitiesItemResult { - s.Entities = v +// SetModelArn sets the ModelArn field's value. +func (s *CreateEndpointInput) SetModelArn(v string) *CreateEndpointInput { + s.ModelArn = &v return s } -// SetIndex sets the Index field's value. -func (s *BatchDetectEntitiesItemResult) SetIndex(v int64) *BatchDetectEntitiesItemResult { - s.Index = &v +// SetTags sets the Tags field's value. +func (s *CreateEndpointInput) SetTags(v []*Tag) *CreateEndpointInput { + s.Tags = v return s } -type BatchDetectEntitiesOutput struct { - _ struct{} `type:"structure" sensitive:"true"` +type CreateEndpointOutput struct { + _ struct{} `type:"structure"` - // A list containing one object for each document that contained an error. The - // results are sorted in ascending order by the Index field and match the order - // of the documents in the input list. If there are no errors in the batch, - // the ErrorList is empty. - // - // ErrorList is a required field - ErrorList []*BatchItemError `type:"list" required:"true"` + // The Amazon Resource Number (ARN) of the endpoint being created. + EndpointArn *string `type:"string"` - // A list of objects containing the results of the operation. The results are - // sorted in ascending order by the Index field and match the order of the documents - // in the input list. If all of the documents contain an error, the ResultList - // is empty. - // - // ResultList is a required field - ResultList []*BatchDetectEntitiesItemResult `type:"list" required:"true"` + // The Amazon Resource Number (ARN) of the model to which the endpoint is attached. + ModelArn *string `type:"string"` } // String returns the string representation. @@ -8084,7 +11507,7 @@ type BatchDetectEntitiesOutput struct { // 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 BatchDetectEntitiesOutput) String() string { +func (s CreateEndpointOutput) String() string { return awsutil.Prettify(s) } @@ -8093,41 +11516,110 @@ func (s BatchDetectEntitiesOutput) String() string { // 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 BatchDetectEntitiesOutput) GoString() string { +func (s CreateEndpointOutput) GoString() string { return s.String() } -// SetErrorList sets the ErrorList field's value. -func (s *BatchDetectEntitiesOutput) SetErrorList(v []*BatchItemError) *BatchDetectEntitiesOutput { - s.ErrorList = v +// SetEndpointArn sets the EndpointArn field's value. +func (s *CreateEndpointOutput) SetEndpointArn(v string) *CreateEndpointOutput { + s.EndpointArn = &v return s } -// SetResultList sets the ResultList field's value. -func (s *BatchDetectEntitiesOutput) SetResultList(v []*BatchDetectEntitiesItemResult) *BatchDetectEntitiesOutput { - s.ResultList = v +// SetModelArn sets the ModelArn field's value. +func (s *CreateEndpointOutput) SetModelArn(v string) *CreateEndpointOutput { + s.ModelArn = &v return s } -type BatchDetectKeyPhrasesInput struct { +type CreateEntityRecognizerInput struct { _ struct{} `type:"structure"` - // 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. + // 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. + // + // DataAccessRoleArn is a required field + DataAccessRoleArn *string `min:"20" type:"string" required:"true"` + + // Specifies the format and location of the input data. The S3 bucket containing + // the input data must be located in the same region as the entity recognizer + // being created. + // + // InputDataConfig is a required field + InputDataConfig *EntityRecognizerInputDataConfig `type:"structure" required:"true"` + + // You can specify any of the following languages: English ("en"), Spanish ("es"), + // French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you + // plan to use this entity recognizer with PDF, Word, or image input files, + // you must specify English as the language. All training documents must be + // in the same language. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - // A list containing the UTF-8 encoded text of the input documents. The list - // can contain a maximum of 25 documents. The maximum size of each document - // is 5 KB. + // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses + // to encrypt trained custom models. The ModelKmsKeyId can be either of the + // following formats: // - // TextList is a sensitive parameter and its value will be - // replaced with "sensitive" in string returned by BatchDetectKeyPhrasesInput's - // String and GoString methods. + // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" // - // TextList is a required field - TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"` + // * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + ModelKmsKeyId *string `type:"string"` + + // The JSON resource-based policy to attach to your custom entity recognizer + // model. You can use this policy to allow another AWS account to import your + // custom model. + // + // Provide your JSON as a UTF-8 encoded string without line breaks. To provide + // valid JSON for your policy, enclose the attribute names and values in double + // quotes. If the JSON body is also enclosed in double quotes, then you must + // escape the double quotes that are inside the policy: + // + // "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" + // + // To avoid escaping quotes, you can use single quotes to enclose the policy + // and double quotes to enclose the JSON names and values: + // + // '{"attribute": "value", "attribute": ["value"]}' + ModelPolicy *string `min:"1" type:"string"` + + // The name given to the newly created recognizer. Recognizer names can be a + // maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores + // (_) are allowed. The name must be unique in the account/region. + // + // RecognizerName is a required field + RecognizerName *string `type:"string" required:"true"` + + // Tags to associate with the entity recognizer. A tag is a key-value pair that + // adds as a metadata to a resource used by Amazon Comprehend. For example, + // a tag with "Sales" as the key might be added to a resource to indicate its + // use by the sales department. + Tags []*Tag `type:"list"` + + // The version name given to the newly created recognizer. Version names can + // be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and + // underscores (_) are allowed. The version name must be unique among all models + // with the same recognizer name in the account/ AWS Region. + VersionName *string `type:"string"` + + // 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" + VolumeKmsKeyId *string `type:"string"` + + // Configuration parameters for an optional private Virtual Private Cloud (VPC) + // containing the resources you are using for your custom entity recognizer. + // For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + VpcConfig *VpcConfig `type:"structure"` } // String returns the string representation. @@ -8135,7 +11627,7 @@ type BatchDetectKeyPhrasesInput struct { // 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 BatchDetectKeyPhrasesInput) String() string { +func (s CreateEntityRecognizerInput) String() string { return awsutil.Prettify(s) } @@ -8144,21 +11636,53 @@ func (s BatchDetectKeyPhrasesInput) String() string { // 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 BatchDetectKeyPhrasesInput) GoString() string { +func (s CreateEntityRecognizerInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *BatchDetectKeyPhrasesInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchDetectKeyPhrasesInput"} +func (s *CreateEntityRecognizerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateEntityRecognizerInput"} + 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.LanguageCode == nil { invalidParams.Add(request.NewErrParamRequired("LanguageCode")) } - if s.TextList == nil { - invalidParams.Add(request.NewErrParamRequired("TextList")) + if s.ModelPolicy != nil && len(*s.ModelPolicy) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ModelPolicy", 1)) } - if s.TextList != nil && len(s.TextList) < 1 { - invalidParams.Add(request.NewErrParamMinLen("TextList", 1)) + if s.RecognizerName == nil { + invalidParams.Add(request.NewErrParamRequired("RecognizerName")) + } + if s.InputDataConfig != nil { + if err := s.InputDataConfig.Validate(); err != nil { + invalidParams.AddNested("InputDataConfig", 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 { @@ -8167,78 +11691,77 @@ func (s *BatchDetectKeyPhrasesInput) Validate() error { return nil } -// SetLanguageCode sets the LanguageCode field's value. -func (s *BatchDetectKeyPhrasesInput) SetLanguageCode(v string) *BatchDetectKeyPhrasesInput { - s.LanguageCode = &v +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *CreateEntityRecognizerInput) SetClientRequestToken(v string) *CreateEntityRecognizerInput { + s.ClientRequestToken = &v return s } -// SetTextList sets the TextList field's value. -func (s *BatchDetectKeyPhrasesInput) SetTextList(v []*string) *BatchDetectKeyPhrasesInput { - s.TextList = v +// SetDataAccessRoleArn sets the DataAccessRoleArn field's value. +func (s *CreateEntityRecognizerInput) SetDataAccessRoleArn(v string) *CreateEntityRecognizerInput { + s.DataAccessRoleArn = &v return s } -// The result of calling the operation. The operation returns one object for -// each document that is successfully processed by the operation. -type BatchDetectKeyPhrasesItemResult struct { - _ struct{} `type:"structure"` +// SetInputDataConfig sets the InputDataConfig field's value. +func (s *CreateEntityRecognizerInput) SetInputDataConfig(v *EntityRecognizerInputDataConfig) *CreateEntityRecognizerInput { + s.InputDataConfig = v + return s +} - // The zero-based index of the document in the input list. - Index *int64 `type:"integer"` +// SetLanguageCode sets the LanguageCode field's value. +func (s *CreateEntityRecognizerInput) SetLanguageCode(v string) *CreateEntityRecognizerInput { + s.LanguageCode = &v + return s +} - // One or more KeyPhrase objects, one for each key phrase detected in the document. - KeyPhrases []*KeyPhrase `type:"list"` +// SetModelKmsKeyId sets the ModelKmsKeyId field's value. +func (s *CreateEntityRecognizerInput) SetModelKmsKeyId(v string) *CreateEntityRecognizerInput { + s.ModelKmsKeyId = &v + return s } -// 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 BatchDetectKeyPhrasesItemResult) String() string { - return awsutil.Prettify(s) +// SetModelPolicy sets the ModelPolicy field's value. +func (s *CreateEntityRecognizerInput) SetModelPolicy(v string) *CreateEntityRecognizerInput { + s.ModelPolicy = &v + return 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 BatchDetectKeyPhrasesItemResult) GoString() string { - return s.String() +// SetRecognizerName sets the RecognizerName field's value. +func (s *CreateEntityRecognizerInput) SetRecognizerName(v string) *CreateEntityRecognizerInput { + s.RecognizerName = &v + return s } -// SetIndex sets the Index field's value. -func (s *BatchDetectKeyPhrasesItemResult) SetIndex(v int64) *BatchDetectKeyPhrasesItemResult { - s.Index = &v +// SetTags sets the Tags field's value. +func (s *CreateEntityRecognizerInput) SetTags(v []*Tag) *CreateEntityRecognizerInput { + s.Tags = v return s } -// SetKeyPhrases sets the KeyPhrases field's value. -func (s *BatchDetectKeyPhrasesItemResult) SetKeyPhrases(v []*KeyPhrase) *BatchDetectKeyPhrasesItemResult { - s.KeyPhrases = v +// SetVersionName sets the VersionName field's value. +func (s *CreateEntityRecognizerInput) SetVersionName(v string) *CreateEntityRecognizerInput { + s.VersionName = &v return s } -type BatchDetectKeyPhrasesOutput struct { - _ struct{} `type:"structure" sensitive:"true"` +// SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value. +func (s *CreateEntityRecognizerInput) SetVolumeKmsKeyId(v string) *CreateEntityRecognizerInput { + s.VolumeKmsKeyId = &v + return s +} - // A list containing one object for each document that contained an error. The - // results are sorted in ascending order by the Index field and match the order - // of the documents in the input list. If there are no errors in the batch, - // the ErrorList is empty. - // - // ErrorList is a required field - ErrorList []*BatchItemError `type:"list" required:"true"` +// SetVpcConfig sets the VpcConfig field's value. +func (s *CreateEntityRecognizerInput) SetVpcConfig(v *VpcConfig) *CreateEntityRecognizerInput { + s.VpcConfig = v + return s +} - // A list of objects containing the results of the operation. The results are - // sorted in ascending order by the Index field and match the order of the documents - // in the input list. If all of the documents contain an error, the ResultList - // is empty. - // - // ResultList is a required field - ResultList []*BatchDetectKeyPhrasesItemResult `type:"list" required:"true"` +type CreateEntityRecognizerOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) that identifies the entity recognizer. + EntityRecognizerArn *string `type:"string"` } // String returns the string representation. @@ -8246,7 +11769,7 @@ type BatchDetectKeyPhrasesOutput struct { // 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 BatchDetectKeyPhrasesOutput) String() string { +func (s CreateEntityRecognizerOutput) String() string { return awsutil.Prettify(s) } @@ -8255,44 +11778,57 @@ func (s BatchDetectKeyPhrasesOutput) String() string { // 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 BatchDetectKeyPhrasesOutput) GoString() string { +func (s CreateEntityRecognizerOutput) GoString() string { return s.String() } -// SetErrorList sets the ErrorList field's value. -func (s *BatchDetectKeyPhrasesOutput) SetErrorList(v []*BatchItemError) *BatchDetectKeyPhrasesOutput { - s.ErrorList = v - return s -} - -// SetResultList sets the ResultList field's value. -func (s *BatchDetectKeyPhrasesOutput) SetResultList(v []*BatchDetectKeyPhrasesItemResult) *BatchDetectKeyPhrasesOutput { - s.ResultList = v +// SetEntityRecognizerArn sets the EntityRecognizerArn field's value. +func (s *CreateEntityRecognizerOutput) SetEntityRecognizerArn(v string) *CreateEntityRecognizerOutput { + s.EntityRecognizerArn = &v return s } -type BatchDetectSentimentInput struct { +type CreateFlywheelInput struct { _ struct{} `type:"structure"` - // 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"` + // To associate an existing model with the flywheel, specify the Amazon Resource + // Number (ARN) of the model version. + ActiveModelArn *string `type:"string"` - // A list containing the UTF-8 encoded text of the input documents. The list - // can contain a maximum of 25 documents. The maximum size of each document - // is 5 KB. + // 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 the permissions required to access + // the flywheel data in the data lake. // - // Amazon Comprehend performs real-time sentiment analysis on the first 500 - // characters of the input text and ignores any additional text in the input. + // DataAccessRoleArn is a required field + DataAccessRoleArn *string `min:"20" type:"string" required:"true"` + + // Enter the S3 location for the data lake. You can specify a new S3 bucket + // or a new folder of an existing S3 bucket. The flywheel creates the data lake + // at this location. // - // TextList is a sensitive parameter and its value will be - // replaced with "sensitive" in string returned by BatchDetectSentimentInput's - // String and GoString methods. + // DataLakeS3Uri is a required field + DataLakeS3Uri *string `type:"string" required:"true"` + + // Data security configurations. + DataSecurityConfig *DataSecurityConfig `type:"structure"` + + // Name for the flywheel. // - // TextList is a required field - TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"` + // FlywheelName is a required field + FlywheelName *string `type:"string" required:"true"` + + // The model type. + ModelType *string `type:"string" enum:"ModelType"` + + // The tags to associate with this flywheel. + Tags []*Tag `type:"list"` + + // Configuration about the custom classifier associated with the flywheel. + TaskConfig *TaskConfig `type:"structure"` } // String returns the string representation. @@ -8300,7 +11836,7 @@ type BatchDetectSentimentInput struct { // 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 BatchDetectSentimentInput) String() string { +func (s CreateFlywheelInput) String() string { return awsutil.Prettify(s) } @@ -8309,21 +11845,47 @@ func (s BatchDetectSentimentInput) String() string { // 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 BatchDetectSentimentInput) GoString() string { +func (s CreateFlywheelInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *BatchDetectSentimentInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchDetectSentimentInput"} - if s.LanguageCode == nil { - invalidParams.Add(request.NewErrParamRequired("LanguageCode")) +func (s *CreateFlywheelInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateFlywheelInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) } - if s.TextList == nil { - invalidParams.Add(request.NewErrParamRequired("TextList")) + if s.DataAccessRoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("DataAccessRoleArn")) } - if s.TextList != nil && len(s.TextList) < 1 { - invalidParams.Add(request.NewErrParamMinLen("TextList", 1)) + if s.DataAccessRoleArn != nil && len(*s.DataAccessRoleArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("DataAccessRoleArn", 20)) + } + if s.DataLakeS3Uri == nil { + invalidParams.Add(request.NewErrParamRequired("DataLakeS3Uri")) + } + if s.FlywheelName == nil { + invalidParams.Add(request.NewErrParamRequired("FlywheelName")) + } + if s.DataSecurityConfig != nil { + if err := s.DataSecurityConfig.Validate(); err != nil { + invalidParams.AddNested("DataSecurityConfig", 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.TaskConfig != nil { + if err := s.TaskConfig.Validate(); err != nil { + invalidParams.AddNested("TaskConfig", err.(request.ErrInvalidParams)) + } } if invalidParams.Len() > 0 { @@ -8332,32 +11894,68 @@ func (s *BatchDetectSentimentInput) Validate() error { return nil } -// SetLanguageCode sets the LanguageCode field's value. -func (s *BatchDetectSentimentInput) SetLanguageCode(v string) *BatchDetectSentimentInput { - s.LanguageCode = &v +// SetActiveModelArn sets the ActiveModelArn field's value. +func (s *CreateFlywheelInput) SetActiveModelArn(v string) *CreateFlywheelInput { + s.ActiveModelArn = &v return s } -// SetTextList sets the TextList field's value. -func (s *BatchDetectSentimentInput) SetTextList(v []*string) *BatchDetectSentimentInput { - s.TextList = v +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *CreateFlywheelInput) SetClientRequestToken(v string) *CreateFlywheelInput { + s.ClientRequestToken = &v return s } -// The result of calling the operation. The operation returns one object for -// each document that is successfully processed by the operation. -type BatchDetectSentimentItemResult struct { - _ struct{} `type:"structure"` +// SetDataAccessRoleArn sets the DataAccessRoleArn field's value. +func (s *CreateFlywheelInput) SetDataAccessRoleArn(v string) *CreateFlywheelInput { + s.DataAccessRoleArn = &v + return s +} - // The zero-based index of the document in the input list. - Index *int64 `type:"integer"` +// SetDataLakeS3Uri sets the DataLakeS3Uri field's value. +func (s *CreateFlywheelInput) SetDataLakeS3Uri(v string) *CreateFlywheelInput { + s.DataLakeS3Uri = &v + return s +} - // The sentiment detected in the document. - Sentiment *string `type:"string" enum:"SentimentType"` +// SetDataSecurityConfig sets the DataSecurityConfig field's value. +func (s *CreateFlywheelInput) SetDataSecurityConfig(v *DataSecurityConfig) *CreateFlywheelInput { + s.DataSecurityConfig = v + return s +} - // The level of confidence that Amazon Comprehend has in the accuracy of its - // sentiment detection. - SentimentScore *SentimentScore `type:"structure"` +// SetFlywheelName sets the FlywheelName field's value. +func (s *CreateFlywheelInput) SetFlywheelName(v string) *CreateFlywheelInput { + s.FlywheelName = &v + return s +} + +// SetModelType sets the ModelType field's value. +func (s *CreateFlywheelInput) SetModelType(v string) *CreateFlywheelInput { + s.ModelType = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateFlywheelInput) SetTags(v []*Tag) *CreateFlywheelInput { + s.Tags = v + return s +} + +// SetTaskConfig sets the TaskConfig field's value. +func (s *CreateFlywheelInput) SetTaskConfig(v *TaskConfig) *CreateFlywheelInput { + s.TaskConfig = v + return s +} + +type CreateFlywheelOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Number (ARN) of the active model version. + ActiveModelArn *string `type:"string"` + + // The Amazon Resource Number (ARN) of the flywheel. + FlywheelArn *string `type:"string"` } // String returns the string representation. @@ -8365,7 +11963,7 @@ type BatchDetectSentimentItemResult struct { // 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 BatchDetectSentimentItemResult) String() string { +func (s CreateFlywheelOutput) String() string { return awsutil.Prettify(s) } @@ -8374,46 +11972,46 @@ func (s BatchDetectSentimentItemResult) String() string { // 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 BatchDetectSentimentItemResult) GoString() string { +func (s CreateFlywheelOutput) GoString() string { return s.String() } -// SetIndex sets the Index field's value. -func (s *BatchDetectSentimentItemResult) SetIndex(v int64) *BatchDetectSentimentItemResult { - s.Index = &v +// SetActiveModelArn sets the ActiveModelArn field's value. +func (s *CreateFlywheelOutput) SetActiveModelArn(v string) *CreateFlywheelOutput { + s.ActiveModelArn = &v return s } -// SetSentiment sets the Sentiment field's value. -func (s *BatchDetectSentimentItemResult) SetSentiment(v string) *BatchDetectSentimentItemResult { - s.Sentiment = &v +// SetFlywheelArn sets the FlywheelArn field's value. +func (s *CreateFlywheelOutput) SetFlywheelArn(v string) *CreateFlywheelOutput { + s.FlywheelArn = &v return s } -// SetSentimentScore sets the SentimentScore field's value. -func (s *BatchDetectSentimentItemResult) SetSentimentScore(v *SentimentScore) *BatchDetectSentimentItemResult { - s.SentimentScore = v - return s -} +// Data security configuration. +type DataSecurityConfig struct { + _ struct{} `type:"structure"` -type BatchDetectSentimentOutput struct { - _ struct{} `type:"structure" sensitive:"true"` + // ID for the KMS key that Amazon Comprehend uses to encrypt the data in the + // data lake. + DataLakeKmsKeyId *string `type:"string"` - // A list containing one object for each document that contained an error. The - // results are sorted in ascending order by the Index field and match the order - // of the documents in the input list. If there are no errors in the batch, - // the ErrorList is empty. + // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses + // to encrypt trained custom models. The ModelKmsKeyId can be either of the + // following formats: // - // ErrorList is a required field - ErrorList []*BatchItemError `type:"list" required:"true"` - - // A list of objects containing the results of the operation. The results are - // sorted in ascending order by the Index field and match the order of the documents - // in the input list. If all of the documents contain an error, the ResultList - // is empty. + // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" // - // ResultList is a required field - ResultList []*BatchDetectSentimentItemResult `type:"list" required:"true"` + // * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + ModelKmsKeyId *string `type:"string"` + + // ID for the KMS key that Amazon Comprehend uses to encrypt the volume. + 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. @@ -8421,7 +12019,7 @@ type BatchDetectSentimentOutput struct { // 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 BatchDetectSentimentOutput) String() string { +func (s DataSecurityConfig) String() string { return awsutil.Prettify(s) } @@ -8430,43 +12028,88 @@ func (s BatchDetectSentimentOutput) String() string { // 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 BatchDetectSentimentOutput) GoString() string { +func (s DataSecurityConfig) GoString() string { return s.String() } -// SetErrorList sets the ErrorList field's value. -func (s *BatchDetectSentimentOutput) SetErrorList(v []*BatchItemError) *BatchDetectSentimentOutput { - s.ErrorList = v +// Validate inspects the fields of the type to determine if they are valid. +func (s *DataSecurityConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DataSecurityConfig"} + 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 +} + +// SetDataLakeKmsKeyId sets the DataLakeKmsKeyId field's value. +func (s *DataSecurityConfig) SetDataLakeKmsKeyId(v string) *DataSecurityConfig { + s.DataLakeKmsKeyId = &v return s } -// SetResultList sets the ResultList field's value. -func (s *BatchDetectSentimentOutput) SetResultList(v []*BatchDetectSentimentItemResult) *BatchDetectSentimentOutput { - s.ResultList = v +// SetModelKmsKeyId sets the ModelKmsKeyId field's value. +func (s *DataSecurityConfig) SetModelKmsKeyId(v string) *DataSecurityConfig { + s.ModelKmsKeyId = &v return s } -type BatchDetectSyntaxInput struct { +// SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value. +func (s *DataSecurityConfig) SetVolumeKmsKeyId(v string) *DataSecurityConfig { + s.VolumeKmsKeyId = &v + return s +} + +// SetVpcConfig sets the VpcConfig field's value. +func (s *DataSecurityConfig) SetVpcConfig(v *VpcConfig) *DataSecurityConfig { + s.VpcConfig = v + return s +} + +// An augmented manifest file that provides training data for your custom model. +// An augmented manifest file is a labeled dataset that is produced by Amazon +// SageMaker Ground Truth. +type DatasetAugmentedManifestsListItem struct { _ struct{} `type:"structure"` - // The language of the input documents. You can specify any of the following - // languages supported by Amazon Comprehend: German ("de"), English ("en"), - // Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All - // documents must be in the same language. + // The S3 prefix to the annotation files that are referred in the augmented + // manifest file. + AnnotationDataS3Uri *string `type:"string"` + + // The JSON attribute that contains the annotations for your training documents. + // The number of attribute names that you specify depends on whether your augmented + // manifest file is the output of a single labeling job or a chained labeling + // job. // - // LanguageCode is a required field - LanguageCode *string `type:"string" required:"true" enum:"SyntaxLanguageCode"` + // If your file is the output of a single labeling job, specify the LabelAttributeName + // key that was used when the job was created in Ground Truth. + // + // If your file is the output of a chained labeling job, specify the LabelAttributeName + // key for one or more jobs in the chain. Each LabelAttributeName key provides + // the annotations from an individual job. + // + // AttributeNames is a required field + AttributeNames []*string `type:"list" required:"true"` - // A list containing the UTF-8 encoded text of the input documents. The list - // can contain a maximum of 25 documents. The maximum size for each document - // is 5 KB. + // The type of augmented manifest. If you don't specify, the default is PlainTextDocument. // - // TextList is a sensitive parameter and its value will be - // replaced with "sensitive" in string returned by BatchDetectSyntaxInput's - // String and GoString methods. + // PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that + // is encoded in UTF-8. + DocumentType *string `type:"string" enum:"AugmentedManifestsDocumentTypeFormat"` + + // The Amazon S3 location of the augmented manifest file. // - // TextList is a required field - TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"` + // S3Uri is a required field + S3Uri *string `type:"string" required:"true"` + + // The S3 prefix to the source files (PDFs) that are referred to in the augmented + // manifest file. + SourceDocumentsS3Uri *string `type:"string"` } // String returns the string representation. @@ -8474,7 +12117,7 @@ type BatchDetectSyntaxInput struct { // 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 BatchDetectSyntaxInput) String() string { +func (s DatasetAugmentedManifestsListItem) String() string { return awsutil.Prettify(s) } @@ -8483,21 +12126,18 @@ func (s BatchDetectSyntaxInput) String() string { // 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 BatchDetectSyntaxInput) GoString() string { +func (s DatasetAugmentedManifestsListItem) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *BatchDetectSyntaxInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchDetectSyntaxInput"} - if s.LanguageCode == nil { - invalidParams.Add(request.NewErrParamRequired("LanguageCode")) - } - if s.TextList == nil { - invalidParams.Add(request.NewErrParamRequired("TextList")) +func (s *DatasetAugmentedManifestsListItem) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DatasetAugmentedManifestsListItem"} + if s.AttributeNames == nil { + invalidParams.Add(request.NewErrParamRequired("AttributeNames")) } - if s.TextList != nil && len(s.TextList) < 1 { - invalidParams.Add(request.NewErrParamMinLen("TextList", 1)) + if s.S3Uri == nil { + invalidParams.Add(request.NewErrParamRequired("S3Uri")) } if invalidParams.Len() > 0 { @@ -8506,28 +12146,65 @@ func (s *BatchDetectSyntaxInput) Validate() error { return nil } -// SetLanguageCode sets the LanguageCode field's value. -func (s *BatchDetectSyntaxInput) SetLanguageCode(v string) *BatchDetectSyntaxInput { - s.LanguageCode = &v +// SetAnnotationDataS3Uri sets the AnnotationDataS3Uri field's value. +func (s *DatasetAugmentedManifestsListItem) SetAnnotationDataS3Uri(v string) *DatasetAugmentedManifestsListItem { + s.AnnotationDataS3Uri = &v return s } -// SetTextList sets the TextList field's value. -func (s *BatchDetectSyntaxInput) SetTextList(v []*string) *BatchDetectSyntaxInput { - s.TextList = v +// SetAttributeNames sets the AttributeNames field's value. +func (s *DatasetAugmentedManifestsListItem) SetAttributeNames(v []*string) *DatasetAugmentedManifestsListItem { + s.AttributeNames = v return s } -// The result of calling the operation. The operation returns one object that -// is successfully processed by the operation. -type BatchDetectSyntaxItemResult struct { +// SetDocumentType sets the DocumentType field's value. +func (s *DatasetAugmentedManifestsListItem) SetDocumentType(v string) *DatasetAugmentedManifestsListItem { + s.DocumentType = &v + return s +} + +// SetS3Uri sets the S3Uri field's value. +func (s *DatasetAugmentedManifestsListItem) SetS3Uri(v string) *DatasetAugmentedManifestsListItem { + s.S3Uri = &v + return s +} + +// SetSourceDocumentsS3Uri sets the SourceDocumentsS3Uri field's value. +func (s *DatasetAugmentedManifestsListItem) SetSourceDocumentsS3Uri(v string) *DatasetAugmentedManifestsListItem { + s.SourceDocumentsS3Uri = &v + return s +} + +// Describes the dataset input data configuration for a document classifier +// model. +// +// For more information on how the input file is formatted, see Preparing training +// data (https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html) +// in the Comprehend Developer Guide. +type DatasetDocumentClassifierInputDataConfig struct { _ struct{} `type:"structure"` - // The zero-based index of the document in the input list. - Index *int64 `type:"integer"` + // Indicates the delimiter used to separate each label for training a multi-label + // classifier. The default delimiter between labels is a pipe (|). You can use + // a different character as a delimiter (if it's an allowed character) by specifying + // it under Delimiter for labels. If the training documents use a delimiter + // other than the default or the delimiter you specify, the labels on that line + // will be combined to make a single unique label, such as LABELLABELLABEL. + LabelDelimiter *string `min:"1" type:"string"` - // The syntax tokens for the words in the document, one token for each word. - SyntaxTokens []*SyntaxToken `type:"list"` + // The Amazon S3 URI for the input data. The S3 bucket must be in the 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 input 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. + // + // This parameter is required if you set DataFormat to COMPREHEND_CSV. + // + // S3Uri is a required field + S3Uri *string `type:"string" required:"true"` } // String returns the string representation. @@ -8535,7 +12212,7 @@ type BatchDetectSyntaxItemResult struct { // 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 BatchDetectSyntaxItemResult) String() string { +func (s DatasetDocumentClassifierInputDataConfig) String() string { return awsutil.Prettify(s) } @@ -8544,40 +12221,48 @@ func (s BatchDetectSyntaxItemResult) String() string { // 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 BatchDetectSyntaxItemResult) GoString() string { +func (s DatasetDocumentClassifierInputDataConfig) GoString() string { return s.String() } -// SetIndex sets the Index field's value. -func (s *BatchDetectSyntaxItemResult) SetIndex(v int64) *BatchDetectSyntaxItemResult { - s.Index = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *DatasetDocumentClassifierInputDataConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DatasetDocumentClassifierInputDataConfig"} + if s.LabelDelimiter != nil && len(*s.LabelDelimiter) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LabelDelimiter", 1)) + } + if s.S3Uri == nil { + invalidParams.Add(request.NewErrParamRequired("S3Uri")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetSyntaxTokens sets the SyntaxTokens field's value. -func (s *BatchDetectSyntaxItemResult) SetSyntaxTokens(v []*SyntaxToken) *BatchDetectSyntaxItemResult { - s.SyntaxTokens = v +// SetLabelDelimiter sets the LabelDelimiter field's value. +func (s *DatasetDocumentClassifierInputDataConfig) SetLabelDelimiter(v string) *DatasetDocumentClassifierInputDataConfig { + s.LabelDelimiter = &v return s } -type BatchDetectSyntaxOutput struct { - _ struct{} `type:"structure" sensitive:"true"` +// SetS3Uri sets the S3Uri field's value. +func (s *DatasetDocumentClassifierInputDataConfig) SetS3Uri(v string) *DatasetDocumentClassifierInputDataConfig { + s.S3Uri = &v + return s +} - // A list containing one object for each document that contained an error. The - // results are sorted in ascending order by the Index field and match the order - // of the documents in the input list. If there are no errors in the batch, - // the ErrorList is empty. - // - // ErrorList is a required field - ErrorList []*BatchItemError `type:"list" required:"true"` +// Describes the annotations associated with a entity recognizer. +type DatasetEntityRecognizerAnnotations struct { + _ struct{} `type:"structure"` - // A list of objects containing the results of the operation. The results are - // sorted in ascending order by the Index field and match the order of the documents - // in the input list. If all of the documents contain an error, the ResultList - // is empty. + // Specifies the Amazon S3 location where the training documents for an entity + // recognizer are located. The URI must be in the same region as the API endpoint + // that you are calling. // - // ResultList is a required field - ResultList []*BatchDetectSyntaxItemResult `type:"list" required:"true"` + // S3Uri is a required field + S3Uri *string `type:"string" required:"true"` } // String returns the string representation. @@ -8585,7 +12270,7 @@ type BatchDetectSyntaxOutput struct { // 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 BatchDetectSyntaxOutput) String() string { +func (s DatasetEntityRecognizerAnnotations) String() string { return awsutil.Prettify(s) } @@ -8594,41 +12279,47 @@ func (s BatchDetectSyntaxOutput) String() string { // 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 BatchDetectSyntaxOutput) GoString() string { +func (s DatasetEntityRecognizerAnnotations) GoString() string { return s.String() } -// SetErrorList sets the ErrorList field's value. -func (s *BatchDetectSyntaxOutput) SetErrorList(v []*BatchItemError) *BatchDetectSyntaxOutput { - s.ErrorList = v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DatasetEntityRecognizerAnnotations) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DatasetEntityRecognizerAnnotations"} + if s.S3Uri == nil { + invalidParams.Add(request.NewErrParamRequired("S3Uri")) + } -// SetResultList sets the ResultList field's value. -func (s *BatchDetectSyntaxOutput) SetResultList(v []*BatchDetectSyntaxItemResult) *BatchDetectSyntaxOutput { - s.ResultList = v + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetS3Uri sets the S3Uri field's value. +func (s *DatasetEntityRecognizerAnnotations) SetS3Uri(v string) *DatasetEntityRecognizerAnnotations { + s.S3Uri = &v return s } -type BatchDetectTargetedSentimentInput struct { +// Describes the documents submitted with a dataset for an entity recognizer +// model. +type DatasetEntityRecognizerDocuments struct { _ struct{} `type:"structure"` - // The language of the input documents. Currently, English is the only supported - // language. - // - // LanguageCode is a required field - LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` + // Specifies how the text in an input file should be processed. This is optional, + // and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered + // a separate document. Use this option when you are processing large documents, + // such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each + // line in a file is considered a separate document. Use this option when you + // are processing many short documents, such as text messages. + InputFormat *string `type:"string" enum:"InputFormat"` - // A list containing the UTF-8 encoded text of the input documents. The list - // can contain a maximum of 25 documents. The maximum size of each document - // is 5 KB. - // - // TextList is a sensitive parameter and its value will be - // replaced with "sensitive" in string returned by BatchDetectTargetedSentimentInput's - // String and GoString methods. + // Specifies the Amazon S3 location where the documents for the dataset are + // located. // - // TextList is a required field - TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"` + // S3Uri is a required field + S3Uri *string `type:"string" required:"true"` } // String returns the string representation. @@ -8636,7 +12327,7 @@ type BatchDetectTargetedSentimentInput struct { // 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 BatchDetectTargetedSentimentInput) String() string { +func (s DatasetEntityRecognizerDocuments) String() string { return awsutil.Prettify(s) } @@ -8645,21 +12336,15 @@ func (s BatchDetectTargetedSentimentInput) String() string { // 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 BatchDetectTargetedSentimentInput) GoString() string { +func (s DatasetEntityRecognizerDocuments) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *BatchDetectTargetedSentimentInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchDetectTargetedSentimentInput"} - if s.LanguageCode == nil { - invalidParams.Add(request.NewErrParamRequired("LanguageCode")) - } - if s.TextList == nil { - invalidParams.Add(request.NewErrParamRequired("TextList")) - } - if s.TextList != nil && len(s.TextList) < 1 { - invalidParams.Add(request.NewErrParamMinLen("TextList", 1)) +func (s *DatasetEntityRecognizerDocuments) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DatasetEntityRecognizerDocuments"} + if s.S3Uri == nil { + invalidParams.Add(request.NewErrParamRequired("S3Uri")) } if invalidParams.Len() > 0 { @@ -8668,27 +12353,30 @@ func (s *BatchDetectTargetedSentimentInput) Validate() error { return nil } -// SetLanguageCode sets the LanguageCode field's value. -func (s *BatchDetectTargetedSentimentInput) SetLanguageCode(v string) *BatchDetectTargetedSentimentInput { - s.LanguageCode = &v +// SetInputFormat sets the InputFormat field's value. +func (s *DatasetEntityRecognizerDocuments) SetInputFormat(v string) *DatasetEntityRecognizerDocuments { + s.InputFormat = &v return s } -// SetTextList sets the TextList field's value. -func (s *BatchDetectTargetedSentimentInput) SetTextList(v []*string) *BatchDetectTargetedSentimentInput { - s.TextList = v +// SetS3Uri sets the S3Uri field's value. +func (s *DatasetEntityRecognizerDocuments) SetS3Uri(v string) *DatasetEntityRecognizerDocuments { + s.S3Uri = &v return s } -// Analysis results for one of the documents in the batch. -type BatchDetectTargetedSentimentItemResult struct { +// Describes the dataset entity list for an entity recognizer model. +// +// For more information on how the input file is formatted, see Preparing training +// data (https://docs.aws.amazon.com/comprehend/latest/dg/prep-training-data-cer.html) +// in the Comprehend Developer Guide. +type DatasetEntityRecognizerEntityList struct { _ struct{} `type:"structure"` - // An array of targeted sentiment entities. - Entities []*TargetedSentimentEntity `type:"list"` - - // The zero-based index of this result in the input list. - Index *int64 `type:"integer"` + // Specifies the Amazon S3 location where the entity list is located. + // + // S3Uri is a required field + S3Uri *string `type:"string" required:"true"` } // String returns the string representation. @@ -8696,7 +12384,7 @@ type BatchDetectTargetedSentimentItemResult struct { // 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 BatchDetectTargetedSentimentItemResult) String() string { +func (s DatasetEntityRecognizerEntityList) String() string { return awsutil.Prettify(s) } @@ -8705,37 +12393,45 @@ func (s BatchDetectTargetedSentimentItemResult) String() string { // 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 BatchDetectTargetedSentimentItemResult) GoString() string { +func (s DatasetEntityRecognizerEntityList) GoString() string { return s.String() } -// SetEntities sets the Entities field's value. -func (s *BatchDetectTargetedSentimentItemResult) SetEntities(v []*TargetedSentimentEntity) *BatchDetectTargetedSentimentItemResult { - s.Entities = v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *DatasetEntityRecognizerEntityList) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DatasetEntityRecognizerEntityList"} + if s.S3Uri == nil { + invalidParams.Add(request.NewErrParamRequired("S3Uri")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetIndex sets the Index field's value. -func (s *BatchDetectTargetedSentimentItemResult) SetIndex(v int64) *BatchDetectTargetedSentimentItemResult { - s.Index = &v +// SetS3Uri sets the S3Uri field's value. +func (s *DatasetEntityRecognizerEntityList) SetS3Uri(v string) *DatasetEntityRecognizerEntityList { + s.S3Uri = &v return s } -type BatchDetectTargetedSentimentOutput struct { - _ struct{} `type:"structure" sensitive:"true"` +// Specifies the format and location of the input data. You must provide either +// the Annotations parameter or the EntityList parameter. +type DatasetEntityRecognizerInputDataConfig struct { + _ struct{} `type:"structure"` - // List of errors that the operation can return. - // - // ErrorList is a required field - ErrorList []*BatchItemError `type:"list" required:"true"` + // The S3 location of the annotation documents for your custom entity recognizer. + Annotations *DatasetEntityRecognizerAnnotations `type:"structure"` - // A list of objects containing the results of the operation. The results are - // sorted in ascending order by the Index field and match the order of the documents - // in the input list. If all of the documents contain an error, the ResultList - // is empty. + // The format and location of the training documents for your custom entity + // recognizer. // - // ResultList is a required field - ResultList []*BatchDetectTargetedSentimentItemResult `type:"list" required:"true"` + // Documents is a required field + Documents *DatasetEntityRecognizerDocuments `type:"structure" required:"true"` + + // The S3 location of the entity list for your custom entity recognizer. + EntityList *DatasetEntityRecognizerEntityList `type:"structure"` } // String returns the string representation. @@ -8743,7 +12439,7 @@ type BatchDetectTargetedSentimentOutput struct { // 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 BatchDetectTargetedSentimentOutput) String() string { +func (s DatasetEntityRecognizerInputDataConfig) String() string { return awsutil.Prettify(s) } @@ -8752,36 +12448,71 @@ func (s BatchDetectTargetedSentimentOutput) String() string { // 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 BatchDetectTargetedSentimentOutput) GoString() string { +func (s DatasetEntityRecognizerInputDataConfig) GoString() string { return s.String() } -// SetErrorList sets the ErrorList field's value. -func (s *BatchDetectTargetedSentimentOutput) SetErrorList(v []*BatchItemError) *BatchDetectTargetedSentimentOutput { - s.ErrorList = v +// Validate inspects the fields of the type to determine if they are valid. +func (s *DatasetEntityRecognizerInputDataConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DatasetEntityRecognizerInputDataConfig"} + if s.Documents == nil { + invalidParams.Add(request.NewErrParamRequired("Documents")) + } + if s.Annotations != nil { + if err := s.Annotations.Validate(); err != nil { + invalidParams.AddNested("Annotations", err.(request.ErrInvalidParams)) + } + } + if s.Documents != nil { + if err := s.Documents.Validate(); err != nil { + invalidParams.AddNested("Documents", err.(request.ErrInvalidParams)) + } + } + if s.EntityList != nil { + if err := s.EntityList.Validate(); err != nil { + invalidParams.AddNested("EntityList", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAnnotations sets the Annotations field's value. +func (s *DatasetEntityRecognizerInputDataConfig) SetAnnotations(v *DatasetEntityRecognizerAnnotations) *DatasetEntityRecognizerInputDataConfig { + s.Annotations = v return s } -// SetResultList sets the ResultList field's value. -func (s *BatchDetectTargetedSentimentOutput) SetResultList(v []*BatchDetectTargetedSentimentItemResult) *BatchDetectTargetedSentimentOutput { - s.ResultList = v +// SetDocuments sets the Documents field's value. +func (s *DatasetEntityRecognizerInputDataConfig) SetDocuments(v *DatasetEntityRecognizerDocuments) *DatasetEntityRecognizerInputDataConfig { + s.Documents = v return s } -// Describes an error that occurred while processing a document in a batch. -// The operation returns on BatchItemError object for each document that contained -// an error. -type BatchItemError struct { +// SetEntityList sets the EntityList field's value. +func (s *DatasetEntityRecognizerInputDataConfig) SetEntityList(v *DatasetEntityRecognizerEntityList) *DatasetEntityRecognizerInputDataConfig { + s.EntityList = v + return s +} + +// Filter the datasets based on creation time or dataset status. +type DatasetFilter struct { _ struct{} `type:"structure"` - // The numeric error code of the error. - ErrorCode *string `min:"1" type:"string"` + // Filter the datasets to include datasets created after the specified time. + CreationTimeAfter *time.Time `type:"timestamp"` - // A text description of the error. - ErrorMessage *string `min:"1" type:"string"` + // Filter the datasets to include datasets created before the specified time. + CreationTimeBefore *time.Time `type:"timestamp"` - // The zero-based index of the document in the input list. - Index *int64 `type:"integer"` + // Filter the datasets based on the dataset type. + DatasetType *string `type:"string" enum:"DatasetType"` + + // Filter the datasets based on the dataset status. + Status *string `type:"string" enum:"DatasetStatus"` } // String returns the string representation. @@ -8789,7 +12520,7 @@ type BatchItemError struct { // 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 BatchItemError) String() string { +func (s DatasetFilter) String() string { return awsutil.Prettify(s) } @@ -8798,35 +12529,58 @@ func (s BatchItemError) String() string { // 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 BatchItemError) GoString() string { +func (s DatasetFilter) GoString() string { return s.String() } -// SetErrorCode sets the ErrorCode field's value. -func (s *BatchItemError) SetErrorCode(v string) *BatchItemError { - s.ErrorCode = &v +// SetCreationTimeAfter sets the CreationTimeAfter field's value. +func (s *DatasetFilter) SetCreationTimeAfter(v time.Time) *DatasetFilter { + s.CreationTimeAfter = &v return s } -// SetErrorMessage sets the ErrorMessage field's value. -func (s *BatchItemError) SetErrorMessage(v string) *BatchItemError { - s.ErrorMessage = &v +// SetCreationTimeBefore sets the CreationTimeBefore field's value. +func (s *DatasetFilter) SetCreationTimeBefore(v time.Time) *DatasetFilter { + s.CreationTimeBefore = &v return s } -// SetIndex sets the Index field's value. -func (s *BatchItemError) SetIndex(v int64) *BatchItemError { - s.Index = &v +// SetDatasetType sets the DatasetType field's value. +func (s *DatasetFilter) SetDatasetType(v string) *DatasetFilter { + s.DatasetType = &v return s } -// The number of documents in the request exceeds the limit of 25. Try your -// request again with fewer documents. -type BatchSizeLimitExceededException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +// SetStatus sets the Status field's value. +func (s *DatasetFilter) SetStatus(v string) *DatasetFilter { + s.Status = &v + return s +} - Message_ *string `locationName:"Message" min:"1" type:"string"` +// Specifies the format and location of the input data for the dataset. +type DatasetInputDataConfig struct { + _ struct{} `type:"structure"` + + // A list of augmented manifest files that provide training data for your custom + // model. An augmented manifest file is a labeled dataset that is produced by + // Amazon SageMaker Ground Truth. + AugmentedManifests []*DatasetAugmentedManifestsListItem `type:"list"` + + // COMPREHEND_CSV: The data format is a two-column CSV file, where the first + // column contains labels and the second column contains documents. + // + // AUGMENTED_MANIFEST: The data format + DataFormat *string `type:"string" enum:"DatasetDataFormat"` + + // The input properties for training a document classifier model. + // + // For more information on how the input file is formatted, see Preparing training + // data (https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html) + // in the Comprehend Developer Guide. + DocumentClassifierInputDataConfig *DatasetDocumentClassifierInputDataConfig `type:"structure"` + + // The input properties for training an entity recognizer model. + EntityRecognizerInputDataConfig *DatasetEntityRecognizerInputDataConfig `type:"structure"` } // String returns the string representation. @@ -8834,7 +12588,7 @@ type BatchSizeLimitExceededException struct { // 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 BatchSizeLimitExceededException) String() string { +func (s DatasetInputDataConfig) String() string { return awsutil.Prettify(s) } @@ -8843,79 +12597,98 @@ func (s BatchSizeLimitExceededException) String() string { // 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 BatchSizeLimitExceededException) GoString() string { +func (s DatasetInputDataConfig) GoString() string { return s.String() } -func newErrorBatchSizeLimitExceededException(v protocol.ResponseMetadata) error { - return &BatchSizeLimitExceededException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *DatasetInputDataConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DatasetInputDataConfig"} + if s.AugmentedManifests != nil { + for i, v := range s.AugmentedManifests { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AugmentedManifests", i), err.(request.ErrInvalidParams)) + } + } + } + if s.DocumentClassifierInputDataConfig != nil { + if err := s.DocumentClassifierInputDataConfig.Validate(); err != nil { + invalidParams.AddNested("DocumentClassifierInputDataConfig", err.(request.ErrInvalidParams)) + } + } + if s.EntityRecognizerInputDataConfig != nil { + if err := s.EntityRecognizerInputDataConfig.Validate(); err != nil { + invalidParams.AddNested("EntityRecognizerInputDataConfig", err.(request.ErrInvalidParams)) + } } -} - -// Code returns the exception type name. -func (s *BatchSizeLimitExceededException) Code() string { - return "BatchSizeLimitExceededException" -} -// Message returns the exception's message. -func (s *BatchSizeLimitExceededException) Message() string { - if s.Message_ != nil { - return *s.Message_ + if invalidParams.Len() > 0 { + return invalidParams } - return "" + return nil } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *BatchSizeLimitExceededException) OrigErr() error { - return nil +// SetAugmentedManifests sets the AugmentedManifests field's value. +func (s *DatasetInputDataConfig) SetAugmentedManifests(v []*DatasetAugmentedManifestsListItem) *DatasetInputDataConfig { + s.AugmentedManifests = v + return s } -func (s *BatchSizeLimitExceededException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// SetDataFormat sets the DataFormat field's value. +func (s *DatasetInputDataConfig) SetDataFormat(v string) *DatasetInputDataConfig { + s.DataFormat = &v + return s } -// Status code returns the HTTP status code for the request's response error. -func (s *BatchSizeLimitExceededException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetDocumentClassifierInputDataConfig sets the DocumentClassifierInputDataConfig field's value. +func (s *DatasetInputDataConfig) SetDocumentClassifierInputDataConfig(v *DatasetDocumentClassifierInputDataConfig) *DatasetInputDataConfig { + s.DocumentClassifierInputDataConfig = v + return s } -// RequestID returns the service's response RequestID for request. -func (s *BatchSizeLimitExceededException) RequestID() string { - return s.RespMetadata.RequestID +// SetEntityRecognizerInputDataConfig sets the EntityRecognizerInputDataConfig field's value. +func (s *DatasetInputDataConfig) SetEntityRecognizerInputDataConfig(v *DatasetEntityRecognizerInputDataConfig) *DatasetInputDataConfig { + s.EntityRecognizerInputDataConfig = v + return s } -// Information about each word or line of text in the input document. -// -// For additional information, see Block (https://docs.aws.amazon.com/textract/latest/dg/API_Block.html) -// in the Amazon Textract API reference. -type Block struct { +// Properties associated with the dataset. +type DatasetProperties struct { _ struct{} `type:"structure"` - // The block represents a line of text or one word of text. - // - // * WORD - A word that's detected on a document page. A word is one or more - // ISO basic Latin script characters that aren't separated by spaces. - // - // * LINE - A string of tab-delimited, contiguous words that are detected - // on a document page - BlockType *string `type:"string" enum:"BlockType"` + // Creation time of the dataset. + CreationTime *time.Time `type:"timestamp"` - // Co-ordinates of the rectangle or polygon that contains the text. - Geometry *Geometry `type:"structure"` + // The ARN of the dataset. + DatasetArn *string `type:"string"` - // Unique identifier for the block. - Id *string `min:"1" type:"string"` + // The name of the dataset. + DatasetName *string `type:"string"` - // Page number where the block appears. - Page *int64 `type:"integer"` + // The S3 URI where the dataset is stored. + DatasetS3Uri *string `type:"string"` - // A list of child blocks of the current block. For example, a LINE object has - // child blocks for each WORD block that's part of the line of text. - Relationships []*RelationshipsListItem `type:"list"` + // The dataset type (training data or test data). + DatasetType *string `type:"string" enum:"DatasetType"` - // The word or line of text extracted from the block. - Text *string `min:"1" type:"string"` + // Description of the dataset. + Description *string `type:"string"` + + // Time when the data from the dataset becomes available in the data lake. + EndTime *time.Time `type:"timestamp"` + + // A description of the status of the dataset. + Message *string `type:"string"` + + // The number of documents in the dataset. + NumberOfDocuments *int64 `type:"long"` + + // The dataset status. While the system creates the dataset, the status is CREATING. + // When the dataset is ready to use, the status changes to COMPLETED. + Status *string `type:"string" enum:"DatasetStatus"` } // String returns the string representation. @@ -8923,7 +12696,7 @@ type Block struct { // 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 Block) String() string { +func (s DatasetProperties) String() string { return awsutil.Prettify(s) } @@ -8932,61 +12705,77 @@ func (s Block) String() string { // 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 Block) GoString() string { +func (s DatasetProperties) GoString() string { return s.String() } -// SetBlockType sets the BlockType field's value. -func (s *Block) SetBlockType(v string) *Block { - s.BlockType = &v +// SetCreationTime sets the CreationTime field's value. +func (s *DatasetProperties) SetCreationTime(v time.Time) *DatasetProperties { + s.CreationTime = &v return s } -// SetGeometry sets the Geometry field's value. -func (s *Block) SetGeometry(v *Geometry) *Block { - s.Geometry = v +// SetDatasetArn sets the DatasetArn field's value. +func (s *DatasetProperties) SetDatasetArn(v string) *DatasetProperties { + s.DatasetArn = &v return s } -// SetId sets the Id field's value. -func (s *Block) SetId(v string) *Block { - s.Id = &v +// SetDatasetName sets the DatasetName field's value. +func (s *DatasetProperties) SetDatasetName(v string) *DatasetProperties { + s.DatasetName = &v return s } -// SetPage sets the Page field's value. -func (s *Block) SetPage(v int64) *Block { - s.Page = &v +// SetDatasetS3Uri sets the DatasetS3Uri field's value. +func (s *DatasetProperties) SetDatasetS3Uri(v string) *DatasetProperties { + s.DatasetS3Uri = &v return s } -// SetRelationships sets the Relationships field's value. -func (s *Block) SetRelationships(v []*RelationshipsListItem) *Block { - s.Relationships = v +// SetDatasetType sets the DatasetType field's value. +func (s *DatasetProperties) SetDatasetType(v string) *DatasetProperties { + s.DatasetType = &v return s } -// SetText sets the Text field's value. -func (s *Block) SetText(v string) *Block { - s.Text = &v +// SetDescription sets the Description field's value. +func (s *DatasetProperties) SetDescription(v string) *DatasetProperties { + s.Description = &v return s } -// A reference to a block. -type BlockReference struct { - _ struct{} `type:"structure"` +// SetEndTime sets the EndTime field's value. +func (s *DatasetProperties) SetEndTime(v time.Time) *DatasetProperties { + s.EndTime = &v + return s +} - // Offset of the start of the block within its parent block. - BeginOffset *int64 `type:"integer"` +// SetMessage sets the Message field's value. +func (s *DatasetProperties) SetMessage(v string) *DatasetProperties { + s.Message = &v + return s +} - // Unique identifier for the block. - BlockId *string `min:"1" type:"string"` +// SetNumberOfDocuments sets the NumberOfDocuments field's value. +func (s *DatasetProperties) SetNumberOfDocuments(v int64) *DatasetProperties { + s.NumberOfDocuments = &v + return s +} - // List of child blocks within this block. - ChildBlocks []*ChildBlock `type:"list"` +// SetStatus sets the Status field's value. +func (s *DatasetProperties) SetStatus(v string) *DatasetProperties { + s.Status = &v + return s +} - // Offset of the end of the block within its parent block. - EndOffset *int64 `type:"integer"` +type DeleteDocumentClassifierInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) that identifies the document classifier. + // + // DocumentClassifierArn is a required field + DocumentClassifierArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -8994,7 +12783,7 @@ type BlockReference struct { // 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 BlockReference) String() string { +func (s DeleteDocumentClassifierInput) String() string { return awsutil.Prettify(s) } @@ -9003,57 +12792,31 @@ func (s BlockReference) String() string { // 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 BlockReference) GoString() string { +func (s DeleteDocumentClassifierInput) GoString() string { return s.String() } -// SetBeginOffset sets the BeginOffset field's value. -func (s *BlockReference) SetBeginOffset(v int64) *BlockReference { - s.BeginOffset = &v - return s -} - -// SetBlockId sets the BlockId field's value. -func (s *BlockReference) SetBlockId(v string) *BlockReference { - s.BlockId = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteDocumentClassifierInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteDocumentClassifierInput"} + if s.DocumentClassifierArn == nil { + invalidParams.Add(request.NewErrParamRequired("DocumentClassifierArn")) + } -// SetChildBlocks sets the ChildBlocks field's value. -func (s *BlockReference) SetChildBlocks(v []*ChildBlock) *BlockReference { - s.ChildBlocks = v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetEndOffset sets the EndOffset field's value. -func (s *BlockReference) SetEndOffset(v int64) *BlockReference { - s.EndOffset = &v +// SetDocumentClassifierArn sets the DocumentClassifierArn field's value. +func (s *DeleteDocumentClassifierInput) SetDocumentClassifierArn(v string) *DeleteDocumentClassifierInput { + s.DocumentClassifierArn = &v return s } -// The bounding box around the detected page or around an element on a document -// page. The left (x-coordinate) and top (y-coordinate) are coordinates that -// represent the top and left sides of the bounding box. Note that the upper-left -// corner of the image is the origin (0,0). -// -// For additional information, see BoundingBox (https://docs.aws.amazon.com/textract/latest/dg/API_BoundingBox.html) -// in the Amazon Textract API reference. -type BoundingBox struct { +type DeleteDocumentClassifierOutput struct { _ struct{} `type:"structure"` - - // The height of the bounding box as a ratio of the overall document page height. - Height *float64 `type:"float"` - - // The left coordinate of the bounding box as a ratio of overall document page - // width. - Left *float64 `type:"float"` - - // The top coordinate of the bounding box as a ratio of overall document page - // height. - Top *float64 `type:"float"` - - // The width of the bounding box as a ratio of the overall document page width. - Width *float64 `type:"float"` } // String returns the string representation. @@ -9061,7 +12824,7 @@ type BoundingBox struct { // 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 BoundingBox) String() string { +func (s DeleteDocumentClassifierOutput) String() string { return awsutil.Prettify(s) } @@ -9070,46 +12833,17 @@ func (s BoundingBox) String() string { // 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 BoundingBox) GoString() string { +func (s DeleteDocumentClassifierOutput) GoString() string { return s.String() } -// SetHeight sets the Height field's value. -func (s *BoundingBox) SetHeight(v float64) *BoundingBox { - s.Height = &v - return s -} - -// SetLeft sets the Left field's value. -func (s *BoundingBox) SetLeft(v float64) *BoundingBox { - s.Left = &v - return s -} - -// SetTop sets the Top field's value. -func (s *BoundingBox) SetTop(v float64) *BoundingBox { - s.Top = &v - return s -} - -// SetWidth sets the Width field's value. -func (s *BoundingBox) SetWidth(v float64) *BoundingBox { - s.Width = &v - return s -} - -// Nested block contained within a block. -type ChildBlock struct { +type DeleteEndpointInput struct { _ struct{} `type:"structure"` - // Offset of the start of the child block within its parent block. - BeginOffset *int64 `type:"integer"` - - // Unique identifier for the child block. - ChildBlockId *string `min:"1" type:"string"` - - // Offset of the end of the child block within its parent block. - EndOffset *int64 `type:"integer"` + // The Amazon Resource Number (ARN) of the endpoint being deleted. + // + // EndpointArn is a required field + EndpointArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -9117,7 +12851,7 @@ type ChildBlock struct { // 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 ChildBlock) String() string { +func (s DeleteEndpointInput) String() string { return awsutil.Prettify(s) } @@ -9126,78 +12860,58 @@ func (s ChildBlock) String() string { // 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 ChildBlock) GoString() string { +func (s DeleteEndpointInput) GoString() string { return s.String() } -// SetBeginOffset sets the BeginOffset field's value. -func (s *ChildBlock) SetBeginOffset(v int64) *ChildBlock { - s.BeginOffset = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteEndpointInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteEndpointInput"} + if s.EndpointArn == nil { + invalidParams.Add(request.NewErrParamRequired("EndpointArn")) + } -// SetChildBlockId sets the ChildBlockId field's value. -func (s *ChildBlock) SetChildBlockId(v string) *ChildBlock { - s.ChildBlockId = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetEndOffset sets the EndOffset field's value. -func (s *ChildBlock) SetEndOffset(v int64) *ChildBlock { - s.EndOffset = &v +// SetEndpointArn sets the EndpointArn field's value. +func (s *DeleteEndpointInput) SetEndpointArn(v string) *DeleteEndpointInput { + s.EndpointArn = &v return s } -// Describes the result metrics for the test data associated with an documentation -// classifier. -type ClassifierEvaluationMetrics struct { +type DeleteEndpointOutput struct { _ struct{} `type:"structure"` +} - // The fraction of the labels that were correct recognized. It is computed by - // dividing the number of labels in the test documents that were correctly recognized - // by the total number of labels in the test documents. - Accuracy *float64 `type:"double"` - - // A measure of how accurate the classifier 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. - F1Score *float64 `type:"double"` - - // 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. - HammingLoss *float64 `type:"double"` - - // A measure of how accurate the classifier results are for the test data. It - // is a combination of the Micro Precision and Micro Recall values. The Micro - // F1Score is the harmonic mean of the two scores. The highest score is 1, and - // the worst score is 0. - MicroF1Score *float64 `type:"double"` - - // 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. Unlike the Precision metric which comes from - // averaging the precision of all available labels, this is based on the overall - // score of all precision scores added together. - MicroPrecision *float64 `type:"double"` +// 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 DeleteEndpointOutput) String() string { + return awsutil.Prettify(s) +} - // A measure of how complete the classifier results are for the test data. High - // recall means that the classifier returned most of the relevant results. Specifically, - // this indicates how many of the correct categories in the text that the model - // can predict. It is a percentage of correct categories in the text that can - // found. Instead of averaging the recall scores of all labels (as with Recall), - // micro Recall is based on the overall score of all recall scores added together. - MicroRecall *float64 `type:"double"` +// 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 DeleteEndpointOutput) GoString() string { + return s.String() +} - // A measure of the usefulness of the classifier results in the test data. High - // precision means that the classifier returned substantially more relevant - // results than irrelevant ones. - Precision *float64 `type:"double"` +type DeleteEntityRecognizerInput struct { + _ struct{} `type:"structure"` - // A measure of how complete the classifier results are for the test data. High - // recall means that the classifier returned most of the relevant results. - Recall *float64 `type:"double"` + // The Amazon Resource Name (ARN) that identifies the entity recognizer. + // + // EntityRecognizerArn is a required field + EntityRecognizerArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -9205,7 +12919,7 @@ type ClassifierEvaluationMetrics struct { // 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 ClassifierEvaluationMetrics) String() string { +func (s DeleteEntityRecognizerInput) String() string { return awsutil.Prettify(s) } @@ -9214,76 +12928,58 @@ func (s ClassifierEvaluationMetrics) String() string { // 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 ClassifierEvaluationMetrics) GoString() string { +func (s DeleteEntityRecognizerInput) GoString() string { return s.String() } -// SetAccuracy sets the Accuracy field's value. -func (s *ClassifierEvaluationMetrics) SetAccuracy(v float64) *ClassifierEvaluationMetrics { - s.Accuracy = &v - return s -} - -// SetF1Score sets the F1Score field's value. -func (s *ClassifierEvaluationMetrics) SetF1Score(v float64) *ClassifierEvaluationMetrics { - s.F1Score = &v - return s -} - -// SetHammingLoss sets the HammingLoss field's value. -func (s *ClassifierEvaluationMetrics) SetHammingLoss(v float64) *ClassifierEvaluationMetrics { - s.HammingLoss = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteEntityRecognizerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteEntityRecognizerInput"} + if s.EntityRecognizerArn == nil { + invalidParams.Add(request.NewErrParamRequired("EntityRecognizerArn")) + } -// SetMicroF1Score sets the MicroF1Score field's value. -func (s *ClassifierEvaluationMetrics) SetMicroF1Score(v float64) *ClassifierEvaluationMetrics { - s.MicroF1Score = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetMicroPrecision sets the MicroPrecision field's value. -func (s *ClassifierEvaluationMetrics) SetMicroPrecision(v float64) *ClassifierEvaluationMetrics { - s.MicroPrecision = &v +// SetEntityRecognizerArn sets the EntityRecognizerArn field's value. +func (s *DeleteEntityRecognizerInput) SetEntityRecognizerArn(v string) *DeleteEntityRecognizerInput { + s.EntityRecognizerArn = &v return s } -// SetMicroRecall sets the MicroRecall field's value. -func (s *ClassifierEvaluationMetrics) SetMicroRecall(v float64) *ClassifierEvaluationMetrics { - s.MicroRecall = &v - return s +type DeleteEntityRecognizerOutput struct { + _ struct{} `type:"structure"` } -// SetPrecision sets the Precision field's value. -func (s *ClassifierEvaluationMetrics) SetPrecision(v float64) *ClassifierEvaluationMetrics { - s.Precision = &v - return s +// 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 DeleteEntityRecognizerOutput) String() string { + return awsutil.Prettify(s) } -// SetRecall sets the Recall field's value. -func (s *ClassifierEvaluationMetrics) SetRecall(v float64) *ClassifierEvaluationMetrics { - s.Recall = &v - return 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 DeleteEntityRecognizerOutput) GoString() string { + return s.String() } -// Provides information about a document classifier. -type ClassifierMetadata struct { - _ struct{} `type:"structure" sensitive:"true"` - - // Describes the result metrics for the test data associated with an documentation - // classifier. - EvaluationMetrics *ClassifierEvaluationMetrics `type:"structure"` - - // The number of labels in the input data. - NumberOfLabels *int64 `type:"integer"` - - // The number of documents in the input data that were used to test the classifier. - // Typically this is 10 to 20 percent of the input documents, up to 10,000 documents. - NumberOfTestDocuments *int64 `type:"integer"` +type DeleteFlywheelInput struct { + _ struct{} `type:"structure"` - // The number of documents in the input data that were used to train the classifier. - // Typically this is 80 to 90 percent of the input documents. - NumberOfTrainedDocuments *int64 `type:"integer"` + // The Amazon Resource Number (ARN) of the flywheel to delete. + // + // FlywheelArn is a required field + FlywheelArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -9291,7 +12987,7 @@ type ClassifierMetadata struct { // 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 ClassifierMetadata) String() string { +func (s DeleteFlywheelInput) String() string { return awsutil.Prettify(s) } @@ -9300,70 +12996,62 @@ func (s ClassifierMetadata) String() string { // 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 ClassifierMetadata) GoString() string { +func (s DeleteFlywheelInput) GoString() string { return s.String() } -// SetEvaluationMetrics sets the EvaluationMetrics field's value. -func (s *ClassifierMetadata) SetEvaluationMetrics(v *ClassifierEvaluationMetrics) *ClassifierMetadata { - s.EvaluationMetrics = v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteFlywheelInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteFlywheelInput"} + if s.FlywheelArn == nil { + invalidParams.Add(request.NewErrParamRequired("FlywheelArn")) + } -// SetNumberOfLabels sets the NumberOfLabels field's value. -func (s *ClassifierMetadata) SetNumberOfLabels(v int64) *ClassifierMetadata { - s.NumberOfLabels = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetNumberOfTestDocuments sets the NumberOfTestDocuments field's value. -func (s *ClassifierMetadata) SetNumberOfTestDocuments(v int64) *ClassifierMetadata { - s.NumberOfTestDocuments = &v +// SetFlywheelArn sets the FlywheelArn field's value. +func (s *DeleteFlywheelInput) SetFlywheelArn(v string) *DeleteFlywheelInput { + s.FlywheelArn = &v return s } -// SetNumberOfTrainedDocuments sets the NumberOfTrainedDocuments field's value. -func (s *ClassifierMetadata) SetNumberOfTrainedDocuments(v int64) *ClassifierMetadata { - s.NumberOfTrainedDocuments = &v - return s +type DeleteFlywheelOutput struct { + _ struct{} `type:"structure"` } -type ClassifyDocumentInput struct { - _ struct{} `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 DeleteFlywheelOutput) String() string { + return awsutil.Prettify(s) +} - // Use the Bytes parameter to input a text, PDF, Word or image file. You can - // also use the Bytes parameter to input an Amazon Textract DetectDocumentText - // or AnalyzeDocument output file. - // - // Provide the input document as a sequence of base64-encoded bytes. If your - // code uses an Amazon Web Services SDK to classify documents, the SDK may encode - // the document file bytes for you. - // - // The maximum length of this field depends on the input document type. For - // details, see Inputs for real-time custom analysis (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html) - // in the Comprehend Developer Guide. - // - // If you use the Bytes parameter, do not use the Text parameter. - // Bytes is automatically base64 encoded/decoded by the SDK. - Bytes []byte `min:"1" type:"blob"` +// 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 DeleteFlywheelOutput) GoString() string { + return s.String() +} - // Provides configuration parameters to override the default actions for extracting - // text from PDF documents and image files. - DocumentReaderConfig *DocumentReaderConfig `type:"structure"` +type DeleteResourcePolicyInput struct { + _ struct{} `type:"structure"` - // The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, - // see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). - // - // EndpointArn is a required field - EndpointArn *string `type:"string" required:"true"` + // The revision ID of the policy to delete. + PolicyRevisionId *string `type:"string"` - // The document text to be analyzed. If you enter text using this parameter, - // do not use the Bytes parameter. + // The Amazon Resource Name (ARN) of the custom model version that has the policy + // to delete. // - // Text is a sensitive parameter and its value will be - // replaced with "sensitive" in string returned by ClassifyDocumentInput's - // String and GoString methods. - Text *string `min:"1" type:"string" sensitive:"true"` + // ResourceArn is a required field + ResourceArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -9371,7 +13059,7 @@ type ClassifyDocumentInput struct { // 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 ClassifyDocumentInput) String() string { +func (s DeleteResourcePolicyInput) String() string { return awsutil.Prettify(s) } @@ -9380,26 +13068,15 @@ func (s ClassifyDocumentInput) String() string { // 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 ClassifyDocumentInput) GoString() string { +func (s DeleteResourcePolicyInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ClassifyDocumentInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ClassifyDocumentInput"} - if s.Bytes != nil && len(s.Bytes) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Bytes", 1)) - } - if s.EndpointArn == nil { - invalidParams.Add(request.NewErrParamRequired("EndpointArn")) - } - if s.Text != nil && len(*s.Text) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Text", 1)) - } - if s.DocumentReaderConfig != nil { - if err := s.DocumentReaderConfig.Validate(); err != nil { - invalidParams.AddNested("DocumentReaderConfig", err.(request.ErrInvalidParams)) - } +func (s *DeleteResourcePolicyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteResourcePolicyInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) } if invalidParams.Len() > 0 { @@ -9408,65 +13085,28 @@ func (s *ClassifyDocumentInput) Validate() error { return nil } -// SetBytes sets the Bytes field's value. -func (s *ClassifyDocumentInput) SetBytes(v []byte) *ClassifyDocumentInput { - s.Bytes = v - return s -} - -// SetDocumentReaderConfig sets the DocumentReaderConfig field's value. -func (s *ClassifyDocumentInput) SetDocumentReaderConfig(v *DocumentReaderConfig) *ClassifyDocumentInput { - s.DocumentReaderConfig = v - return s -} - -// SetEndpointArn sets the EndpointArn field's value. -func (s *ClassifyDocumentInput) SetEndpointArn(v string) *ClassifyDocumentInput { - s.EndpointArn = &v +// SetPolicyRevisionId sets the PolicyRevisionId field's value. +func (s *DeleteResourcePolicyInput) SetPolicyRevisionId(v string) *DeleteResourcePolicyInput { + s.PolicyRevisionId = &v return s } -// SetText sets the Text field's value. -func (s *ClassifyDocumentInput) SetText(v string) *ClassifyDocumentInput { - s.Text = &v +// SetResourceArn sets the ResourceArn field's value. +func (s *DeleteResourcePolicyInput) SetResourceArn(v string) *DeleteResourcePolicyInput { + s.ResourceArn = &v return s } -type ClassifyDocumentOutput struct { - _ struct{} `type:"structure" sensitive:"true"` - - // The classes used by the document being analyzed. These are used for multi-class - // trained models. Individual classes are mutually exclusive and each document - // is expected to have only a single class assigned to it. For example, an animal - // can be a dog or a cat, but not both at the same time. - Classes []*DocumentClass `type:"list"` - - // Extraction information about the document. This field is present in the response - // only if your request includes the Byte parameter. - DocumentMetadata *DocumentMetadata `type:"structure"` - - // The document type for each page in the input document. This field is present - // in the response only if your request includes the Byte parameter. - DocumentType []*DocumentTypeListItem `type:"list"` - - // Page-level errors that the system detected while processing the input document. - // The field is empty if the system encountered no errors. - Errors []*ErrorsListItem `type:"list"` - - // The labels used the document being analyzed. These are used for multi-label - // trained models. Individual labels represent different categories that are - // related in some manner and are not mutually exclusive. For example, a movie - // can be just an action movie, or it can be an action movie, a science fiction - // movie, and a comedy, all at the same time. - Labels []*DocumentLabel `type:"list"` -} - +type DeleteResourcePolicyOutput struct { + _ struct{} `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 ClassifyDocumentOutput) String() string { +func (s DeleteResourcePolicyOutput) String() string { return awsutil.Prettify(s) } @@ -9475,47 +13115,17 @@ func (s ClassifyDocumentOutput) String() string { // 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 ClassifyDocumentOutput) GoString() string { +func (s DeleteResourcePolicyOutput) GoString() string { return s.String() } -// SetClasses sets the Classes field's value. -func (s *ClassifyDocumentOutput) SetClasses(v []*DocumentClass) *ClassifyDocumentOutput { - s.Classes = v - return s -} - -// SetDocumentMetadata sets the DocumentMetadata field's value. -func (s *ClassifyDocumentOutput) SetDocumentMetadata(v *DocumentMetadata) *ClassifyDocumentOutput { - s.DocumentMetadata = v - return s -} - -// SetDocumentType sets the DocumentType field's value. -func (s *ClassifyDocumentOutput) SetDocumentType(v []*DocumentTypeListItem) *ClassifyDocumentOutput { - s.DocumentType = v - return s -} - -// SetErrors sets the Errors field's value. -func (s *ClassifyDocumentOutput) SetErrors(v []*ErrorsListItem) *ClassifyDocumentOutput { - s.Errors = v - return s -} - -// SetLabels sets the Labels field's value. -func (s *ClassifyDocumentOutput) SetLabels(v []*DocumentLabel) *ClassifyDocumentOutput { - s.Labels = v - return s -} - -// Concurrent modification of the tags associated with an Amazon Comprehend -// resource is not supported. -type ConcurrentModificationException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +type DescribeDatasetInput struct { + _ struct{} `type:"structure"` - Message_ *string `locationName:"Message" min:"1" type:"string"` + // The ARN of the dataset. + // + // DatasetArn is a required field + DatasetArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -9523,7 +13133,7 @@ type ConcurrentModificationException struct { // 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 ConcurrentModificationException) String() string { +func (s DescribeDatasetInput) String() string { return awsutil.Prettify(s) } @@ -9532,61 +13142,68 @@ func (s ConcurrentModificationException) String() string { // 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 ConcurrentModificationException) GoString() string { +func (s DescribeDatasetInput) GoString() string { return s.String() } -func newErrorConcurrentModificationException(v protocol.ResponseMetadata) error { - return &ConcurrentModificationException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeDatasetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDatasetInput"} + if s.DatasetArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetArn")) } -} -// Code returns the exception type name. -func (s *ConcurrentModificationException) Code() string { - return "ConcurrentModificationException" + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// Message returns the exception's message. -func (s *ConcurrentModificationException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" +// SetDatasetArn sets the DatasetArn field's value. +func (s *DescribeDatasetInput) SetDatasetArn(v string) *DescribeDatasetInput { + s.DatasetArn = &v + return s } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *ConcurrentModificationException) OrigErr() error { - return nil +type DescribeDatasetOutput struct { + _ struct{} `type:"structure"` + + // The dataset properties. + DatasetProperties *DatasetProperties `type:"structure"` } -func (s *ConcurrentModificationException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// 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 DescribeDatasetOutput) String() string { + return awsutil.Prettify(s) } -// Status code returns the HTTP status code for the request's response error. -func (s *ConcurrentModificationException) StatusCode() int { - return s.RespMetadata.StatusCode +// 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 DescribeDatasetOutput) GoString() string { + return s.String() } -// RequestID returns the service's response RequestID for request. -func (s *ConcurrentModificationException) RequestID() string { - return s.RespMetadata.RequestID +// SetDatasetProperties sets the DatasetProperties field's value. +func (s *DescribeDatasetOutput) SetDatasetProperties(v *DatasetProperties) *DescribeDatasetOutput { + s.DatasetProperties = v + return s } -type ContainsPiiEntitiesInput struct { +type DescribeDocumentClassificationJobInput struct { _ struct{} `type:"structure"` - // The language of the input documents. Currently, English is the only valid - // language. - // - // LanguageCode is a required field - LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - - // A UTF-8 text string. The maximum string size is 100 KB. + // The identifier that Amazon Comprehend generated for the job. The StartDocumentClassificationJob + // operation returns this identifier in its response. // - // Text is a required field - Text *string `min:"1" type:"string" required:"true"` + // JobId is a required field + JobId *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -9594,7 +13211,7 @@ type ContainsPiiEntitiesInput struct { // 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 ContainsPiiEntitiesInput) String() string { +func (s DescribeDocumentClassificationJobInput) String() string { return awsutil.Prettify(s) } @@ -9603,21 +13220,18 @@ func (s ContainsPiiEntitiesInput) String() string { // 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 ContainsPiiEntitiesInput) GoString() string { +func (s DescribeDocumentClassificationJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ContainsPiiEntitiesInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ContainsPiiEntitiesInput"} - if s.LanguageCode == nil { - invalidParams.Add(request.NewErrParamRequired("LanguageCode")) - } - if s.Text == nil { - invalidParams.Add(request.NewErrParamRequired("Text")) +func (s *DescribeDocumentClassificationJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDocumentClassificationJobInput"} + if s.JobId == nil { + invalidParams.Add(request.NewErrParamRequired("JobId")) } - if s.Text != nil && len(*s.Text) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Text", 1)) + if s.JobId != nil && len(*s.JobId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) } if invalidParams.Len() > 0 { @@ -9626,24 +13240,18 @@ func (s *ContainsPiiEntitiesInput) Validate() error { return nil } -// SetLanguageCode sets the LanguageCode field's value. -func (s *ContainsPiiEntitiesInput) SetLanguageCode(v string) *ContainsPiiEntitiesInput { - s.LanguageCode = &v - return s -} - -// SetText sets the Text field's value. -func (s *ContainsPiiEntitiesInput) SetText(v string) *ContainsPiiEntitiesInput { - s.Text = &v +// SetJobId sets the JobId field's value. +func (s *DescribeDocumentClassificationJobInput) SetJobId(v string) *DescribeDocumentClassificationJobInput { + s.JobId = &v return s } -type ContainsPiiEntitiesOutput struct { +type DescribeDocumentClassificationJobOutput struct { _ struct{} `type:"structure"` - // The labels used in the document being analyzed. Individual labels represent - // personally identifiable information (PII) entity types. - Labels []*EntityLabel `type:"list"` + // An object that describes the properties associated with the document classification + // job. + DocumentClassificationJobProperties *DocumentClassificationJobProperties `type:"structure"` } // String returns the string representation. @@ -9651,7 +13259,7 @@ type ContainsPiiEntitiesOutput struct { // 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 ContainsPiiEntitiesOutput) String() string { +func (s DescribeDocumentClassificationJobOutput) String() string { return awsutil.Prettify(s) } @@ -9660,111 +13268,102 @@ func (s ContainsPiiEntitiesOutput) String() string { // 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 ContainsPiiEntitiesOutput) GoString() string { +func (s DescribeDocumentClassificationJobOutput) GoString() string { return s.String() } -// SetLabels sets the Labels field's value. -func (s *ContainsPiiEntitiesOutput) SetLabels(v []*EntityLabel) *ContainsPiiEntitiesOutput { - s.Labels = v +// SetDocumentClassificationJobProperties sets the DocumentClassificationJobProperties field's value. +func (s *DescribeDocumentClassificationJobOutput) SetDocumentClassificationJobProperties(v *DocumentClassificationJobProperties) *DescribeDocumentClassificationJobOutput { + s.DocumentClassificationJobProperties = v return s } -type CreateDocumentClassifierInput struct { +type DescribeDocumentClassifierInput struct { _ struct{} `type:"structure"` - // 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 Management (IAM) role - // that grants Amazon Comprehend read access to your input data. + // The Amazon Resource Name (ARN) that identifies the document classifier. The + // CreateDocumentClassifier operation returns this identifier in its response. // - // DataAccessRoleArn is a required field - DataAccessRoleArn *string `min:"20" type:"string" required:"true"` + // DocumentClassifierArn is a required field + DocumentClassifierArn *string `type:"string" required:"true"` +} - // The name of the document classifier. - // - // DocumentClassifierName is a required field - DocumentClassifierName *string `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 DescribeDocumentClassifierInput) String() string { + return awsutil.Prettify(s) +} - // Specifies the format and location of the input data for the job. - // - // InputDataConfig is a required field - InputDataConfig *DocumentClassifierInputDataConfig `type:"structure" required:"true"` +// 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 DescribeDocumentClassifierInput) GoString() string { + return s.String() +} - // The language of the input documents. You can specify any of the following - // languages supported by Amazon Comprehend: German ("de"), English ("en"), - // Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All - // documents must be in the same language. - // - // LanguageCode is a required field - LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeDocumentClassifierInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDocumentClassifierInput"} + if s.DocumentClassifierArn == nil { + invalidParams.Add(request.NewErrParamRequired("DocumentClassifierArn")) + } - // Indicates the mode in which the classifier will be trained. The classifier - // can be trained in multi-class mode, which identifies one and only one class - // for each document, or multi-label mode, which identifies one or more labels - // for each document. In multi-label mode, multiple labels for an individual - // document are separated by a delimiter. The default delimiter between labels - // is a pipe (|). - Mode *string `type:"string" enum:"DocumentClassifierMode"` + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} - // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses - // to encrypt trained custom models. The ModelKmsKeyId 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" - ModelKmsKeyId *string `type:"string"` +// SetDocumentClassifierArn sets the DocumentClassifierArn field's value. +func (s *DescribeDocumentClassifierInput) SetDocumentClassifierArn(v string) *DescribeDocumentClassifierInput { + s.DocumentClassifierArn = &v + return s +} - // The resource-based policy to attach to your custom document classifier model. - // You can use this policy to allow another AWS account to import your custom - // model. - // - // Provide your policy as a JSON body that you enter as a UTF-8 encoded string - // without line breaks. To provide valid JSON, enclose the attribute names and - // values in double quotes. If the JSON body is also enclosed in double quotes, - // then you must escape the double quotes that are inside the policy: - // - // "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" - // - // To avoid escaping quotes, you can use single quotes to enclose the policy - // and double quotes to enclose the JSON names and values: - // - // '{"attribute": "value", "attribute": ["value"]}' - ModelPolicy *string `min:"1" type:"string"` +type DescribeDocumentClassifierOutput struct { + _ struct{} `type:"structure"` + + // An object that contains the properties associated with a document classifier. + DocumentClassifierProperties *DocumentClassifierProperties `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 DescribeDocumentClassifierOutput) String() string { + return awsutil.Prettify(s) +} - // Enables the addition of output results configuration parameters for custom - // classifier jobs. - OutputDataConfig *DocumentClassifierOutputDataConfig `type:"structure"` +// 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 DescribeDocumentClassifierOutput) GoString() string { + return s.String() +} - // Tags to be associated with the document classifier being created. 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. - Tags []*Tag `type:"list"` +// SetDocumentClassifierProperties sets the DocumentClassifierProperties field's value. +func (s *DescribeDocumentClassifierOutput) SetDocumentClassifierProperties(v *DocumentClassifierProperties) *DescribeDocumentClassifierOutput { + s.DocumentClassifierProperties = v + return s +} - // The version name given to the newly created classifier. Version names can - // have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and - // underscores (_) are allowed. The version name must be unique among all models - // with the same classifier name in the account/AWS Region. - VersionName *string `type:"string"` +type DescribeDominantLanguageDetectionJobInput struct { + _ struct{} `type:"structure"` - // 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" + // The identifier that Amazon Comprehend generated for the job. The StartDominantLanguageDetectionJob + // operation returns this identifier in its response. // - // * 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 your custom classifier. For more - // information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). - VpcConfig *VpcConfig `type:"structure"` + // JobId is a required field + JobId *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -9772,7 +13371,7 @@ type CreateDocumentClassifierInput struct { // 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 CreateDocumentClassifierInput) String() string { +func (s DescribeDominantLanguageDetectionJobInput) String() string { return awsutil.Prettify(s) } @@ -9781,53 +13380,18 @@ func (s CreateDocumentClassifierInput) String() string { // 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 CreateDocumentClassifierInput) GoString() string { +func (s DescribeDominantLanguageDetectionJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateDocumentClassifierInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateDocumentClassifierInput"} - 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.DocumentClassifierName == nil { - invalidParams.Add(request.NewErrParamRequired("DocumentClassifierName")) - } - if s.InputDataConfig == nil { - invalidParams.Add(request.NewErrParamRequired("InputDataConfig")) - } - if s.LanguageCode == nil { - invalidParams.Add(request.NewErrParamRequired("LanguageCode")) - } - if s.ModelPolicy != nil && len(*s.ModelPolicy) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ModelPolicy", 1)) - } - if s.InputDataConfig != nil { - if err := s.InputDataConfig.Validate(); err != nil { - invalidParams.AddNested("InputDataConfig", 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)) - } - } +func (s *DescribeDominantLanguageDetectionJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDominantLanguageDetectionJobInput"} + if s.JobId == nil { + invalidParams.Add(request.NewErrParamRequired("JobId")) } - if s.VpcConfig != nil { - if err := s.VpcConfig.Validate(); err != nil { - invalidParams.AddNested("VpcConfig", err.(request.ErrInvalidParams)) - } + if s.JobId != nil && len(*s.JobId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) } if invalidParams.Len() > 0 { @@ -9836,89 +13400,95 @@ func (s *CreateDocumentClassifierInput) Validate() error { return nil } -// SetClientRequestToken sets the ClientRequestToken field's value. -func (s *CreateDocumentClassifierInput) SetClientRequestToken(v string) *CreateDocumentClassifierInput { - s.ClientRequestToken = &v +// SetJobId sets the JobId field's value. +func (s *DescribeDominantLanguageDetectionJobInput) SetJobId(v string) *DescribeDominantLanguageDetectionJobInput { + s.JobId = &v return s } -// SetDataAccessRoleArn sets the DataAccessRoleArn field's value. -func (s *CreateDocumentClassifierInput) SetDataAccessRoleArn(v string) *CreateDocumentClassifierInput { - s.DataAccessRoleArn = &v - return s -} +type DescribeDominantLanguageDetectionJobOutput struct { + _ struct{} `type:"structure"` -// SetDocumentClassifierName sets the DocumentClassifierName field's value. -func (s *CreateDocumentClassifierInput) SetDocumentClassifierName(v string) *CreateDocumentClassifierInput { - s.DocumentClassifierName = &v - return s + // An object that contains the properties associated with a dominant language + // detection job. + DominantLanguageDetectionJobProperties *DominantLanguageDetectionJobProperties `type:"structure"` } -// SetInputDataConfig sets the InputDataConfig field's value. -func (s *CreateDocumentClassifierInput) SetInputDataConfig(v *DocumentClassifierInputDataConfig) *CreateDocumentClassifierInput { - s.InputDataConfig = v - return s +// 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 DescribeDominantLanguageDetectionJobOutput) String() string { + return awsutil.Prettify(s) } -// SetLanguageCode sets the LanguageCode field's value. -func (s *CreateDocumentClassifierInput) SetLanguageCode(v string) *CreateDocumentClassifierInput { - s.LanguageCode = &v - return 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 DescribeDominantLanguageDetectionJobOutput) GoString() string { + return s.String() } -// SetMode sets the Mode field's value. -func (s *CreateDocumentClassifierInput) SetMode(v string) *CreateDocumentClassifierInput { - s.Mode = &v +// SetDominantLanguageDetectionJobProperties sets the DominantLanguageDetectionJobProperties field's value. +func (s *DescribeDominantLanguageDetectionJobOutput) SetDominantLanguageDetectionJobProperties(v *DominantLanguageDetectionJobProperties) *DescribeDominantLanguageDetectionJobOutput { + s.DominantLanguageDetectionJobProperties = v return s } -// SetModelKmsKeyId sets the ModelKmsKeyId field's value. -func (s *CreateDocumentClassifierInput) SetModelKmsKeyId(v string) *CreateDocumentClassifierInput { - s.ModelKmsKeyId = &v - return s -} +type DescribeEndpointInput struct { + _ struct{} `type:"structure"` -// SetModelPolicy sets the ModelPolicy field's value. -func (s *CreateDocumentClassifierInput) SetModelPolicy(v string) *CreateDocumentClassifierInput { - s.ModelPolicy = &v - return s + // The Amazon Resource Number (ARN) of the endpoint being described. + // + // EndpointArn is a required field + EndpointArn *string `type:"string" required:"true"` } -// SetOutputDataConfig sets the OutputDataConfig field's value. -func (s *CreateDocumentClassifierInput) SetOutputDataConfig(v *DocumentClassifierOutputDataConfig) *CreateDocumentClassifierInput { - s.OutputDataConfig = v - return s +// 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 DescribeEndpointInput) String() string { + return awsutil.Prettify(s) } -// SetTags sets the Tags field's value. -func (s *CreateDocumentClassifierInput) SetTags(v []*Tag) *CreateDocumentClassifierInput { - s.Tags = v - return 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 DescribeEndpointInput) GoString() string { + return s.String() } -// SetVersionName sets the VersionName field's value. -func (s *CreateDocumentClassifierInput) SetVersionName(v string) *CreateDocumentClassifierInput { - s.VersionName = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeEndpointInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeEndpointInput"} + if s.EndpointArn == nil { + invalidParams.Add(request.NewErrParamRequired("EndpointArn")) + } -// SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value. -func (s *CreateDocumentClassifierInput) SetVolumeKmsKeyId(v string) *CreateDocumentClassifierInput { - s.VolumeKmsKeyId = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetVpcConfig sets the VpcConfig field's value. -func (s *CreateDocumentClassifierInput) SetVpcConfig(v *VpcConfig) *CreateDocumentClassifierInput { - s.VpcConfig = v +// SetEndpointArn sets the EndpointArn field's value. +func (s *DescribeEndpointInput) SetEndpointArn(v string) *DescribeEndpointInput { + s.EndpointArn = &v return s } -type CreateDocumentClassifierOutput struct { +type DescribeEndpointOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that identifies the document classifier. - DocumentClassifierArn *string `type:"string"` + // Describes information associated with the specific endpoint. + EndpointProperties *EndpointProperties `type:"structure"` } // String returns the string representation. @@ -9926,7 +13496,7 @@ type CreateDocumentClassifierOutput struct { // 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 CreateDocumentClassifierOutput) String() string { +func (s DescribeEndpointOutput) String() string { return awsutil.Prettify(s) } @@ -9935,51 +13505,24 @@ func (s CreateDocumentClassifierOutput) String() string { // 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 CreateDocumentClassifierOutput) GoString() string { +func (s DescribeEndpointOutput) GoString() string { return s.String() } -// SetDocumentClassifierArn sets the DocumentClassifierArn field's value. -func (s *CreateDocumentClassifierOutput) SetDocumentClassifierArn(v string) *CreateDocumentClassifierOutput { - s.DocumentClassifierArn = &v +// SetEndpointProperties sets the EndpointProperties field's value. +func (s *DescribeEndpointOutput) SetEndpointProperties(v *EndpointProperties) *DescribeEndpointOutput { + s.EndpointProperties = v return s } -type CreateEndpointInput struct { +type DescribeEntitiesDetectionJobInput struct { _ struct{} `type:"structure"` - // An idempotency token provided by the customer. If this token matches a previous - // endpoint creation request, Amazon Comprehend will not return a ResourceInUseException. - 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 trained custom models - // encrypted with a customer managed key (ModelKmsKeyId). - DataAccessRoleArn *string `min:"20" type:"string"` - - // The desired number of inference units to be used by the model using this - // endpoint. Each inference unit represents of a throughput of 100 characters - // per second. - // - // DesiredInferenceUnits is a required field - DesiredInferenceUnits *int64 `min:"1" type:"integer" required:"true"` - - // This is the descriptive suffix that becomes part of the EndpointArn used - // for all subsequent requests to this resource. - // - // EndpointName is a required field - EndpointName *string `type:"string" required:"true"` - - // The Amazon Resource Number (ARN) of the model to which the endpoint will - // be attached. + // The identifier that Amazon Comprehend generated for the job. The StartEntitiesDetectionJob + // operation returns this identifier in its response. // - // ModelArn is a required field - ModelArn *string `type:"string" required:"true"` - - // Tags associated with the endpoint being created. A tag is a key-value pair - // that adds metadata to the endpoint. For example, a tag with "Sales" as the - // key might be added to an endpoint to indicate its use by the sales department. - Tags []*Tag `type:"list"` + // JobId is a required field + JobId *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -9987,7 +13530,7 @@ type CreateEndpointInput struct { // 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 CreateEndpointInput) String() string { +func (s DescribeEntitiesDetectionJobInput) String() string { return awsutil.Prettify(s) } @@ -9996,40 +13539,18 @@ func (s CreateEndpointInput) String() string { // 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 CreateEndpointInput) GoString() string { +func (s DescribeEntitiesDetectionJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateEndpointInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateEndpointInput"} - if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) - } - if s.DataAccessRoleArn != nil && len(*s.DataAccessRoleArn) < 20 { - invalidParams.Add(request.NewErrParamMinLen("DataAccessRoleArn", 20)) - } - if s.DesiredInferenceUnits == nil { - invalidParams.Add(request.NewErrParamRequired("DesiredInferenceUnits")) - } - if s.DesiredInferenceUnits != nil && *s.DesiredInferenceUnits < 1 { - invalidParams.Add(request.NewErrParamMinValue("DesiredInferenceUnits", 1)) - } - if s.EndpointName == nil { - invalidParams.Add(request.NewErrParamRequired("EndpointName")) - } - if s.ModelArn == nil { - invalidParams.Add(request.NewErrParamRequired("ModelArn")) +func (s *DescribeEntitiesDetectionJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeEntitiesDetectionJobInput"} + if s.JobId == nil { + invalidParams.Add(request.NewErrParamRequired("JobId")) } - 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.JobId != nil && len(*s.JobId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) } if invalidParams.Len() > 0 { @@ -10038,47 +13559,51 @@ func (s *CreateEndpointInput) Validate() error { return nil } -// SetClientRequestToken sets the ClientRequestToken field's value. -func (s *CreateEndpointInput) SetClientRequestToken(v string) *CreateEndpointInput { - s.ClientRequestToken = &v +// SetJobId sets the JobId field's value. +func (s *DescribeEntitiesDetectionJobInput) SetJobId(v string) *DescribeEntitiesDetectionJobInput { + s.JobId = &v return s } -// SetDataAccessRoleArn sets the DataAccessRoleArn field's value. -func (s *CreateEndpointInput) SetDataAccessRoleArn(v string) *CreateEndpointInput { - s.DataAccessRoleArn = &v - return s -} +type DescribeEntitiesDetectionJobOutput struct { + _ struct{} `type:"structure"` -// SetDesiredInferenceUnits sets the DesiredInferenceUnits field's value. -func (s *CreateEndpointInput) SetDesiredInferenceUnits(v int64) *CreateEndpointInput { - s.DesiredInferenceUnits = &v - return s + // An object that contains the properties associated with an entities detection + // job. + EntitiesDetectionJobProperties *EntitiesDetectionJobProperties `type:"structure"` } -// SetEndpointName sets the EndpointName field's value. -func (s *CreateEndpointInput) SetEndpointName(v string) *CreateEndpointInput { - s.EndpointName = &v - return s +// 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 DescribeEntitiesDetectionJobOutput) String() string { + return awsutil.Prettify(s) } -// SetModelArn sets the ModelArn field's value. -func (s *CreateEndpointInput) SetModelArn(v string) *CreateEndpointInput { - s.ModelArn = &v - return 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 DescribeEntitiesDetectionJobOutput) GoString() string { + return s.String() } -// SetTags sets the Tags field's value. -func (s *CreateEndpointInput) SetTags(v []*Tag) *CreateEndpointInput { - s.Tags = v +// SetEntitiesDetectionJobProperties sets the EntitiesDetectionJobProperties field's value. +func (s *DescribeEntitiesDetectionJobOutput) SetEntitiesDetectionJobProperties(v *EntitiesDetectionJobProperties) *DescribeEntitiesDetectionJobOutput { + s.EntitiesDetectionJobProperties = v return s } -type CreateEndpointOutput struct { +type DescribeEntityRecognizerInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Number (ARN) of the endpoint being created. - EndpointArn *string `type:"string"` + // The Amazon Resource Name (ARN) that identifies the entity recognizer. + // + // EntityRecognizerArn is a required field + EntityRecognizerArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -10086,7 +13611,7 @@ type CreateEndpointOutput struct { // 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 CreateEndpointOutput) String() string { +func (s DescribeEntityRecognizerInput) String() string { return awsutil.Prettify(s) } @@ -10095,104 +13620,34 @@ func (s CreateEndpointOutput) String() string { // 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 CreateEndpointOutput) GoString() string { +func (s DescribeEntityRecognizerInput) GoString() string { return s.String() } -// SetEndpointArn sets the EndpointArn field's value. -func (s *CreateEndpointOutput) SetEndpointArn(v string) *CreateEndpointOutput { - s.EndpointArn = &v +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeEntityRecognizerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeEntityRecognizerInput"} + if s.EntityRecognizerArn == nil { + invalidParams.Add(request.NewErrParamRequired("EntityRecognizerArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEntityRecognizerArn sets the EntityRecognizerArn field's value. +func (s *DescribeEntityRecognizerInput) SetEntityRecognizerArn(v string) *DescribeEntityRecognizerInput { + s.EntityRecognizerArn = &v return s } -type CreateEntityRecognizerInput struct { +type DescribeEntityRecognizerOutput struct { _ struct{} `type:"structure"` - // 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 Management (IAM) role - // that grants Amazon Comprehend read access to your input data. - // - // DataAccessRoleArn is a required field - DataAccessRoleArn *string `min:"20" type:"string" required:"true"` - - // Specifies the format and location of the input data. The S3 bucket containing - // the input data must be located in the same region as the entity recognizer - // being created. - // - // InputDataConfig is a required field - InputDataConfig *EntityRecognizerInputDataConfig `type:"structure" required:"true"` - - // You can specify any of the following languages: English ("en"), Spanish ("es"), - // French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you - // plan to use this entity recognizer with PDF, Word, or image input files, - // you must specify English as the language. All training documents must be - // in the same language. - // - // LanguageCode is a required field - LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - - // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses - // to encrypt trained custom models. The ModelKmsKeyId 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" - ModelKmsKeyId *string `type:"string"` - - // The JSON resource-based policy to attach to your custom entity recognizer - // model. You can use this policy to allow another AWS account to import your - // custom model. - // - // Provide your JSON as a UTF-8 encoded string without line breaks. To provide - // valid JSON for your policy, enclose the attribute names and values in double - // quotes. If the JSON body is also enclosed in double quotes, then you must - // escape the double quotes that are inside the policy: - // - // "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" - // - // To avoid escaping quotes, you can use single quotes to enclose the policy - // and double quotes to enclose the JSON names and values: - // - // '{"attribute": "value", "attribute": ["value"]}' - ModelPolicy *string `min:"1" type:"string"` - - // The name given to the newly created recognizer. Recognizer names can be a - // maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores - // (_) are allowed. The name must be unique in the account/region. - // - // RecognizerName is a required field - RecognizerName *string `type:"string" required:"true"` - - // Tags to be associated with the entity recognizer being created. 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. - Tags []*Tag `type:"list"` - - // The version name given to the newly created recognizer. Version names can - // be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and - // underscores (_) are allowed. The version name must be unique among all models - // with the same recognizer name in the account/ AWS Region. - VersionName *string `type:"string"` - - // 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" - VolumeKmsKeyId *string `type:"string"` - - // Configuration parameters for an optional private Virtual Private Cloud (VPC) - // containing the resources you are using for your custom entity recognizer. - // For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). - VpcConfig *VpcConfig `type:"structure"` + // Describes information associated with an entity recognizer. + EntityRecognizerProperties *EntityRecognizerProperties `type:"structure"` } // String returns the string representation. @@ -10200,7 +13655,7 @@ type CreateEntityRecognizerInput struct { // 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 CreateEntityRecognizerInput) String() string { +func (s DescribeEntityRecognizerOutput) String() string { return awsutil.Prettify(s) } @@ -10209,53 +13664,51 @@ func (s CreateEntityRecognizerInput) String() string { // 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 CreateEntityRecognizerInput) GoString() string { +func (s DescribeEntityRecognizerOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *CreateEntityRecognizerInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateEntityRecognizerInput"} - 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.LanguageCode == nil { - invalidParams.Add(request.NewErrParamRequired("LanguageCode")) - } - if s.ModelPolicy != nil && len(*s.ModelPolicy) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ModelPolicy", 1)) - } - if s.RecognizerName == nil { - invalidParams.Add(request.NewErrParamRequired("RecognizerName")) - } - if s.InputDataConfig != nil { - if err := s.InputDataConfig.Validate(); err != nil { - invalidParams.AddNested("InputDataConfig", 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)) - } - } +// SetEntityRecognizerProperties sets the EntityRecognizerProperties field's value. +func (s *DescribeEntityRecognizerOutput) SetEntityRecognizerProperties(v *EntityRecognizerProperties) *DescribeEntityRecognizerOutput { + s.EntityRecognizerProperties = v + return s +} + +type DescribeEventsDetectionJobInput struct { + _ struct{} `type:"structure"` + + // The identifier of the events detection job. + // + // 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 DescribeEventsDetectionJobInput) 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 DescribeEventsDetectionJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeEventsDetectionJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeEventsDetectionJobInput"} + if s.JobId == nil { + invalidParams.Add(request.NewErrParamRequired("JobId")) } - if s.VpcConfig != nil { - if err := s.VpcConfig.Validate(); err != nil { - invalidParams.AddNested("VpcConfig", err.(request.ErrInvalidParams)) - } + if s.JobId != nil && len(*s.JobId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) } if invalidParams.Len() > 0 { @@ -10264,77 +13717,98 @@ func (s *CreateEntityRecognizerInput) Validate() error { return nil } -// SetClientRequestToken sets the ClientRequestToken field's value. -func (s *CreateEntityRecognizerInput) SetClientRequestToken(v string) *CreateEntityRecognizerInput { - s.ClientRequestToken = &v +// SetJobId sets the JobId field's value. +func (s *DescribeEventsDetectionJobInput) SetJobId(v string) *DescribeEventsDetectionJobInput { + s.JobId = &v return s } -// SetDataAccessRoleArn sets the DataAccessRoleArn field's value. -func (s *CreateEntityRecognizerInput) SetDataAccessRoleArn(v string) *CreateEntityRecognizerInput { - s.DataAccessRoleArn = &v - return s -} +type DescribeEventsDetectionJobOutput struct { + _ struct{} `type:"structure"` -// SetInputDataConfig sets the InputDataConfig field's value. -func (s *CreateEntityRecognizerInput) SetInputDataConfig(v *EntityRecognizerInputDataConfig) *CreateEntityRecognizerInput { - s.InputDataConfig = v - return s + // An object that contains the properties associated with an event detection + // job. + EventsDetectionJobProperties *EventsDetectionJobProperties `type:"structure"` } -// SetLanguageCode sets the LanguageCode field's value. -func (s *CreateEntityRecognizerInput) SetLanguageCode(v string) *CreateEntityRecognizerInput { - s.LanguageCode = &v - return s +// 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 DescribeEventsDetectionJobOutput) String() string { + return awsutil.Prettify(s) } -// SetModelKmsKeyId sets the ModelKmsKeyId field's value. -func (s *CreateEntityRecognizerInput) SetModelKmsKeyId(v string) *CreateEntityRecognizerInput { - s.ModelKmsKeyId = &v - return 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 DescribeEventsDetectionJobOutput) GoString() string { + return s.String() } -// SetModelPolicy sets the ModelPolicy field's value. -func (s *CreateEntityRecognizerInput) SetModelPolicy(v string) *CreateEntityRecognizerInput { - s.ModelPolicy = &v +// SetEventsDetectionJobProperties sets the EventsDetectionJobProperties field's value. +func (s *DescribeEventsDetectionJobOutput) SetEventsDetectionJobProperties(v *EventsDetectionJobProperties) *DescribeEventsDetectionJobOutput { + s.EventsDetectionJobProperties = v return s } -// SetRecognizerName sets the RecognizerName field's value. -func (s *CreateEntityRecognizerInput) SetRecognizerName(v string) *CreateEntityRecognizerInput { - s.RecognizerName = &v - return s +type DescribeFlywheelInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Number (ARN) of the flywheel. + // + // FlywheelArn is a required field + FlywheelArn *string `type:"string" required:"true"` } -// SetTags sets the Tags field's value. -func (s *CreateEntityRecognizerInput) SetTags(v []*Tag) *CreateEntityRecognizerInput { - s.Tags = v - return s +// 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 DescribeFlywheelInput) String() string { + return awsutil.Prettify(s) } -// SetVersionName sets the VersionName field's value. -func (s *CreateEntityRecognizerInput) SetVersionName(v string) *CreateEntityRecognizerInput { - s.VersionName = &v - return 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 DescribeFlywheelInput) GoString() string { + return s.String() } -// SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value. -func (s *CreateEntityRecognizerInput) SetVolumeKmsKeyId(v string) *CreateEntityRecognizerInput { - s.VolumeKmsKeyId = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeFlywheelInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeFlywheelInput"} + if s.FlywheelArn == nil { + invalidParams.Add(request.NewErrParamRequired("FlywheelArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetVpcConfig sets the VpcConfig field's value. -func (s *CreateEntityRecognizerInput) SetVpcConfig(v *VpcConfig) *CreateEntityRecognizerInput { - s.VpcConfig = v +// SetFlywheelArn sets the FlywheelArn field's value. +func (s *DescribeFlywheelInput) SetFlywheelArn(v string) *DescribeFlywheelInput { + s.FlywheelArn = &v return s } -type CreateEntityRecognizerOutput struct { +type DescribeFlywheelIterationInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that identifies the entity recognizer. - EntityRecognizerArn *string `type:"string"` + // FlywheelArn is a required field + FlywheelArn *string `type:"string" required:"true"` + + // FlywheelIterationId is a required field + FlywheelIterationId *string `type:"string" required:"true"` } // String returns the string representation. @@ -10342,7 +13816,7 @@ type CreateEntityRecognizerOutput struct { // 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 CreateEntityRecognizerOutput) String() string { +func (s DescribeFlywheelIterationInput) String() string { return awsutil.Prettify(s) } @@ -10351,23 +13825,43 @@ func (s CreateEntityRecognizerOutput) String() string { // 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 CreateEntityRecognizerOutput) GoString() string { +func (s DescribeFlywheelIterationInput) GoString() string { return s.String() } -// SetEntityRecognizerArn sets the EntityRecognizerArn field's value. -func (s *CreateEntityRecognizerOutput) SetEntityRecognizerArn(v string) *CreateEntityRecognizerOutput { - s.EntityRecognizerArn = &v +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeFlywheelIterationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeFlywheelIterationInput"} + if s.FlywheelArn == nil { + invalidParams.Add(request.NewErrParamRequired("FlywheelArn")) + } + if s.FlywheelIterationId == nil { + invalidParams.Add(request.NewErrParamRequired("FlywheelIterationId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFlywheelArn sets the FlywheelArn field's value. +func (s *DescribeFlywheelIterationInput) SetFlywheelArn(v string) *DescribeFlywheelIterationInput { + s.FlywheelArn = &v return s } -type DeleteDocumentClassifierInput struct { +// SetFlywheelIterationId sets the FlywheelIterationId field's value. +func (s *DescribeFlywheelIterationInput) SetFlywheelIterationId(v string) *DescribeFlywheelIterationInput { + s.FlywheelIterationId = &v + return s +} + +type DescribeFlywheelIterationOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that identifies the document classifier. - // - // DocumentClassifierArn is a required field - DocumentClassifierArn *string `type:"string" required:"true"` + // The configuration properties of a flywheel iteration. + FlywheelIterationProperties *FlywheelIterationProperties `type:"structure"` } // String returns the string representation. @@ -10375,7 +13869,7 @@ type DeleteDocumentClassifierInput struct { // 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 DeleteDocumentClassifierInput) String() string { +func (s DescribeFlywheelIterationOutput) String() string { return awsutil.Prettify(s) } @@ -10384,31 +13878,21 @@ func (s DeleteDocumentClassifierInput) String() string { // 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 DeleteDocumentClassifierInput) GoString() string { +func (s DescribeFlywheelIterationOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteDocumentClassifierInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteDocumentClassifierInput"} - if s.DocumentClassifierArn == nil { - invalidParams.Add(request.NewErrParamRequired("DocumentClassifierArn")) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetDocumentClassifierArn sets the DocumentClassifierArn field's value. -func (s *DeleteDocumentClassifierInput) SetDocumentClassifierArn(v string) *DeleteDocumentClassifierInput { - s.DocumentClassifierArn = &v +// SetFlywheelIterationProperties sets the FlywheelIterationProperties field's value. +func (s *DescribeFlywheelIterationOutput) SetFlywheelIterationProperties(v *FlywheelIterationProperties) *DescribeFlywheelIterationOutput { + s.FlywheelIterationProperties = v return s } -type DeleteDocumentClassifierOutput struct { +type DescribeFlywheelOutput struct { _ struct{} `type:"structure"` + + // The flywheel properties. + FlywheelProperties *FlywheelProperties `type:"structure"` } // String returns the string representation. @@ -10416,7 +13900,7 @@ type DeleteDocumentClassifierOutput struct { // 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 DeleteDocumentClassifierOutput) String() string { +func (s DescribeFlywheelOutput) String() string { return awsutil.Prettify(s) } @@ -10425,17 +13909,24 @@ func (s DeleteDocumentClassifierOutput) String() string { // 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 DeleteDocumentClassifierOutput) GoString() string { +func (s DescribeFlywheelOutput) GoString() string { return s.String() } -type DeleteEndpointInput struct { +// SetFlywheelProperties sets the FlywheelProperties field's value. +func (s *DescribeFlywheelOutput) SetFlywheelProperties(v *FlywheelProperties) *DescribeFlywheelOutput { + s.FlywheelProperties = v + return s +} + +type DescribeKeyPhrasesDetectionJobInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Number (ARN) of the endpoint being deleted. + // The identifier that Amazon Comprehend generated for the job. The StartKeyPhrasesDetectionJob + // operation returns this identifier in its response. // - // EndpointArn is a required field - EndpointArn *string `type:"string" required:"true"` + // JobId is a required field + JobId *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -10443,7 +13934,7 @@ type DeleteEndpointInput struct { // 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 DeleteEndpointInput) String() string { +func (s DescribeKeyPhrasesDetectionJobInput) String() string { return awsutil.Prettify(s) } @@ -10452,15 +13943,18 @@ func (s DeleteEndpointInput) String() string { // 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 DeleteEndpointInput) GoString() string { +func (s DescribeKeyPhrasesDetectionJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteEndpointInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteEndpointInput"} - if s.EndpointArn == nil { - invalidParams.Add(request.NewErrParamRequired("EndpointArn")) +func (s *DescribeKeyPhrasesDetectionJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeKeyPhrasesDetectionJobInput"} + 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 { @@ -10469,14 +13963,18 @@ func (s *DeleteEndpointInput) Validate() error { return nil } -// SetEndpointArn sets the EndpointArn field's value. -func (s *DeleteEndpointInput) SetEndpointArn(v string) *DeleteEndpointInput { - s.EndpointArn = &v +// SetJobId sets the JobId field's value. +func (s *DescribeKeyPhrasesDetectionJobInput) SetJobId(v string) *DescribeKeyPhrasesDetectionJobInput { + s.JobId = &v return s } -type DeleteEndpointOutput struct { +type DescribeKeyPhrasesDetectionJobOutput struct { _ struct{} `type:"structure"` + + // An object that contains the properties associated with a key phrases detection + // job. + KeyPhrasesDetectionJobProperties *KeyPhrasesDetectionJobProperties `type:"structure"` } // String returns the string representation. @@ -10484,7 +13982,7 @@ type DeleteEndpointOutput struct { // 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 DeleteEndpointOutput) String() string { +func (s DescribeKeyPhrasesDetectionJobOutput) String() string { return awsutil.Prettify(s) } @@ -10493,17 +13991,24 @@ func (s DeleteEndpointOutput) String() string { // 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 DeleteEndpointOutput) GoString() string { +func (s DescribeKeyPhrasesDetectionJobOutput) GoString() string { return s.String() } -type DeleteEntityRecognizerInput struct { +// SetKeyPhrasesDetectionJobProperties sets the KeyPhrasesDetectionJobProperties field's value. +func (s *DescribeKeyPhrasesDetectionJobOutput) SetKeyPhrasesDetectionJobProperties(v *KeyPhrasesDetectionJobProperties) *DescribeKeyPhrasesDetectionJobOutput { + s.KeyPhrasesDetectionJobProperties = v + return s +} + +type DescribePiiEntitiesDetectionJobInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that identifies the entity recognizer. + // The identifier that Amazon Comprehend generated for the job. The operation + // returns this identifier in its response. // - // EntityRecognizerArn is a required field - EntityRecognizerArn *string `type:"string" required:"true"` + // JobId is a required field + JobId *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -10511,7 +14016,7 @@ type DeleteEntityRecognizerInput struct { // 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 DeleteEntityRecognizerInput) String() string { +func (s DescribePiiEntitiesDetectionJobInput) String() string { return awsutil.Prettify(s) } @@ -10520,15 +14025,18 @@ func (s DeleteEntityRecognizerInput) String() string { // 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 DeleteEntityRecognizerInput) GoString() string { +func (s DescribePiiEntitiesDetectionJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteEntityRecognizerInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteEntityRecognizerInput"} - if s.EntityRecognizerArn == nil { - invalidParams.Add(request.NewErrParamRequired("EntityRecognizerArn")) +func (s *DescribePiiEntitiesDetectionJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribePiiEntitiesDetectionJobInput"} + 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 { @@ -10537,14 +14045,17 @@ func (s *DeleteEntityRecognizerInput) Validate() error { return nil } -// SetEntityRecognizerArn sets the EntityRecognizerArn field's value. -func (s *DeleteEntityRecognizerInput) SetEntityRecognizerArn(v string) *DeleteEntityRecognizerInput { - s.EntityRecognizerArn = &v +// SetJobId sets the JobId field's value. +func (s *DescribePiiEntitiesDetectionJobInput) SetJobId(v string) *DescribePiiEntitiesDetectionJobInput { + s.JobId = &v return s } -type DeleteEntityRecognizerOutput struct { +type DescribePiiEntitiesDetectionJobOutput struct { _ struct{} `type:"structure"` + + // Provides information about a PII entities detection job. + PiiEntitiesDetectionJobProperties *PiiEntitiesDetectionJobProperties `type:"structure"` } // String returns the string representation. @@ -10552,7 +14063,7 @@ type DeleteEntityRecognizerOutput struct { // 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 DeleteEntityRecognizerOutput) String() string { +func (s DescribePiiEntitiesDetectionJobOutput) String() string { return awsutil.Prettify(s) } @@ -10561,18 +14072,21 @@ func (s DeleteEntityRecognizerOutput) String() string { // 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 DeleteEntityRecognizerOutput) GoString() string { +func (s DescribePiiEntitiesDetectionJobOutput) GoString() string { return s.String() } -type DeleteResourcePolicyInput struct { +// SetPiiEntitiesDetectionJobProperties sets the PiiEntitiesDetectionJobProperties field's value. +func (s *DescribePiiEntitiesDetectionJobOutput) SetPiiEntitiesDetectionJobProperties(v *PiiEntitiesDetectionJobProperties) *DescribePiiEntitiesDetectionJobOutput { + s.PiiEntitiesDetectionJobProperties = v + return s +} + +type DescribeResourcePolicyInput struct { _ struct{} `type:"structure"` - // The revision ID of the policy to delete. - PolicyRevisionId *string `type:"string"` - - // The Amazon Resource Name (ARN) of the custom model version that has the policy - // to delete. + // The Amazon Resource Name (ARN) of the custom model version that has the resource + // policy. // // ResourceArn is a required field ResourceArn *string `type:"string" required:"true"` @@ -10583,7 +14097,7 @@ type DeleteResourcePolicyInput struct { // 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 DeleteResourcePolicyInput) String() string { +func (s DescribeResourcePolicyInput) String() string { return awsutil.Prettify(s) } @@ -10592,13 +14106,13 @@ func (s DeleteResourcePolicyInput) String() string { // 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 DeleteResourcePolicyInput) GoString() string { +func (s DescribeResourcePolicyInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteResourcePolicyInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteResourcePolicyInput"} +func (s *DescribeResourcePolicyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeResourcePolicyInput"} if s.ResourceArn == nil { invalidParams.Add(request.NewErrParamRequired("ResourceArn")) } @@ -10609,20 +14123,27 @@ func (s *DeleteResourcePolicyInput) Validate() error { return nil } -// SetPolicyRevisionId sets the PolicyRevisionId field's value. -func (s *DeleteResourcePolicyInput) SetPolicyRevisionId(v string) *DeleteResourcePolicyInput { - s.PolicyRevisionId = &v - return s -} - // SetResourceArn sets the ResourceArn field's value. -func (s *DeleteResourcePolicyInput) SetResourceArn(v string) *DeleteResourcePolicyInput { +func (s *DescribeResourcePolicyInput) SetResourceArn(v string) *DescribeResourcePolicyInput { s.ResourceArn = &v return s } -type DeleteResourcePolicyOutput struct { +type DescribeResourcePolicyOutput struct { _ struct{} `type:"structure"` + + // The time at which the policy was created. + CreationTime *time.Time `type:"timestamp"` + + // The time at which the policy was last modified. + LastModifiedTime *time.Time `type:"timestamp"` + + // The revision ID of the policy. Each time you modify a policy, Amazon Comprehend + // assigns a new revision ID, and it deletes the prior version of the policy. + PolicyRevisionId *string `type:"string"` + + // The JSON body of the resource-based policy. + ResourcePolicy *string `min:"1" type:"string"` } // String returns the string representation. @@ -10630,7 +14151,7 @@ type DeleteResourcePolicyOutput struct { // 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 DeleteResourcePolicyOutput) String() string { +func (s DescribeResourcePolicyOutput) String() string { return awsutil.Prettify(s) } @@ -10639,11 +14160,35 @@ func (s DeleteResourcePolicyOutput) String() string { // 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 DeleteResourcePolicyOutput) GoString() string { +func (s DescribeResourcePolicyOutput) GoString() string { return s.String() } -type DescribeDocumentClassificationJobInput struct { +// SetCreationTime sets the CreationTime field's value. +func (s *DescribeResourcePolicyOutput) SetCreationTime(v time.Time) *DescribeResourcePolicyOutput { + s.CreationTime = &v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *DescribeResourcePolicyOutput) SetLastModifiedTime(v time.Time) *DescribeResourcePolicyOutput { + s.LastModifiedTime = &v + return s +} + +// SetPolicyRevisionId sets the PolicyRevisionId field's value. +func (s *DescribeResourcePolicyOutput) SetPolicyRevisionId(v string) *DescribeResourcePolicyOutput { + s.PolicyRevisionId = &v + return s +} + +// SetResourcePolicy sets the ResourcePolicy field's value. +func (s *DescribeResourcePolicyOutput) SetResourcePolicy(v string) *DescribeResourcePolicyOutput { + s.ResourcePolicy = &v + return s +} + +type DescribeSentimentDetectionJobInput struct { _ struct{} `type:"structure"` // The identifier that Amazon Comprehend generated for the job. The operation @@ -10658,7 +14203,7 @@ type DescribeDocumentClassificationJobInput struct { // 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 DescribeDocumentClassificationJobInput) String() string { +func (s DescribeSentimentDetectionJobInput) String() string { return awsutil.Prettify(s) } @@ -10667,13 +14212,13 @@ func (s DescribeDocumentClassificationJobInput) String() string { // 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 DescribeDocumentClassificationJobInput) GoString() string { +func (s DescribeSentimentDetectionJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeDocumentClassificationJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeDocumentClassificationJobInput"} +func (s *DescribeSentimentDetectionJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeSentimentDetectionJobInput"} if s.JobId == nil { invalidParams.Add(request.NewErrParamRequired("JobId")) } @@ -10688,17 +14233,17 @@ func (s *DescribeDocumentClassificationJobInput) Validate() error { } // SetJobId sets the JobId field's value. -func (s *DescribeDocumentClassificationJobInput) SetJobId(v string) *DescribeDocumentClassificationJobInput { +func (s *DescribeSentimentDetectionJobInput) SetJobId(v string) *DescribeSentimentDetectionJobInput { s.JobId = &v return s } -type DescribeDocumentClassificationJobOutput struct { +type DescribeSentimentDetectionJobOutput struct { _ struct{} `type:"structure"` - // An object that describes the properties associated with the document classification + // An object that contains the properties associated with a sentiment detection // job. - DocumentClassificationJobProperties *DocumentClassificationJobProperties `type:"structure"` + SentimentDetectionJobProperties *SentimentDetectionJobProperties `type:"structure"` } // String returns the string representation. @@ -10706,7 +14251,7 @@ type DescribeDocumentClassificationJobOutput struct { // 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 DescribeDocumentClassificationJobOutput) String() string { +func (s DescribeSentimentDetectionJobOutput) String() string { return awsutil.Prettify(s) } @@ -10715,24 +14260,24 @@ func (s DescribeDocumentClassificationJobOutput) String() string { // 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 DescribeDocumentClassificationJobOutput) GoString() string { +func (s DescribeSentimentDetectionJobOutput) GoString() string { return s.String() } -// SetDocumentClassificationJobProperties sets the DocumentClassificationJobProperties field's value. -func (s *DescribeDocumentClassificationJobOutput) SetDocumentClassificationJobProperties(v *DocumentClassificationJobProperties) *DescribeDocumentClassificationJobOutput { - s.DocumentClassificationJobProperties = v +// SetSentimentDetectionJobProperties sets the SentimentDetectionJobProperties field's value. +func (s *DescribeSentimentDetectionJobOutput) SetSentimentDetectionJobProperties(v *SentimentDetectionJobProperties) *DescribeSentimentDetectionJobOutput { + s.SentimentDetectionJobProperties = v return s } -type DescribeDocumentClassifierInput struct { +type DescribeTargetedSentimentDetectionJobInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that identifies the document classifier. The + // The identifier that Amazon Comprehend generated for the job. The StartTargetedSentimentDetectionJob // operation returns this identifier in its response. // - // DocumentClassifierArn is a required field - DocumentClassifierArn *string `type:"string" required:"true"` + // JobId is a required field + JobId *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -10740,7 +14285,7 @@ type DescribeDocumentClassifierInput struct { // 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 DescribeDocumentClassifierInput) String() string { +func (s DescribeTargetedSentimentDetectionJobInput) String() string { return awsutil.Prettify(s) } @@ -10749,15 +14294,18 @@ func (s DescribeDocumentClassifierInput) String() string { // 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 DescribeDocumentClassifierInput) GoString() string { +func (s DescribeTargetedSentimentDetectionJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeDocumentClassifierInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeDocumentClassifierInput"} - if s.DocumentClassifierArn == nil { - invalidParams.Add(request.NewErrParamRequired("DocumentClassifierArn")) +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 { @@ -10766,17 +14314,18 @@ func (s *DescribeDocumentClassifierInput) Validate() error { return nil } -// SetDocumentClassifierArn sets the DocumentClassifierArn field's value. -func (s *DescribeDocumentClassifierInput) SetDocumentClassifierArn(v string) *DescribeDocumentClassifierInput { - s.DocumentClassifierArn = &v +// SetJobId sets the JobId field's value. +func (s *DescribeTargetedSentimentDetectionJobInput) SetJobId(v string) *DescribeTargetedSentimentDetectionJobInput { + s.JobId = &v return s } -type DescribeDocumentClassifierOutput struct { +type DescribeTargetedSentimentDetectionJobOutput struct { _ struct{} `type:"structure"` - // An object that contains the properties associated with a document classifier. - DocumentClassifierProperties *DocumentClassifierProperties `type:"structure"` + // An object that contains the properties associated with a targeted sentiment + // detection job. + TargetedSentimentDetectionJobProperties *TargetedSentimentDetectionJobProperties `type:"structure"` } // String returns the string representation. @@ -10784,7 +14333,7 @@ type DescribeDocumentClassifierOutput struct { // 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 DescribeDocumentClassifierOutput) String() string { +func (s DescribeTargetedSentimentDetectionJobOutput) String() string { return awsutil.Prettify(s) } @@ -10793,21 +14342,20 @@ func (s DescribeDocumentClassifierOutput) String() string { // 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 DescribeDocumentClassifierOutput) GoString() string { +func (s DescribeTargetedSentimentDetectionJobOutput) GoString() string { return s.String() } -// SetDocumentClassifierProperties sets the DocumentClassifierProperties field's value. -func (s *DescribeDocumentClassifierOutput) SetDocumentClassifierProperties(v *DocumentClassifierProperties) *DescribeDocumentClassifierOutput { - s.DocumentClassifierProperties = v +// SetTargetedSentimentDetectionJobProperties sets the TargetedSentimentDetectionJobProperties field's value. +func (s *DescribeTargetedSentimentDetectionJobOutput) SetTargetedSentimentDetectionJobProperties(v *TargetedSentimentDetectionJobProperties) *DescribeTargetedSentimentDetectionJobOutput { + s.TargetedSentimentDetectionJobProperties = v return s } -type DescribeDominantLanguageDetectionJobInput struct { +type DescribeTopicsDetectionJobInput struct { _ struct{} `type:"structure"` - // The identifier that Amazon Comprehend generated for the job. The operation - // returns this identifier in its response. + // The identifier assigned by the user to the detection job. // // JobId is a required field JobId *string `min:"1" type:"string" required:"true"` @@ -10818,7 +14366,7 @@ type DescribeDominantLanguageDetectionJobInput struct { // 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 DescribeDominantLanguageDetectionJobInput) String() string { +func (s DescribeTopicsDetectionJobInput) String() string { return awsutil.Prettify(s) } @@ -10827,13 +14375,13 @@ func (s DescribeDominantLanguageDetectionJobInput) String() string { // 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 DescribeDominantLanguageDetectionJobInput) GoString() string { +func (s DescribeTopicsDetectionJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeDominantLanguageDetectionJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeDominantLanguageDetectionJobInput"} +func (s *DescribeTopicsDetectionJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeTopicsDetectionJobInput"} if s.JobId == nil { invalidParams.Add(request.NewErrParamRequired("JobId")) } @@ -10848,17 +14396,16 @@ func (s *DescribeDominantLanguageDetectionJobInput) Validate() error { } // SetJobId sets the JobId field's value. -func (s *DescribeDominantLanguageDetectionJobInput) SetJobId(v string) *DescribeDominantLanguageDetectionJobInput { +func (s *DescribeTopicsDetectionJobInput) SetJobId(v string) *DescribeTopicsDetectionJobInput { s.JobId = &v return s } -type DescribeDominantLanguageDetectionJobOutput struct { +type DescribeTopicsDetectionJobOutput struct { _ struct{} `type:"structure"` - // An object that contains the properties associated with a dominant language - // detection job. - DominantLanguageDetectionJobProperties *DominantLanguageDetectionJobProperties `type:"structure"` + // The list of properties for the requested job. + TopicsDetectionJobProperties *TopicsDetectionJobProperties `type:"structure"` } // String returns the string representation. @@ -10866,7 +14413,7 @@ type DescribeDominantLanguageDetectionJobOutput struct { // 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 DescribeDominantLanguageDetectionJobOutput) String() string { +func (s DescribeTopicsDetectionJobOutput) String() string { return awsutil.Prettify(s) } @@ -10875,23 +14422,28 @@ func (s DescribeDominantLanguageDetectionJobOutput) String() string { // 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 DescribeDominantLanguageDetectionJobOutput) GoString() string { +func (s DescribeTopicsDetectionJobOutput) GoString() string { return s.String() } -// SetDominantLanguageDetectionJobProperties sets the DominantLanguageDetectionJobProperties field's value. -func (s *DescribeDominantLanguageDetectionJobOutput) SetDominantLanguageDetectionJobProperties(v *DominantLanguageDetectionJobProperties) *DescribeDominantLanguageDetectionJobOutput { - s.DominantLanguageDetectionJobProperties = v +// SetTopicsDetectionJobProperties sets the TopicsDetectionJobProperties field's value. +func (s *DescribeTopicsDetectionJobOutput) SetTopicsDetectionJobProperties(v *TopicsDetectionJobProperties) *DescribeTopicsDetectionJobOutput { + s.TopicsDetectionJobProperties = v return s } -type DescribeEndpointInput struct { +type DetectDominantLanguageInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Number (ARN) of the endpoint being described. + // A UTF-8 text string. The string must contain at least 20 characters. The + // maximum string size is 100 KB. // - // EndpointArn is a required field - EndpointArn *string `type:"string" required:"true"` + // Text is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DetectDominantLanguageInput's + // String and GoString methods. + // + // Text is a required field + Text *string `min:"1" type:"string" required:"true" sensitive:"true"` } // String returns the string representation. @@ -10899,7 +14451,7 @@ type DescribeEndpointInput struct { // 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 DescribeEndpointInput) String() string { +func (s DetectDominantLanguageInput) String() string { return awsutil.Prettify(s) } @@ -10908,15 +14460,18 @@ func (s DescribeEndpointInput) String() string { // 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 DescribeEndpointInput) GoString() string { +func (s DetectDominantLanguageInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeEndpointInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeEndpointInput"} - if s.EndpointArn == nil { - invalidParams.Add(request.NewErrParamRequired("EndpointArn")) +func (s *DetectDominantLanguageInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DetectDominantLanguageInput"} + if s.Text == nil { + invalidParams.Add(request.NewErrParamRequired("Text")) + } + if s.Text != nil && len(*s.Text) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Text", 1)) } if invalidParams.Len() > 0 { @@ -10925,17 +14480,21 @@ func (s *DescribeEndpointInput) Validate() error { return nil } -// SetEndpointArn sets the EndpointArn field's value. -func (s *DescribeEndpointInput) SetEndpointArn(v string) *DescribeEndpointInput { - s.EndpointArn = &v +// SetText sets the Text field's value. +func (s *DetectDominantLanguageInput) SetText(v string) *DetectDominantLanguageInput { + s.Text = &v return s } -type DescribeEndpointOutput struct { - _ struct{} `type:"structure"` +type DetectDominantLanguageOutput struct { + _ struct{} `type:"structure" sensitive:"true"` - // Describes information associated with the specific endpoint. - EndpointProperties *EndpointProperties `type:"structure"` + // The languages that Amazon Comprehend detected in the input text. For each + // language, the response returns the RFC 5646 language code and the level of + // confidence that Amazon Comprehend has in the accuracy of its inference. For + // more information about RFC 5646, see Tags for Identifying Languages (https://tools.ietf.org/html/rfc5646) + // on the IETF Tools web site. + Languages []*DominantLanguage `type:"list"` } // String returns the string representation. @@ -10943,7 +14502,7 @@ type DescribeEndpointOutput struct { // 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 DescribeEndpointOutput) String() string { +func (s DetectDominantLanguageOutput) String() string { return awsutil.Prettify(s) } @@ -10952,24 +14511,72 @@ func (s DescribeEndpointOutput) String() string { // 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 DescribeEndpointOutput) GoString() string { +func (s DetectDominantLanguageOutput) GoString() string { return s.String() } -// SetEndpointProperties sets the EndpointProperties field's value. -func (s *DescribeEndpointOutput) SetEndpointProperties(v *EndpointProperties) *DescribeEndpointOutput { - s.EndpointProperties = v +// SetLanguages sets the Languages field's value. +func (s *DetectDominantLanguageOutput) SetLanguages(v []*DominantLanguage) *DetectDominantLanguageOutput { + s.Languages = v return s } -type DescribeEntitiesDetectionJobInput struct { - _ struct{} `type:"structure"` +type DetectEntitiesInput struct { + _ struct{} `type:"structure"` + + // This field applies only when you use a custom entity recognition model that + // was trained with PDF annotations. For other cases, enter your text input + // in the Text field. + // + // Use the Bytes parameter to input a text, PDF, Word or image file. Using a + // plain-text file in the Bytes parameter is equivelent to using the Text parameter + // (the Entities field in the response is identical). + // + // You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText + // or AnalyzeDocument output file. + // + // Provide the input document as a sequence of base64-encoded bytes. If your + // code uses an Amazon Web Services SDK to detect entities, the SDK may encode + // the document file bytes for you. + // + // The maximum length of this field depends on the input document type. For + // details, see Inputs for real-time custom analysis (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html) + // in the Comprehend Developer Guide. + // + // If you use the Bytes parameter, do not use the Text parameter. + // Bytes is automatically base64 encoded/decoded by the SDK. + Bytes []byte `min:"1" type:"blob"` + + // Provides configuration parameters to override the default actions for extracting + // text from PDF documents and image files. + DocumentReaderConfig *DocumentReaderConfig `type:"structure"` + + // The Amazon Resource Name of an endpoint that is associated with a custom + // entity recognition model. Provide an endpoint if you want to detect entities + // by using your own custom model instead of the default model that is used + // by Amazon Comprehend. + // + // If you specify an endpoint, Amazon Comprehend uses the language of your custom + // model, and it ignores any language code that you provide in your request. + // + // For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). + EndpointArn *string `type:"string"` - // The identifier that Amazon Comprehend generated for the job. The operation - // returns this identifier in its response. + // The language of the input documents. You can specify any of the primary languages + // supported by Amazon Comprehend. If your request includes the endpoint for + // a custom entity recognition model, Amazon Comprehend uses the language of + // your custom model, and it ignores any language code that you specify here. // - // JobId is a required field - JobId *string `min:"1" type:"string" required:"true"` + // All input documents must be in the same language. + LanguageCode *string `type:"string" enum:"LanguageCode"` + + // A UTF-8 text string. The maximum string size is 100 KB. If you enter text + // using this parameter, do not use the Bytes parameter. + // + // Text is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DetectEntitiesInput's + // String and GoString methods. + Text *string `min:"1" type:"string" sensitive:"true"` } // String returns the string representation. @@ -10977,7 +14584,7 @@ type DescribeEntitiesDetectionJobInput struct { // 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 DescribeEntitiesDetectionJobInput) String() string { +func (s DetectEntitiesInput) String() string { return awsutil.Prettify(s) } @@ -10986,18 +14593,23 @@ func (s DescribeEntitiesDetectionJobInput) String() string { // 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 DescribeEntitiesDetectionJobInput) GoString() string { +func (s DetectEntitiesInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeEntitiesDetectionJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeEntitiesDetectionJobInput"} - if s.JobId == nil { - invalidParams.Add(request.NewErrParamRequired("JobId")) +func (s *DetectEntitiesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DetectEntitiesInput"} + if s.Bytes != nil && len(s.Bytes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Bytes", 1)) } - if s.JobId != nil && len(*s.JobId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) + if s.Text != nil && len(*s.Text) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Text", 1)) + } + if s.DocumentReaderConfig != nil { + if err := s.DocumentReaderConfig.Validate(); err != nil { + invalidParams.AddNested("DocumentReaderConfig", err.(request.ErrInvalidParams)) + } } if invalidParams.Len() > 0 { @@ -11006,18 +14618,70 @@ func (s *DescribeEntitiesDetectionJobInput) Validate() error { return nil } -// SetJobId sets the JobId field's value. -func (s *DescribeEntitiesDetectionJobInput) SetJobId(v string) *DescribeEntitiesDetectionJobInput { - s.JobId = &v +// SetBytes sets the Bytes field's value. +func (s *DetectEntitiesInput) SetBytes(v []byte) *DetectEntitiesInput { + s.Bytes = v return s } -type DescribeEntitiesDetectionJobOutput struct { - _ struct{} `type:"structure"` +// SetDocumentReaderConfig sets the DocumentReaderConfig field's value. +func (s *DetectEntitiesInput) SetDocumentReaderConfig(v *DocumentReaderConfig) *DetectEntitiesInput { + s.DocumentReaderConfig = v + return s +} - // An object that contains the properties associated with an entities detection - // job. - EntitiesDetectionJobProperties *EntitiesDetectionJobProperties `type:"structure"` +// SetEndpointArn sets the EndpointArn field's value. +func (s *DetectEntitiesInput) SetEndpointArn(v string) *DetectEntitiesInput { + s.EndpointArn = &v + return s +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *DetectEntitiesInput) SetLanguageCode(v string) *DetectEntitiesInput { + s.LanguageCode = &v + return s +} + +// SetText sets the Text field's value. +func (s *DetectEntitiesInput) SetText(v string) *DetectEntitiesInput { + s.Text = &v + return s +} + +type DetectEntitiesOutput struct { + _ struct{} `type:"structure" sensitive:"true"` + + // Information about each block of text in the input document. Blocks are nested. + // A page block contains a block for each line of text, which contains a block + // for each word. + // + // The Block content for a Word input document does not include a Geometry field. + // + // The Block field is not present in the response for plain-text inputs. + Blocks []*Block `type:"list"` + + // Information about the document, discovered during text extraction. This field + // is present in the response only if your request used the Byte parameter. + DocumentMetadata *DocumentMetadata `type:"structure"` + + // The document type for each page in the input document. This field is present + // in the response only if your request used the Byte parameter. + DocumentType []*DocumentTypeListItem `type:"list"` + + // A collection of entities identified in the input text. For each entity, the + // response provides the entity text, entity type, where the entity text begins + // and ends, and the level of confidence that Amazon Comprehend has in the detection. + // + // If your request uses a custom entity recognition model, Amazon Comprehend + // detects the entities that the model is trained to recognize. Otherwise, it + // detects the default entity types. For a list of default entity types, see + // Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) + // in the Comprehend Developer Guide. + Entities []*Entity `type:"list"` + + // Page-level errors that the system detected while processing the input document. + // The field is empty if the system encountered no errors. + Errors []*ErrorsListItem `type:"list"` } // String returns the string representation. @@ -11025,7 +14689,7 @@ type DescribeEntitiesDetectionJobOutput struct { // 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 DescribeEntitiesDetectionJobOutput) String() string { +func (s DetectEntitiesOutput) String() string { return awsutil.Prettify(s) } @@ -11034,23 +14698,58 @@ func (s DescribeEntitiesDetectionJobOutput) String() string { // 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 DescribeEntitiesDetectionJobOutput) GoString() string { +func (s DetectEntitiesOutput) GoString() string { return s.String() } -// SetEntitiesDetectionJobProperties sets the EntitiesDetectionJobProperties field's value. -func (s *DescribeEntitiesDetectionJobOutput) SetEntitiesDetectionJobProperties(v *EntitiesDetectionJobProperties) *DescribeEntitiesDetectionJobOutput { - s.EntitiesDetectionJobProperties = v +// SetBlocks sets the Blocks field's value. +func (s *DetectEntitiesOutput) SetBlocks(v []*Block) *DetectEntitiesOutput { + s.Blocks = v return s } -type DescribeEntityRecognizerInput struct { +// SetDocumentMetadata sets the DocumentMetadata field's value. +func (s *DetectEntitiesOutput) SetDocumentMetadata(v *DocumentMetadata) *DetectEntitiesOutput { + s.DocumentMetadata = v + return s +} + +// SetDocumentType sets the DocumentType field's value. +func (s *DetectEntitiesOutput) SetDocumentType(v []*DocumentTypeListItem) *DetectEntitiesOutput { + s.DocumentType = v + return s +} + +// SetEntities sets the Entities field's value. +func (s *DetectEntitiesOutput) SetEntities(v []*Entity) *DetectEntitiesOutput { + s.Entities = v + return s +} + +// SetErrors sets the Errors field's value. +func (s *DetectEntitiesOutput) SetErrors(v []*ErrorsListItem) *DetectEntitiesOutput { + s.Errors = v + return s +} + +type DetectKeyPhrasesInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that identifies the entity recognizer. + // 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. // - // EntityRecognizerArn is a required field - EntityRecognizerArn *string `type:"string" required:"true"` + // LanguageCode is a required field + LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` + + // A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded + // characters. + // + // Text is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DetectKeyPhrasesInput's + // String and GoString methods. + // + // Text is a required field + Text *string `min:"1" type:"string" required:"true" sensitive:"true"` } // String returns the string representation. @@ -11058,7 +14757,7 @@ type DescribeEntityRecognizerInput struct { // 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 DescribeEntityRecognizerInput) String() string { +func (s DetectKeyPhrasesInput) String() string { return awsutil.Prettify(s) } @@ -11067,15 +14766,21 @@ func (s DescribeEntityRecognizerInput) String() string { // 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 DescribeEntityRecognizerInput) GoString() string { +func (s DetectKeyPhrasesInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeEntityRecognizerInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeEntityRecognizerInput"} - if s.EntityRecognizerArn == nil { - invalidParams.Add(request.NewErrParamRequired("EntityRecognizerArn")) +func (s *DetectKeyPhrasesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DetectKeyPhrasesInput"} + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) + } + if s.Text == nil { + invalidParams.Add(request.NewErrParamRequired("Text")) + } + if s.Text != nil && len(*s.Text) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Text", 1)) } if invalidParams.Len() > 0 { @@ -11084,17 +14789,26 @@ func (s *DescribeEntityRecognizerInput) Validate() error { return nil } -// SetEntityRecognizerArn sets the EntityRecognizerArn field's value. -func (s *DescribeEntityRecognizerInput) SetEntityRecognizerArn(v string) *DescribeEntityRecognizerInput { - s.EntityRecognizerArn = &v +// SetLanguageCode sets the LanguageCode field's value. +func (s *DetectKeyPhrasesInput) SetLanguageCode(v string) *DetectKeyPhrasesInput { + s.LanguageCode = &v return s } -type DescribeEntityRecognizerOutput struct { - _ struct{} `type:"structure"` +// SetText sets the Text field's value. +func (s *DetectKeyPhrasesInput) SetText(v string) *DetectKeyPhrasesInput { + s.Text = &v + return s +} - // Describes information associated with an entity recognizer. - EntityRecognizerProperties *EntityRecognizerProperties `type:"structure"` +type DetectKeyPhrasesOutput struct { + _ struct{} `type:"structure" sensitive:"true"` + + // A collection of key phrases that Amazon Comprehend identified in the input + // text. For each key phrase, the response provides the text of the key phrase, + // where the key phrase begins and ends, and the level of confidence that Amazon + // Comprehend has in the accuracy of the detection. + KeyPhrases []*KeyPhrase `type:"list"` } // String returns the string representation. @@ -11102,7 +14816,7 @@ type DescribeEntityRecognizerOutput struct { // 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 DescribeEntityRecognizerOutput) String() string { +func (s DetectKeyPhrasesOutput) String() string { return awsutil.Prettify(s) } @@ -11111,23 +14825,29 @@ func (s DescribeEntityRecognizerOutput) String() string { // 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 DescribeEntityRecognizerOutput) GoString() string { +func (s DetectKeyPhrasesOutput) GoString() string { return s.String() } -// SetEntityRecognizerProperties sets the EntityRecognizerProperties field's value. -func (s *DescribeEntityRecognizerOutput) SetEntityRecognizerProperties(v *EntityRecognizerProperties) *DescribeEntityRecognizerOutput { - s.EntityRecognizerProperties = v +// SetKeyPhrases sets the KeyPhrases field's value. +func (s *DetectKeyPhrasesOutput) SetKeyPhrases(v []*KeyPhrase) *DetectKeyPhrasesOutput { + s.KeyPhrases = v return s } -type DescribeEventsDetectionJobInput struct { +type DetectPiiEntitiesInput struct { _ struct{} `type:"structure"` - // The identifier of the events detection job. + // The language of the input documents. Currently, English is the only valid + // language. // - // JobId is a required field - JobId *string `min:"1" type:"string" required:"true"` + // LanguageCode is a required field + LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` + + // A UTF-8 text string. The maximum string size is 100 KB. + // + // Text is a required field + Text *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -11135,7 +14855,7 @@ type DescribeEventsDetectionJobInput struct { // 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 DescribeEventsDetectionJobInput) String() string { +func (s DetectPiiEntitiesInput) String() string { return awsutil.Prettify(s) } @@ -11144,18 +14864,21 @@ func (s DescribeEventsDetectionJobInput) String() string { // 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 DescribeEventsDetectionJobInput) GoString() string { +func (s DetectPiiEntitiesInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeEventsDetectionJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeEventsDetectionJobInput"} - if s.JobId == nil { - invalidParams.Add(request.NewErrParamRequired("JobId")) +func (s *DetectPiiEntitiesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DetectPiiEntitiesInput"} + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) } - if s.JobId != nil && len(*s.JobId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) + if s.Text == nil { + invalidParams.Add(request.NewErrParamRequired("Text")) + } + if s.Text != nil && len(*s.Text) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Text", 1)) } if invalidParams.Len() > 0 { @@ -11164,18 +14887,25 @@ func (s *DescribeEventsDetectionJobInput) Validate() error { return nil } -// SetJobId sets the JobId field's value. -func (s *DescribeEventsDetectionJobInput) SetJobId(v string) *DescribeEventsDetectionJobInput { - s.JobId = &v +// SetLanguageCode sets the LanguageCode field's value. +func (s *DetectPiiEntitiesInput) SetLanguageCode(v string) *DetectPiiEntitiesInput { + s.LanguageCode = &v return s } -type DescribeEventsDetectionJobOutput struct { +// SetText sets the Text field's value. +func (s *DetectPiiEntitiesInput) SetText(v string) *DetectPiiEntitiesInput { + s.Text = &v + return s +} + +type DetectPiiEntitiesOutput struct { _ struct{} `type:"structure"` - // An object that contains the properties associated with an event detection - // job. - EventsDetectionJobProperties *EventsDetectionJobProperties `type:"structure"` + // A collection of PII entities identified in the input text. For each entity, + // the response provides the entity type, where the entity text begins and ends, + // and the level of confidence that Amazon Comprehend has in the detection. + Entities []*PiiEntity `type:"list"` } // String returns the string representation. @@ -11183,7 +14913,7 @@ type DescribeEventsDetectionJobOutput struct { // 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 DescribeEventsDetectionJobOutput) String() string { +func (s DetectPiiEntitiesOutput) String() string { return awsutil.Prettify(s) } @@ -11192,24 +14922,36 @@ func (s DescribeEventsDetectionJobOutput) String() string { // 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 DescribeEventsDetectionJobOutput) GoString() string { +func (s DetectPiiEntitiesOutput) GoString() string { return s.String() } -// SetEventsDetectionJobProperties sets the EventsDetectionJobProperties field's value. -func (s *DescribeEventsDetectionJobOutput) SetEventsDetectionJobProperties(v *EventsDetectionJobProperties) *DescribeEventsDetectionJobOutput { - s.EventsDetectionJobProperties = v +// SetEntities sets the Entities field's value. +func (s *DetectPiiEntitiesOutput) SetEntities(v []*PiiEntity) *DetectPiiEntitiesOutput { + s.Entities = v return s } -type DescribeKeyPhrasesDetectionJobInput struct { +type DetectSentimentInput struct { _ struct{} `type:"structure"` - // The identifier that Amazon Comprehend generated for the job. The operation - // returns this identifier in its response. + // 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. // - // JobId is a required field - JobId *string `min:"1" type:"string" required:"true"` + // LanguageCode is a required field + LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` + + // A UTF-8 text string. The maximum string size is 5 KB. + // + // Amazon Comprehend performs real-time sentiment analysis on the first 500 + // characters of the input text and ignores any additional text in the input. + // + // Text is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DetectSentimentInput's + // String and GoString methods. + // + // Text is a required field + Text *string `min:"1" type:"string" required:"true" sensitive:"true"` } // String returns the string representation. @@ -11217,7 +14959,7 @@ type DescribeKeyPhrasesDetectionJobInput struct { // 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 DescribeKeyPhrasesDetectionJobInput) String() string { +func (s DetectSentimentInput) String() string { return awsutil.Prettify(s) } @@ -11226,18 +14968,21 @@ func (s DescribeKeyPhrasesDetectionJobInput) String() string { // 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 DescribeKeyPhrasesDetectionJobInput) GoString() string { +func (s DetectSentimentInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeKeyPhrasesDetectionJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeKeyPhrasesDetectionJobInput"} - if s.JobId == nil { - invalidParams.Add(request.NewErrParamRequired("JobId")) +func (s *DetectSentimentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DetectSentimentInput"} + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) } - if s.JobId != nil && len(*s.JobId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) + if s.Text == nil { + invalidParams.Add(request.NewErrParamRequired("Text")) + } + if s.Text != nil && len(*s.Text) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Text", 1)) } if invalidParams.Len() > 0 { @@ -11246,18 +14991,27 @@ func (s *DescribeKeyPhrasesDetectionJobInput) Validate() error { return nil } -// SetJobId sets the JobId field's value. -func (s *DescribeKeyPhrasesDetectionJobInput) SetJobId(v string) *DescribeKeyPhrasesDetectionJobInput { - s.JobId = &v +// SetLanguageCode sets the LanguageCode field's value. +func (s *DetectSentimentInput) SetLanguageCode(v string) *DetectSentimentInput { + s.LanguageCode = &v return s } -type DescribeKeyPhrasesDetectionJobOutput struct { - _ struct{} `type:"structure"` +// SetText sets the Text field's value. +func (s *DetectSentimentInput) SetText(v string) *DetectSentimentInput { + s.Text = &v + return s +} - // An object that contains the properties associated with a key phrases detection - // job. - KeyPhrasesDetectionJobProperties *KeyPhrasesDetectionJobProperties `type:"structure"` +type DetectSentimentOutput struct { + _ struct{} `type:"structure" sensitive:"true"` + + // The inferred sentiment that Amazon Comprehend has the highest level of confidence + // in. + Sentiment *string `type:"string" enum:"SentimentType"` + + // An object that lists the sentiments, and their corresponding confidence levels. + SentimentScore *SentimentScore `type:"structure"` } // String returns the string representation. @@ -11265,7 +15019,7 @@ type DescribeKeyPhrasesDetectionJobOutput struct { // 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 DescribeKeyPhrasesDetectionJobOutput) String() string { +func (s DetectSentimentOutput) String() string { return awsutil.Prettify(s) } @@ -11274,24 +15028,40 @@ func (s DescribeKeyPhrasesDetectionJobOutput) String() string { // 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 DescribeKeyPhrasesDetectionJobOutput) GoString() string { +func (s DetectSentimentOutput) GoString() string { return s.String() } -// SetKeyPhrasesDetectionJobProperties sets the KeyPhrasesDetectionJobProperties field's value. -func (s *DescribeKeyPhrasesDetectionJobOutput) SetKeyPhrasesDetectionJobProperties(v *KeyPhrasesDetectionJobProperties) *DescribeKeyPhrasesDetectionJobOutput { - s.KeyPhrasesDetectionJobProperties = v +// SetSentiment sets the Sentiment field's value. +func (s *DetectSentimentOutput) SetSentiment(v string) *DetectSentimentOutput { + s.Sentiment = &v return s } -type DescribePiiEntitiesDetectionJobInput struct { +// SetSentimentScore sets the SentimentScore field's value. +func (s *DetectSentimentOutput) SetSentimentScore(v *SentimentScore) *DetectSentimentOutput { + s.SentimentScore = v + return s +} + +type DetectSyntaxInput struct { _ struct{} `type:"structure"` - // The identifier that Amazon Comprehend generated for the job. The operation - // returns this identifier in its response. + // The language code of the input documents. You can specify any of the following + // languages supported by Amazon Comprehend: German ("de"), English ("en"), + // Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). // - // JobId is a required field - JobId *string `min:"1" type:"string" required:"true"` + // LanguageCode is a required field + LanguageCode *string `type:"string" required:"true" enum:"SyntaxLanguageCode"` + + // A UTF-8 string. The maximum string size is 5 KB. + // + // Text is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DetectSyntaxInput's + // String and GoString methods. + // + // Text is a required field + Text *string `min:"1" type:"string" required:"true" sensitive:"true"` } // String returns the string representation. @@ -11299,7 +15069,7 @@ type DescribePiiEntitiesDetectionJobInput struct { // 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 DescribePiiEntitiesDetectionJobInput) String() string { +func (s DetectSyntaxInput) String() string { return awsutil.Prettify(s) } @@ -11308,18 +15078,21 @@ func (s DescribePiiEntitiesDetectionJobInput) String() string { // 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 DescribePiiEntitiesDetectionJobInput) GoString() string { +func (s DetectSyntaxInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribePiiEntitiesDetectionJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribePiiEntitiesDetectionJobInput"} - if s.JobId == nil { - invalidParams.Add(request.NewErrParamRequired("JobId")) +func (s *DetectSyntaxInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DetectSyntaxInput"} + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) } - if s.JobId != nil && len(*s.JobId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) + if s.Text == nil { + invalidParams.Add(request.NewErrParamRequired("Text")) + } + if s.Text != nil && len(*s.Text) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Text", 1)) } if invalidParams.Len() > 0 { @@ -11328,17 +15101,27 @@ func (s *DescribePiiEntitiesDetectionJobInput) Validate() error { return nil } -// SetJobId sets the JobId field's value. -func (s *DescribePiiEntitiesDetectionJobInput) SetJobId(v string) *DescribePiiEntitiesDetectionJobInput { - s.JobId = &v +// SetLanguageCode sets the LanguageCode field's value. +func (s *DetectSyntaxInput) SetLanguageCode(v string) *DetectSyntaxInput { + s.LanguageCode = &v return s } -type DescribePiiEntitiesDetectionJobOutput struct { - _ struct{} `type:"structure"` +// SetText sets the Text field's value. +func (s *DetectSyntaxInput) SetText(v string) *DetectSyntaxInput { + s.Text = &v + return s +} - // Provides information about a PII entities detection job. - PiiEntitiesDetectionJobProperties *PiiEntitiesDetectionJobProperties `type:"structure"` +type DetectSyntaxOutput struct { + _ struct{} `type:"structure" sensitive:"true"` + + // A collection of syntax tokens describing the text. For each token, the response + // provides the text, the token type, where the text begins and ends, and the + // level of confidence that Amazon Comprehend has that the token is correct. + // For a list of token types, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) + // in the Comprehend Developer Guide. + SyntaxTokens []*SyntaxToken `type:"list"` } // String returns the string representation. @@ -11346,7 +15129,7 @@ type DescribePiiEntitiesDetectionJobOutput struct { // 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 DescribePiiEntitiesDetectionJobOutput) String() string { +func (s DetectSyntaxOutput) String() string { return awsutil.Prettify(s) } @@ -11355,24 +15138,33 @@ func (s DescribePiiEntitiesDetectionJobOutput) String() string { // 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 DescribePiiEntitiesDetectionJobOutput) GoString() string { +func (s DetectSyntaxOutput) GoString() string { return s.String() } -// SetPiiEntitiesDetectionJobProperties sets the PiiEntitiesDetectionJobProperties field's value. -func (s *DescribePiiEntitiesDetectionJobOutput) SetPiiEntitiesDetectionJobProperties(v *PiiEntitiesDetectionJobProperties) *DescribePiiEntitiesDetectionJobOutput { - s.PiiEntitiesDetectionJobProperties = v +// SetSyntaxTokens sets the SyntaxTokens field's value. +func (s *DetectSyntaxOutput) SetSyntaxTokens(v []*SyntaxToken) *DetectSyntaxOutput { + s.SyntaxTokens = v return s } -type DescribeResourcePolicyInput struct { +type DetectTargetedSentimentInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the custom model version that has the resource - // policy. + // The language of the input documents. Currently, English is the only supported + // language. // - // ResourceArn is a required field - ResourceArn *string `type:"string" required:"true"` + // LanguageCode is a required field + LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` + + // A UTF-8 text string. The maximum string length is 5 KB. + // + // Text is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DetectTargetedSentimentInput's + // String and GoString methods. + // + // Text is a required field + Text *string `min:"1" type:"string" required:"true" sensitive:"true"` } // String returns the string representation. @@ -11380,7 +15172,7 @@ type DescribeResourcePolicyInput struct { // 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 DescribeResourcePolicyInput) String() string { +func (s DetectTargetedSentimentInput) String() string { return awsutil.Prettify(s) } @@ -11389,44 +15181,86 @@ func (s DescribeResourcePolicyInput) String() string { // 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 DescribeResourcePolicyInput) GoString() string { +func (s DetectTargetedSentimentInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeResourcePolicyInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeResourcePolicyInput"} - if s.ResourceArn == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceArn")) +func (s *DetectTargetedSentimentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DetectTargetedSentimentInput"} + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) + } + if s.Text == nil { + invalidParams.Add(request.NewErrParamRequired("Text")) + } + if s.Text != nil && len(*s.Text) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Text", 1)) } - if invalidParams.Len() > 0 { - return invalidParams - } - return nil + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *DetectTargetedSentimentInput) SetLanguageCode(v string) *DetectTargetedSentimentInput { + s.LanguageCode = &v + return s +} + +// SetText sets the Text field's value. +func (s *DetectTargetedSentimentInput) SetText(v string) *DetectTargetedSentimentInput { + s.Text = &v + return s +} + +type DetectTargetedSentimentOutput struct { + _ struct{} `type:"structure" sensitive:"true"` + + // Targeted sentiment analysis for each of the entities identified in the input + // text. + Entities []*TargetedSentimentEntity `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 DetectTargetedSentimentOutput) 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 DetectTargetedSentimentOutput) GoString() string { + return s.String() } -// SetResourceArn sets the ResourceArn field's value. -func (s *DescribeResourcePolicyInput) SetResourceArn(v string) *DescribeResourcePolicyInput { - s.ResourceArn = &v +// SetEntities sets the Entities field's value. +func (s *DetectTargetedSentimentOutput) SetEntities(v []*TargetedSentimentEntity) *DetectTargetedSentimentOutput { + s.Entities = v return s } -type DescribeResourcePolicyOutput struct { +// Specifies the class that categorizes the document being analyzed +type DocumentClass struct { _ struct{} `type:"structure"` - // The time at which the policy was created. - CreationTime *time.Time `type:"timestamp"` - - // The time at which the policy was last modified. - LastModifiedTime *time.Time `type:"timestamp"` + // The name of the class. + Name *string `min:"1" type:"string"` - // The revision ID of the policy. Each time you modify a policy, Amazon Comprehend - // assigns a new revision ID, and it deletes the prior version of the policy. - PolicyRevisionId *string `type:"string"` + // Page number in the input document. This field is present in the response + // only if your request includes the Byte parameter. + Page *int64 `type:"integer"` - // The JSON body of the resource-based policy. - ResourcePolicy *string `min:"1" type:"string"` + // The confidence score that Amazon Comprehend has this class correctly attributed. + Score *float64 `type:"float"` } // String returns the string representation. @@ -11434,7 +15268,7 @@ type DescribeResourcePolicyOutput struct { // 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 DescribeResourcePolicyOutput) String() string { +func (s DocumentClass) String() string { return awsutil.Prettify(s) } @@ -11443,42 +15277,39 @@ func (s DescribeResourcePolicyOutput) String() string { // 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 DescribeResourcePolicyOutput) GoString() string { +func (s DocumentClass) GoString() string { return s.String() } -// SetCreationTime sets the CreationTime field's value. -func (s *DescribeResourcePolicyOutput) SetCreationTime(v time.Time) *DescribeResourcePolicyOutput { - s.CreationTime = &v - return s -} - -// SetLastModifiedTime sets the LastModifiedTime field's value. -func (s *DescribeResourcePolicyOutput) SetLastModifiedTime(v time.Time) *DescribeResourcePolicyOutput { - s.LastModifiedTime = &v +// SetName sets the Name field's value. +func (s *DocumentClass) SetName(v string) *DocumentClass { + s.Name = &v return s } -// SetPolicyRevisionId sets the PolicyRevisionId field's value. -func (s *DescribeResourcePolicyOutput) SetPolicyRevisionId(v string) *DescribeResourcePolicyOutput { - s.PolicyRevisionId = &v +// SetPage sets the Page field's value. +func (s *DocumentClass) SetPage(v int64) *DocumentClass { + s.Page = &v return s } -// SetResourcePolicy sets the ResourcePolicy field's value. -func (s *DescribeResourcePolicyOutput) SetResourcePolicy(v string) *DescribeResourcePolicyOutput { - s.ResourcePolicy = &v +// SetScore sets the Score field's value. +func (s *DocumentClass) SetScore(v float64) *DocumentClass { + s.Score = &v return s } -type DescribeSentimentDetectionJobInput struct { +// Configuration required for a custom classification model. +type DocumentClassificationConfig struct { _ struct{} `type:"structure"` - // The identifier that Amazon Comprehend generated for the job. The operation - // returns this identifier in its response. + // One or more labels to associate with the custom classifier. + Labels []*string `type:"list"` + + // Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL. // - // JobId is a required field - JobId *string `min:"1" type:"string" required:"true"` + // Mode is a required field + Mode *string `type:"string" required:"true" enum:"DocumentClassifierMode"` } // String returns the string representation. @@ -11486,7 +15317,7 @@ type DescribeSentimentDetectionJobInput struct { // 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 DescribeSentimentDetectionJobInput) String() string { +func (s DocumentClassificationConfig) String() string { return awsutil.Prettify(s) } @@ -11495,18 +15326,15 @@ func (s DescribeSentimentDetectionJobInput) String() string { // 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 DescribeSentimentDetectionJobInput) GoString() string { +func (s DocumentClassificationConfig) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeSentimentDetectionJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeSentimentDetectionJobInput"} - if s.JobId == nil { - invalidParams.Add(request.NewErrParamRequired("JobId")) - } - if s.JobId != nil && len(*s.JobId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) +func (s *DocumentClassificationConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DocumentClassificationConfig"} + if s.Mode == nil { + invalidParams.Add(request.NewErrParamRequired("Mode")) } if invalidParams.Len() > 0 { @@ -11515,52 +15343,40 @@ func (s *DescribeSentimentDetectionJobInput) Validate() error { return nil } -// SetJobId sets the JobId field's value. -func (s *DescribeSentimentDetectionJobInput) SetJobId(v string) *DescribeSentimentDetectionJobInput { - s.JobId = &v +// SetLabels sets the Labels field's value. +func (s *DocumentClassificationConfig) SetLabels(v []*string) *DocumentClassificationConfig { + s.Labels = v return s } -type DescribeSentimentDetectionJobOutput struct { - _ struct{} `type:"structure"` - - // An object that contains the properties associated with a sentiment detection - // job. - SentimentDetectionJobProperties *SentimentDetectionJobProperties `type:"structure"` +// SetMode sets the Mode field's value. +func (s *DocumentClassificationConfig) SetMode(v string) *DocumentClassificationConfig { + s.Mode = &v + return s } -// 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 DescribeSentimentDetectionJobOutput) String() string { - return awsutil.Prettify(s) -} +// Provides information for filtering a list of document classification jobs. +// For more information, see the operation. You can provide only one filter +// parameter in each request. +type DocumentClassificationJobFilter struct { + _ struct{} `type:"structure"` -// 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 DescribeSentimentDetectionJobOutput) GoString() string { - return s.String() -} + // Filters on the name of the job. + JobName *string `min:"1" type:"string"` -// SetSentimentDetectionJobProperties sets the SentimentDetectionJobProperties field's value. -func (s *DescribeSentimentDetectionJobOutput) SetSentimentDetectionJobProperties(v *SentimentDetectionJobProperties) *DescribeSentimentDetectionJobOutput { - s.SentimentDetectionJobProperties = v - return s -} + // Filters the list based on job status. Returns only jobs with the specified + // status. + JobStatus *string `type:"string" enum:"JobStatus"` -type DescribeTargetedSentimentDetectionJobInput struct { - _ struct{} `type:"structure"` + // 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. + SubmitTimeAfter *time.Time `type:"timestamp"` - // 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"` + // 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. + SubmitTimeBefore *time.Time `type:"timestamp"` } // String returns the string representation. @@ -11568,7 +15384,7 @@ type DescribeTargetedSentimentDetectionJobInput struct { // 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 { +func (s DocumentClassificationJobFilter) String() string { return awsutil.Prettify(s) } @@ -11577,18 +15393,15 @@ func (s DescribeTargetedSentimentDetectionJobInput) String() string { // 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 { +func (s DocumentClassificationJobFilter) 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)) +func (s *DocumentClassificationJobFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DocumentClassificationJobFilter"} + if s.JobName != nil && len(*s.JobName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobName", 1)) } if invalidParams.Len() > 0 { @@ -11597,51 +15410,96 @@ func (s *DescribeTargetedSentimentDetectionJobInput) Validate() error { return nil } -// SetJobId sets the JobId field's value. -func (s *DescribeTargetedSentimentDetectionJobInput) SetJobId(v string) *DescribeTargetedSentimentDetectionJobInput { - s.JobId = &v +// SetJobName sets the JobName field's value. +func (s *DocumentClassificationJobFilter) SetJobName(v string) *DocumentClassificationJobFilter { + s.JobName = &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) +// SetJobStatus sets the JobStatus field's value. +func (s *DocumentClassificationJobFilter) SetJobStatus(v string) *DocumentClassificationJobFilter { + s.JobStatus = &v + return 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() +// SetSubmitTimeAfter sets the SubmitTimeAfter field's value. +func (s *DocumentClassificationJobFilter) SetSubmitTimeAfter(v time.Time) *DocumentClassificationJobFilter { + s.SubmitTimeAfter = &v + return s } -// SetTargetedSentimentDetectionJobProperties sets the TargetedSentimentDetectionJobProperties field's value. -func (s *DescribeTargetedSentimentDetectionJobOutput) SetTargetedSentimentDetectionJobProperties(v *TargetedSentimentDetectionJobProperties) *DescribeTargetedSentimentDetectionJobOutput { - s.TargetedSentimentDetectionJobProperties = v +// SetSubmitTimeBefore sets the SubmitTimeBefore field's value. +func (s *DocumentClassificationJobFilter) SetSubmitTimeBefore(v time.Time) *DocumentClassificationJobFilter { + s.SubmitTimeBefore = &v return s } -type DescribeTopicsDetectionJobInput struct { +// Provides information about a document classification job. +type DocumentClassificationJobProperties struct { _ struct{} `type:"structure"` - // The identifier assigned by the user to the detection job. + // The Amazon Resource Name (ARN) of the AWS Identity and Access Management + // (IAM) role that grants Amazon Comprehend read access to your input data. + DataAccessRoleArn *string `min:"20" type:"string"` + + // The Amazon Resource Name (ARN) that identifies the document classifier. + DocumentClassifierArn *string `type:"string"` + + // The time that the document classification job completed. + EndTime *time.Time `type:"timestamp"` + + // The Amazon Resource Number (ARN) of the flywheel + FlywheelArn *string `type:"string"` + + // The input data configuration that you supplied when you created the document + // classification job. + InputDataConfig *InputDataConfig `type:"structure"` + + // The Amazon Resource Name (ARN) of the document classification 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: