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.
+ */ + public createDataset( + args: CreateDatasetCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreates 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 @@ -721,7 +810,7 @@ export class Comprehend extends ComprehendClient { /** *
Creates an entity recognizer using submitted files. After your
* CreateEntityRecognizer request is submitted, you can check job status using the
- * API.
DescribeEntityRecognizer API.
*/
public createEntityRecognizer(
args: CreateEntityRecognizerCommandInput,
@@ -752,6 +841,48 @@ export class Comprehend extends ComprehendClient {
}
}
+ /**
+ * 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.
+ */ + public createFlywheel( + args: CreateFlywheelCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes a previously created document classifier
*Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. @@ -862,6 +993,41 @@ export class Comprehend extends ComprehendClient { } } + /** + *
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.
+ */ + public deleteFlywheel( + args: DeleteFlywheelCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes a resource-based policy that is attached to a custom model.
*/ @@ -894,6 +1060,40 @@ export class Comprehend extends ComprehendClient { } } + /** + *Returns information about the dataset that you specify. + * For more information about datasets, see + * Flywheel overview in the Amazon Comprehend Developer Guide.
+ */ + public describeDataset( + args: DescribeDatasetCommandInput, + options?: __HttpHandlerOptions + ): PromiseGets the properties associated with a document classification job. Use this operation to * get the status of a classification job.
@@ -1124,6 +1324,73 @@ export class Comprehend extends ComprehendClient { } } + /** + *Provides configuration information about the flywheel. For more information about flywheels, see + * Flywheel overview in the Amazon Comprehend Developer Guide.
+ */ + public describeFlywheel( + args: DescribeFlywheelCommandInput, + options?: __HttpHandlerOptions + ): PromiseRetrieve the configuration properties of a flywheel iteration. + * For more information about flywheels, see + * Flywheel overview in the Amazon Comprehend Developer Guide.
+ */ + public describeFlywheelIteration( + args: DescribeFlywheelIterationCommandInput, + options?: __HttpHandlerOptions + ): PromiseGets the properties associated with a key phrases detection job. Use this operation to get * the status of a detection job.
@@ -1598,6 +1865,36 @@ export class Comprehend extends ComprehendClient { } } + /** + *List the datasets that you have configured in this region. For more information about datasets, see + * Flywheel overview in the Amazon Comprehend Developer Guide.
+ */ + public listDatasets( + args: ListDatasetsCommandInput, + options?: __HttpHandlerOptions + ): PromiseGets a list of the documentation classification jobs that you have submitted.
*/ @@ -1892,6 +2189,72 @@ export class Comprehend extends ComprehendClient { } } + /** + *Information about the history of a flywheel iteration. + * For more information about flywheels, see + * Flywheel overview in the Amazon Comprehend Developer Guide.
+ */ + public listFlywheelIterationHistory( + args: ListFlywheelIterationHistoryCommandInput, + options?: __HttpHandlerOptions + ): PromiseGets a list of the flywheels that you have created.
+ */ + public listFlywheels( + args: ListFlywheelsCommandInput, + options?: __HttpHandlerOptions + ): PromiseGet a list of key phrase detection jobs that you have submitted.
*/ @@ -2119,8 +2482,9 @@ export class Comprehend extends ComprehendClient { } /** - *Starts an asynchronous document classification job. Use the operation to track the progress of the - * job.
+ *Starts an asynchronous document classification job. Use the
+ * DescribeDocumentClassificationJob
+ * operation to track the progress of the 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 in the Amazon Comprehend Developer Guide.
+ */ + public startFlywheelIteration( + args: StartFlywheelIterationCommandInput, + options?: __HttpHandlerOptions + ): PromiseStarts an asynchronous key phrase detection job for a collection of documents. Use the * operation to track the status of a @@ -2355,7 +2753,7 @@ export class Comprehend extends ComprehendClient { /** *
Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the
- * operation to track the status of a
+ * DescribeTargetedSentimentDetectionJob operation to track the status of a
* job.
Update the configuration information for an existing flywheel.
+ */ + public updateFlywheel( + args: UpdateFlywheelCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreates 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.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, CreateDatasetCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, CreateDatasetCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new CreateDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatasetCommandInput} for command's `input` shape. + * @see {@link CreateDatasetCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. + * + */ +export class CreateDatasetCommand extends $Command< + CreateDatasetCommandInput, + CreateDatasetCommandOutput, + ComprehendClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + constructor(readonly input: CreateDatasetCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates an entity recognizer using submitted files. After your
* CreateEntityRecognizer request is submitted, you can check job status using the
- * API.
DescribeEntityRecognizer API.
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
diff --git a/clients/client-comprehend/src/commands/CreateFlywheelCommand.ts b/clients/client-comprehend/src/commands/CreateFlywheelCommand.ts
new file mode 100644
index 000000000000..71e481f3cd54
--- /dev/null
+++ b/clients/client-comprehend/src/commands/CreateFlywheelCommand.ts
@@ -0,0 +1,130 @@
+// smithy-typescript generated code
+import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
+import { getSerdePlugin } from "@aws-sdk/middleware-serde";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import {
+ FinalizeHandlerArguments,
+ Handler,
+ HandlerExecutionContext,
+ HttpHandlerOptions as __HttpHandlerOptions,
+ MetadataBearer as __MetadataBearer,
+ MiddlewareStack,
+ SerdeContext as __SerdeContext,
+} from "@aws-sdk/types";
+
+import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
+import {
+ CreateFlywheelRequest,
+ CreateFlywheelRequestFilterSensitiveLog,
+ CreateFlywheelResponse,
+ CreateFlywheelResponseFilterSensitiveLog,
+} from "../models/models_0";
+import {
+ deserializeAws_json1_1CreateFlywheelCommand,
+ serializeAws_json1_1CreateFlywheelCommand,
+} from "../protocols/Aws_json1_1";
+
+/**
+ * The input for {@link CreateFlywheelCommand}.
+ */
+export interface CreateFlywheelCommandInput extends CreateFlywheelRequest {}
+/**
+ * The output of {@link CreateFlywheelCommand}.
+ */
+export interface CreateFlywheelCommandOutput extends CreateFlywheelResponse, __MetadataBearer {}
+
+/**
+ * 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.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, CreateFlywheelCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, CreateFlywheelCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new CreateFlywheelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFlywheelCommandInput} for command's `input` shape. + * @see {@link CreateFlywheelCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. + * + */ +export class CreateFlywheelCommand extends $Command< + CreateFlywheelCommandInput, + CreateFlywheelCommandOutput, + ComprehendClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + constructor(readonly input: CreateFlywheelCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes 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.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DeleteFlywheelCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DeleteFlywheelCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DeleteFlywheelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFlywheelCommandInput} for command's `input` shape. + * @see {@link DeleteFlywheelCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. + * + */ +export class DeleteFlywheelCommand extends $Command< + DeleteFlywheelCommandInput, + DeleteFlywheelCommandOutput, + ComprehendClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + constructor(readonly input: DeleteFlywheelCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns information about the dataset that you specify. + * For more information about datasets, see + * Flywheel overview in the Amazon Comprehend Developer Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DescribeDatasetCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DescribeDatasetCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DescribeDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDatasetCommandInput} for command's `input` shape. + * @see {@link DescribeDatasetCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. + * + */ +export class DescribeDatasetCommand extends $Command< + DescribeDatasetCommandInput, + DescribeDatasetCommandOutput, + ComprehendClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + constructor(readonly input: DescribeDatasetCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackProvides configuration information about the flywheel. For more information about flywheels, see + * Flywheel overview in the Amazon Comprehend Developer Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DescribeFlywheelCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DescribeFlywheelCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DescribeFlywheelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFlywheelCommandInput} for command's `input` shape. + * @see {@link DescribeFlywheelCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. + * + */ +export class DescribeFlywheelCommand extends $Command< + DescribeFlywheelCommandInput, + DescribeFlywheelCommandOutput, + ComprehendClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + constructor(readonly input: DescribeFlywheelCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackRetrieve the configuration properties of a flywheel iteration. + * For more information about flywheels, see + * Flywheel overview in the Amazon Comprehend Developer Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DescribeFlywheelIterationCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DescribeFlywheelIterationCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DescribeFlywheelIterationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFlywheelIterationCommandInput} for command's `input` shape. + * @see {@link DescribeFlywheelIterationCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. + * + */ +export class DescribeFlywheelIterationCommand extends $Command< + DescribeFlywheelIterationCommandInput, + DescribeFlywheelIterationCommandOutput, + ComprehendClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + constructor(readonly input: DescribeFlywheelIterationCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackList the datasets that you have configured in this region. For more information about datasets, see + * Flywheel overview in the Amazon Comprehend Developer Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ListDatasetsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ListDatasetsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ListDatasetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatasetsCommandInput} for command's `input` shape. + * @see {@link ListDatasetsCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. + * + */ +export class ListDatasetsCommand extends $Command< + ListDatasetsCommandInput, + ListDatasetsCommandOutput, + ComprehendClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + constructor(readonly input: ListDatasetsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackInformation about the history of a flywheel iteration. + * For more information about flywheels, see + * Flywheel overview in the Amazon Comprehend Developer Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ListFlywheelIterationHistoryCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ListFlywheelIterationHistoryCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ListFlywheelIterationHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFlywheelIterationHistoryCommandInput} for command's `input` shape. + * @see {@link ListFlywheelIterationHistoryCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. + * + */ +export class ListFlywheelIterationHistoryCommand extends $Command< + ListFlywheelIterationHistoryCommandInput, + ListFlywheelIterationHistoryCommandOutput, + ComprehendClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + constructor(readonly input: ListFlywheelIterationHistoryCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets a list of the flywheels that you have created.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ListFlywheelsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ListFlywheelsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ListFlywheelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFlywheelsCommandInput} for command's `input` shape. + * @see {@link ListFlywheelsCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. + * + */ +export class ListFlywheelsCommand extends $Command< + ListFlywheelsCommandInput, + ListFlywheelsCommandOutput, + ComprehendClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + constructor(readonly input: ListFlywheelsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackStarts an asynchronous document classification job. Use the operation to track the progress of the - * job.
+ *Starts an asynchronous document classification job. Use the
+ * DescribeDocumentClassificationJob
+ * operation to track the progress of the 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 in the Amazon Comprehend Developer Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StartFlywheelIterationCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StartFlywheelIterationCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StartFlywheelIterationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartFlywheelIterationCommandInput} for command's `input` shape. + * @see {@link StartFlywheelIterationCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. + * + */ +export class StartFlywheelIterationCommand extends $Command< + StartFlywheelIterationCommandInput, + StartFlywheelIterationCommandOutput, + ComprehendClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + constructor(readonly input: StartFlywheelIterationCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackStarts an asynchronous targeted sentiment detection job for a collection of documents. Use the
- * operation to track the status of a
+ * DescribeTargetedSentimentDetectionJob operation to track the status of a
* job.
Update the configuration information for an existing flywheel.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, UpdateFlywheelCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, UpdateFlywheelCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new UpdateFlywheelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFlywheelCommandInput} for command's `input` shape. + * @see {@link UpdateFlywheelCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. + * + */ +export class UpdateFlywheelCommand extends $Command< + UpdateFlywheelCommandInput, + UpdateFlywheelCommandOutput, + ComprehendClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + constructor(readonly input: UpdateFlywheelCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackAn 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.
+ */ +export interface DatasetAugmentedManifestsListItem { + /** + *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: string[] | undefined; + + /** + *The Amazon S3 location of the augmented manifest file.
+ */ + S3Uri: string | undefined; + + /** + *The S3 prefix to the annotation files that are referred in the augmented manifest + * file.
+ */ + AnnotationDataS3Uri?: string; + + /** + *The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest + * file.
+ */ + SourceDocumentsS3Uri?: string; + + /** + *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.
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.
+ */ +export interface DatasetDocumentClassifierInputDataConfig { + /** + *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.
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; +} + +/** + *Describes the annotations associated with a entity recognizer.
+ */ +export interface DatasetEntityRecognizerAnnotations { + /** + *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.
+ */ + S3Uri: string | undefined; +} + +export enum InputFormat { + ONE_DOC_PER_FILE = "ONE_DOC_PER_FILE", + ONE_DOC_PER_LINE = "ONE_DOC_PER_LINE", +} + +/** + *Describes the documents submitted with a dataset for an entity recognizer model.
+ */ +export interface DatasetEntityRecognizerDocuments { + /** + *Specifies the Amazon S3 location where the documents for the dataset + * are located.
+ */ + S3Uri: string | undefined; + + /** + *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?: InputFormat | string; +} + +/** + *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.
+ */ +export interface DatasetEntityRecognizerEntityList { + /** + *Specifies the Amazon S3 location where the entity list is located.
+ */ + S3Uri: string | undefined; +} + +/** + *Specifies the format and location of the input data. You must provide either the
+ * Annotations parameter or the EntityList parameter.
The S3 location of the annotation documents for your custom entity recognizer.
+ */ + Annotations?: DatasetEntityRecognizerAnnotations; + + /** + *The format and location of the training documents for your custom entity + * recognizer.
+ */ + Documents: DatasetEntityRecognizerDocuments | undefined; + + /** + *The S3 location of the entity list for your custom entity recognizer.
+ */ + EntityList?: DatasetEntityRecognizerEntityList; +} + +/** + *Specifies the format and location of the input data for the dataset.
+ */ +export interface DatasetInputDataConfig { + /** + *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[]; + + /** + *
+ * 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
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.
+ */ + DocumentClassifierInputDataConfig?: DatasetDocumentClassifierInputDataConfig; + + /** + *The input properties for training an entity recognizer model.
+ */ + EntityRecognizerInputDataConfig?: DatasetEntityRecognizerInputDataConfig; +} + +/** + *A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For + * example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to + * indicate its use by a particular department.
+ */ +export interface Tag { + /** + *The initial part of a key-value pair that forms a tag associated with a given resource. + * For instance, if you want to show which resources are used by which departments, you might use + * “Department” as the key portion of the pair, with multiple possible values such as “sales,” + * “legal,” and “administration.”
+ */ + Key: string | undefined; + + /** + *The second part of a key-value pair that forms a tag associated with a given resource. + * For instance, if you want to show which resources are used by which departments, you might use + * “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the + * sales department.
+ */ + Value?: string; +} + +export interface CreateDatasetRequest { + /** + *The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.
+ */ + FlywheelArn: string | undefined; + + /** + *Name of the dataset.
+ */ + DatasetName: string | undefined; + + /** + *The dataset type. You can specify that the data in a dataset is for training + * the model or for testing the model.
+ */ + DatasetType?: DatasetType | string; + + /** + *Description of the dataset.
+ */ + Description?: string; + + /** + *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: DatasetInputDataConfig | undefined; + + /** + *A unique identifier for the request. If you don't set the client request token, Amazon + * Comprehend generates one.
+ */ + ClientRequestToken?: string; + + /** + *Tags for the dataset.
+ */ + Tags?: Tag[]; +} + +export interface CreateDatasetResponse { + /** + *The ARN of the dataset.
+ */ + DatasetArn?: string; +} + +/** + *The specified resource name is already in use. Use a different name and try your request + * again.
+ */ +export class ResourceInUseException extends __BaseException { + readonly name: "ResourceInUseException" = "ResourceInUseException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe maximum number of resources per account has been exceeded. Review the resources, and + * then try your request again.
+ */ +export class ResourceLimitExceededException extends __BaseException { + readonly name: "ResourceLimitExceededException" = "ResourceLimitExceededException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe specified resource ARN was not found. Check the ARN and try your request again.
+ */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe number of requests exceeds the limit. Resubmit your request later.
+ */ +export class TooManyRequestsException extends __BaseException { + readonly name: "TooManyRequestsException" = "TooManyRequestsException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe 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.
+ */ +export class TooManyTagsException extends __BaseException { + readonly name: "TooManyTagsException" = "TooManyTagsException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType"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"
- *
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For - * example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to - * indicate its use by a particular department.
- */ -export interface Tag { - /** - *The initial part of a key-value pair that forms a tag associated with a given resource. - * For instance, if you want to show which resources are used by which departments, you might use - * “Department” as the key portion of the pair, with multiple possible values such as “sales,” - * “legal,” and “administration.”
+ *KMS Key Alias: "alias/ExampleAlias"
+ *
ARN of a KMS Key Alias:
+ * "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
+ *
The second part of a key-value pair that forms a tag associated with a given resource. - * For instance, if you want to show which resources are used by which departments, you might use - * “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the - * sales department.
+ *The Amazon S3 prefix for the data lake location of the flywheel statistics.
*/ - Value?: string; + FlywheelStatsS3Prefix?: string; } /** @@ -1763,13 +2110,13 @@ export interface CreateDocumentClassifierRequest { VersionName?: string; /** - *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) of the AWS Identity and Access Management (IAM) role that + * grants Amazon Comprehend read access to your input data.
*/ DataAccessRoleArn: string | undefined; /** - *Tags to be associated with the document classifier being created. A tag is a key-value + *
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. *
@@ -1794,9 +2141,8 @@ export interface CreateDocumentClassifierRequest { ClientRequestToken?: 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.
+ *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: LanguageCode | string | undefined; @@ -1899,94 +2245,6 @@ export class KmsKeyValidationException extends __BaseException { } } -/** - *The specified resource name is already in use. Use a different name and try your request - * again.
- */ -export class ResourceInUseException extends __BaseException { - readonly name: "ResourceInUseException" = "ResourceInUseException"; - readonly $fault: "client" = "client"; - Message?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe maximum number of resources per account has been exceeded. Review the resources, and - * then try your request again.
- */ -export class ResourceLimitExceededException extends __BaseException { - readonly name: "ResourceLimitExceededException" = "ResourceLimitExceededException"; - readonly $fault: "client" = "client"; - Message?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe number of requests exceeds the limit. Resubmit your request later.
- */ -export class TooManyRequestsException extends __BaseException { - readonly name: "TooManyRequestsException" = "TooManyRequestsException"; - readonly $fault: "client" = "client"; - Message?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe 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.
- */ -export class TooManyTagsException extends __BaseException { - readonly name: "TooManyTagsException" = "TooManyTagsException"; - readonly $fault: "client" = "client"; - Message?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThis is the descriptive suffix that becomes part of the EndpointArn used for
@@ -1998,7 +2256,7 @@ export interface CreateEndpointRequest {
*
The Amazon Resource Number (ARN) of the model to which the endpoint will be * attached.
*/ - ModelArn: string | undefined; + ModelArn?: string; /** *The desired number of inference units to be used by the model using this endpoint. @@ -2015,18 +2273,24 @@ export interface CreateEndpointRequest { ClientRequestToken?: string; /** - *
Tags associated with the endpoint being created. A tag is a key-value pair that adds + *
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[]; /** - *The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that + *
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; + + /** + *The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be + * attached.
+ */ + FlywheelArn?: string; } export interface CreateEndpointResponse { @@ -2034,27 +2298,12 @@ export interface CreateEndpointResponse { *The Amazon Resource Number (ARN) of the endpoint being created.
*/ EndpointArn?: string; -} -/** - *The specified resource ARN was not found. Check the ARN and try your request again.
- */ -export class ResourceNotFoundException extends __BaseException { - readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; - readonly $fault: "client" = "client"; - Message?: string; /** - * @internal + *The Amazon Resource Number (ARN) of the model to which the endpoint is + * attached.
*/ - constructor(opts: __ExceptionOptionTypeDescribes the training documents submitted with an entity recognizer.
*/ @@ -2113,7 +2357,7 @@ export interface EntityRecognizerDocuments { } /** - *Describes the entity recognizer submitted with an entity recognizer.
+ *Describes the entity list submitted with an entity recognizer.
*/ export interface EntityRecognizerEntityList { /** @@ -2226,13 +2470,13 @@ export interface CreateEntityRecognizerRequest { VersionName?: string; /** - *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) of the AWS Identity and Access Management (IAM) role that + * grants Amazon Comprehend read access to your input data.
*/ DataAccessRoleArn: string | undefined; /** - *Tags to be associated with the entity recognizer being created. A tag is a key-value pair + *
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. *
@@ -2288,7 +2532,7 @@ export interface CreateEntityRecognizerRequest { /** *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
+ * trained custom models. The ModelKmsKeyId can be either of the following formats: *KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
@@ -2319,14 +2563,165 @@ export interface CreateEntityRecognizerRequest {
* '{"attribute": "value", "attribute": ["value"]}'
*
The Amazon Resource Name (ARN) that identifies the entity recognizer.
+ */ + EntityRecognizerArn?: string; +} + +/** + *Data security configuration.
+ */ +export interface DataSecurityConfig { + /** + *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.
+ */ + VolumeKmsKeyId?: string; + + /** + *ID for the KMS key that Amazon Comprehend uses to encrypt the data in the data lake.
+ */ + DataLakeKmsKeyId?: 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.
+ */ + VpcConfig?: VpcConfig; +} + +export enum ModelType { + DOCUMENT_CLASSIFIER = "DOCUMENT_CLASSIFIER", + ENTITY_RECOGNIZER = "ENTITY_RECOGNIZER", +} + +/** + *Configuration required for a custom classification model.
+ */ +export interface DocumentClassificationConfig { + /** + *Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.
One or more labels to associate with the custom classifier.
+ */ + Labels?: string[]; +} + +/** + *Configuration required for an entity recognition model.
+ */ +export interface EntityRecognitionConfig { + /** + *Up to 25 entity types that the model is trained to recognize.
+ */ + EntityTypes: EntityTypesListItem[] | undefined; +} + +/** + *Configuration about the custom classifier associated with the flywheel.
+ */ +export interface TaskConfig { + /** + *Language code for the language that the model supports.
+ */ + LanguageCode: LanguageCode | string | undefined; + + /** + *Configuration required for a classification model.
+ */ + DocumentClassificationConfig?: DocumentClassificationConfig; + + /** + *Configuration required for an entity recognition model.
+ */ + EntityRecognitionConfig?: EntityRecognitionConfig; +} + +export interface CreateFlywheelRequest { + /** + *Name for the flywheel.
+ */ + FlywheelName: string | undefined; + + /** + *To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version.
+ */ + ActiveModelArn?: string; + + /** + *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.
+ */ + DataAccessRoleArn: string | undefined; + + /** + *Configuration about the custom classifier associated with the flywheel.
+ */ + TaskConfig?: TaskConfig; + + /** + *The model type.
+ */ + ModelType?: ModelType | string; + + /** + *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.
+ */ + DataLakeS3Uri: string | undefined; + + /** + *Data security configurations.
+ */ + DataSecurityConfig?: DataSecurityConfig; + + /** + *A unique identifier for the request. If you don't set the client request token, Amazon + * Comprehend generates one.
+ */ + ClientRequestToken?: string; + + /** + *The tags to associate with this flywheel.
+ */ + Tags?: Tag[]; +} + +export interface CreateFlywheelResponse { + /** + *The Amazon Resource Number (ARN) of the flywheel.
+ */ + FlywheelArn?: string; -export interface CreateEntityRecognizerResponse { /** - *The Amazon Resource Name (ARN) that identifies the entity recognizer.
+ *The Amazon Resource Number (ARN) of the active model version.
*/ - EntityRecognizerArn?: string; + ActiveModelArn?: string; } export interface DeleteDocumentClassifierRequest { @@ -2356,6 +2751,15 @@ export interface DeleteEntityRecognizerRequest { export interface DeleteEntityRecognizerResponse {} +export interface DeleteFlywheelRequest { + /** + *The Amazon Resource Number (ARN) of the flywheel to delete.
+ */ + FlywheelArn: string | undefined; +} + +export interface DeleteFlywheelResponse {} + export interface DeleteResourcePolicyRequest { /** *The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.
@@ -2370,10 +2774,86 @@ export interface DeleteResourcePolicyRequest { export interface DeleteResourcePolicyResponse {} +export interface DescribeDatasetRequest { + /** + *The ARN of the dataset.
+ */ + DatasetArn: string | undefined; +} + +export enum DatasetStatus { + COMPLETED = "COMPLETED", + CREATING = "CREATING", + FAILED = "FAILED", +} + +/** + *Properties associated with the dataset.
+ */ +export interface DatasetProperties { + /** + *The ARN of the dataset.
+ */ + DatasetArn?: string; + + /** + *The name of the dataset.
+ */ + DatasetName?: string; + + /** + *The dataset type (training data or test data).
+ */ + DatasetType?: DatasetType | string; + + /** + *The S3 URI where the dataset is stored.
+ */ + DatasetS3Uri?: string; + + /** + *Description of the dataset.
+ */ + Description?: string; + + /** + *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.
A description of the status of the dataset.
+ */ + Message?: string; + + /** + *The number of documents in the dataset.
+ */ + NumberOfDocuments?: number; + + /** + *Creation time of the dataset.
+ */ + CreationTime?: Date; + + /** + *Time when the data from the dataset becomes available in the data lake.
+ */ + EndTime?: Date; +} + +export interface DescribeDatasetResponse { + /** + *The dataset properties.
+ */ + DatasetProperties?: DatasetProperties; +} + export interface DescribeDocumentClassificationJobRequest { /** - *The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its - * response.
+ *The identifier that Amazon Comprehend generated for the job. The
+ * StartDocumentClassificationJob operation returns this identifier in its response.
The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that + *
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; @@ -2572,6 +3052,11 @@ export interface DocumentClassificationJobProperties { * VPC. */ VpcConfig?: VpcConfig; + + /** + *The Amazon Resource Number (ARN) of the flywheel
+ */ + FlywheelArn?: string; } export interface DescribeDocumentClassificationJobResponse { @@ -2605,8 +3090,8 @@ export class JobNotFoundException extends __BaseException { export interface DescribeDocumentClassifierRequest { /** - *The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its - * response.
+ *The Amazon Resource Name (ARN) that identifies the document classifier. The
+ * CreateDocumentClassifier operation returns this identifier in its response.
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) of the AWS Identity and Access Management (IAM) role that + * grants Amazon Comprehend read access to your input data.
*/ DataAccessRoleArn?: string; @@ -2754,6 +3239,11 @@ export interface DocumentClassifierProperties { * different AWS account to create the document classifier model in your AWS account. */ SourceModelArn?: string; + + /** + *The Amazon Resource Number (ARN) of the flywheel
+ */ + FlywheelArn?: string; } export interface DescribeDocumentClassifierResponse { @@ -2765,8 +3255,8 @@ export interface DescribeDocumentClassifierResponse { export interface DescribeDominantLanguageDetectionJobRequest { /** - *The identifier that Amazon Comprehend generated for the job. The 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 Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input - * data.
+ *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; @@ -2944,7 +3434,7 @@ export interface EndpointProperties { LastModifiedTime?: Date; /** - *The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that + *
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).
*/ @@ -2955,6 +3445,11 @@ export interface EndpointProperties { * key. */ DesiredDataAccessRoleArn?: string; + + /** + *The Amazon Resource Number (ARN) of the flywheel
+ */ + FlywheelArn?: string; } export interface DescribeEndpointResponse { @@ -2966,8 +3461,8 @@ export interface DescribeEndpointResponse { export interface DescribeEntitiesDetectionJobRequest { /** - *The identifier that Amazon Comprehend generated for the job. The 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 Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input - * data.
+ *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; @@ -3089,6 +3584,16 @@ export interface DescribeEntityRecognizerRequest { EntityRecognizerArn: string | undefined; } +/** + *Output data configuration.
+ */ +export interface EntityRecognizerOutputDataConfig { + /** + *The Amazon S3 prefix for the data lake location of the flywheel statistics.
+ */ + FlywheelStatsS3Prefix?: string; +} + /** *Detailed information about the accuracy of an entity recognizer for a specific entity * type.
@@ -3250,8 +3755,8 @@ export interface EntityRecognizerProperties { RecognizerMetadata?: EntityRecognizerMetadata; /** - *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) of the AWS Identity and Access Management (IAM) role that + * grants Amazon Comprehend read access to your input data.
*/ DataAccessRoleArn?: string; @@ -3282,7 +3787,7 @@ export interface EntityRecognizerProperties { /** *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:
+ * trained custom models. The ModelKmsKeyId can be either of the following formats: *KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
@@ -3298,118 +3803,330 @@ export interface EntityRecognizerProperties {
ModelKmsKeyId?: string;
/**
- *
The version name you assigned to the entity recognizer.
+ *The version name you assigned to the entity recognizer.
+ */ + VersionName?: string; + + /** + *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.
+ */ + SourceModelArn?: string; + + /** + *The Amazon Resource Number (ARN) of the flywheel
+ */ + FlywheelArn?: string; + + /** + *Output data configuration.
+ */ + OutputDataConfig?: EntityRecognizerOutputDataConfig; +} + +export interface DescribeEntityRecognizerResponse { + /** + *Describes information associated with an entity recognizer.
+ */ + EntityRecognizerProperties?: EntityRecognizerProperties; +} + +export interface DescribeEventsDetectionJobRequest { + /** + *The identifier of the events detection job.
+ */ + JobId: string | undefined; +} + +/** + *Provides information about an events detection job.
+ */ +export interface EventsDetectionJobProperties { + /** + *The identifier assigned to the events detection job.
+ */ + JobId?: string; + + /** + *The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully + * qualified identifier for the job. It includes the AWS account, Region, and the job ID. The + * format of the ARN is as follows:
+ *
+ * arn:
+ *
The following is an example job ARN:
+ *
+ * arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
+ *
The name you assigned the events detection job.
+ */ + JobName?: string; + + /** + *The current status of the events detection job.
+ */ + JobStatus?: JobStatus | string; + + /** + *A description of the status of the events detection job.
+ */ + Message?: string; + + /** + *The time that the events detection job was submitted for processing.
+ */ + SubmitTime?: Date; + + /** + *The time that the events detection job completed.
+ */ + EndTime?: Date; + + /** + *The input data configuration that you supplied when you created the events detection + * job.
+ */ + InputDataConfig?: InputDataConfig; + + /** + *The output data configuration that you supplied when you created the events detection + * job.
+ */ + OutputDataConfig?: OutputDataConfig; + + /** + *The language code of the input documents.
+ */ + LanguageCode?: LanguageCode | string; + + /** + *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; + + /** + *The types of events that are detected by the job.
+ */ + TargetEventTypes?: string[]; +} + +export interface DescribeEventsDetectionJobResponse { + /** + *An object that contains the properties associated with an event detection job.
+ */ + EventsDetectionJobProperties?: EventsDetectionJobProperties; +} + +export interface DescribeFlywheelRequest { + /** + *The Amazon Resource Number (ARN) of the flywheel.
+ */ + FlywheelArn: string | undefined; +} + +export enum FlywheelStatus { + ACTIVE = "ACTIVE", + CREATING = "CREATING", + DELETING = "DELETING", + FAILED = "FAILED", + UPDATING = "UPDATING", +} + +/** + *The flywheel properties.
+ */ +export interface FlywheelProperties { + /** + *The Amazon Resource Number (ARN) of the flywheel.
+ */ + FlywheelArn?: string; + + /** + *The Amazon Resource Number (ARN) of the active model version.
+ */ + ActiveModelArn?: string; + + /** + *The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that + * grants Amazon Comprehend permission to access the flywheel data.
+ */ + DataAccessRoleArn?: string; + + /** + *Configuration about the custom classifier associated with the flywheel.
+ */ + TaskConfig?: TaskConfig; + + /** + *Amazon S3 URI of the data lake location.
+ */ + DataLakeS3Uri?: string; + + /** + *Data security configuration.
+ */ + DataSecurityConfig?: DataSecurityConfig; + + /** + *The status of the flywheel.
+ */ + Status?: FlywheelStatus | string; + + /** + *Model type of the flywheel's model.
+ */ + ModelType?: ModelType | string; + + /** + *A description of the status of the flywheel.
+ */ + Message?: string; + + /** + *Creation time of the flywheel.
+ */ + CreationTime?: Date; + + /** + *Last modified time for the flywheel.
+ */ + LastModifiedTime?: Date; + + /** + *The most recent flywheel iteration.
*/ - VersionName?: string; + LatestFlywheelIteration?: string; +} +export interface DescribeFlywheelResponse { /** - *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.
+ *The flywheel properties.
*/ - SourceModelArn?: string; + FlywheelProperties?: FlywheelProperties; } -export interface DescribeEntityRecognizerResponse { +export interface DescribeFlywheelIterationRequest { /** - *Describes information associated with an entity recognizer.
+ * */ - EntityRecognizerProperties?: EntityRecognizerProperties; -} + FlywheelArn: string | undefined; -export interface DescribeEventsDetectionJobRequest { /** - *The identifier of the events detection job.
+ * */ - JobId: string | undefined; + FlywheelIterationId: string | undefined; } /** - *Provides information about an events detection job.
+ *The evaluation metrics associated with the evaluated model.
*/ -export interface EventsDetectionJobProperties { +export interface FlywheelModelEvaluationMetrics { /** - *The identifier assigned to the events detection job.
+ *The average F1 score from the evaluation metrics.
*/ - JobId?: string; + AverageF1Score?: number; /** - *The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully - * qualified identifier for the job. It includes the AWS account, Region, and the job ID. The - * format of the ARN is as follows:
- *
- * arn:
- *
The following is an example job ARN:
- *
- * arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
- *
Average precision metric for the model.
*/ - JobArn?: string; + AveragePrecision?: number; /** - *The name you assigned the events detection job.
+ *Average recall metric for the model.
*/ - JobName?: string; + AverageRecall?: number; /** - *The current status of the events detection job.
+ *Average accuracy metric for the model.
*/ - JobStatus?: JobStatus | string; + AverageAccuracy?: number; +} + +export enum FlywheelIterationStatus { + COMPLETED = "COMPLETED", + EVALUATING = "EVALUATING", + FAILED = "FAILED", + STOPPED = "STOPPED", + STOP_REQUESTED = "STOP_REQUESTED", + TRAINING = "TRAINING", +} +/** + *The configuration properties of a flywheel iteration.
+ */ +export interface FlywheelIterationProperties { /** - *A description of the status of the events detection job.
+ * */ - Message?: string; + FlywheelArn?: string; /** - *The time that the events detection job was submitted for processing.
+ * */ - SubmitTime?: Date; + FlywheelIterationId?: string; /** - *The time that the events detection job completed.
+ *The creation start time of the flywheel iteration.
+ */ + CreationTime?: Date; + + /** + *The completion time of this flywheel iteration.
*/ EndTime?: Date; /** - *The input data configuration that you supplied when you created the events detection - * job.
+ *The status of the flywheel iteration.
*/ - InputDataConfig?: InputDataConfig; + Status?: FlywheelIterationStatus | string; /** - *The output data configuration that you supplied when you created the events detection - * job.
+ *A description of the status of the flywheel iteration.
*/ - OutputDataConfig?: OutputDataConfig; + Message?: string; /** - *The language code of the input documents.
+ *The ARN of the evaluated model associated with this flywheel iteration.
*/ - LanguageCode?: LanguageCode | string; + EvaluatedModelArn?: string; /** - *The Amazon Resource Name (ARN) of the AWS Identify and Access Management (IAM) role that - * grants Amazon Comprehend read access to your input data.
+ *The evaluation metrics associated with the evaluated model.
*/ - DataAccessRoleArn?: string; + EvaluatedModelMetrics?: FlywheelModelEvaluationMetrics; /** - *The types of events that are detected by the job.
+ *The ARN of the trained model associated with this flywheel iteration.
*/ - TargetEventTypes?: string[]; + TrainedModelArn?: string; + + /** + *The metrics associated with the trained model.
+ */ + TrainedModelMetrics?: FlywheelModelEvaluationMetrics; + + /** + * + */ + EvaluationManifestS3Prefix?: string; } -export interface DescribeEventsDetectionJobResponse { +export interface DescribeFlywheelIterationResponse { /** - *An object that contains the properties associated with an event detection job.
+ *The configuration properties of a flywheel iteration.
*/ - EventsDetectionJobProperties?: EventsDetectionJobProperties; + FlywheelIterationProperties?: FlywheelIterationProperties; } export interface DescribeKeyPhrasesDetectionJobRequest { /** - *The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its + *
The identifier that Amazon Comprehend generated for the job. The
+ * StartKeyPhrasesDetectionJob operation returns this identifier in its
* response.
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input - * data.
+ *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; @@ -3656,8 +4373,8 @@ export interface PiiEntitiesDetectionJobProperties { LanguageCode?: LanguageCode | string; /** - *The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input - * data.
+ *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; @@ -3780,8 +4497,8 @@ export interface SentimentDetectionJobProperties { LanguageCode?: LanguageCode | string; /** - *The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input - * data.
+ *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; @@ -3820,7 +4537,8 @@ export interface DescribeSentimentDetectionJobResponse { export interface DescribeTargetedSentimentDetectionJobRequest { /** - *The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its + *
The identifier that Amazon Comprehend generated for the job. The
+ * StartTargetedSentimentDetectionJob operation returns this identifier in its
* response.
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input - * data.
+ *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; /** - *ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt + *
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:
*The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants - * Amazon Comprehend read access to your job data.
+ *The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that + * grants Amazon Comprehend read access to your job data.
*/ DataAccessRoleArn?: string; @@ -4341,14 +5059,14 @@ export interface ImportModelRequest { ModelKmsKeyId?: string; /** - *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 + *
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.
*/ DataAccessRoleArn?: string; /** - *Tags to be associated with the custom model that is created by this import. A tag is a + *
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.
@@ -4385,6 +5103,65 @@ export class InvalidFilterException extends __BaseException { } } +/** + *Filter the datasets based on creation time or dataset status.
+ */ +export interface DatasetFilter { + /** + *Filter the datasets based on the dataset status.
+ */ + Status?: DatasetStatus | string; + + /** + *Filter the datasets based on the dataset type.
+ */ + DatasetType?: DatasetType | string; + + /** + *Filter the datasets to include datasets created after the specified time.
+ */ + CreationTimeAfter?: Date; + + /** + *Filter the datasets to include datasets created before the specified time.
+ */ + CreationTimeBefore?: Date; +} + +export interface ListDatasetsRequest { + /** + *The Amazon Resource Number (ARN) of the flywheel.
+ */ + FlywheelArn?: string; + + /** + *Filters the datasets to be returned in the response.
+ */ + Filter?: DatasetFilter; + + /** + *Identifies the next page of results to return.
+ */ + NextToken?: string; + + /** + *Maximum number of results to return in a response. The default is 100.
+ */ + MaxResults?: number; +} + +export interface ListDatasetsResponse { + /** + *The dataset properties list.
+ */ + DatasetPropertiesList?: DatasetProperties[]; + + /** + *Identifies the next page of results to return.
+ */ + NextToken?: string; +} + /** *Provides information for filtering a list of document classification jobs. For more * information, see the operation. You can @@ -4448,7 +5225,8 @@ export interface ListDocumentClassificationJobsResponse { /** *
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.
+ * one filtering parameter in a request. For more information, see the + *ListDocumentClassifiers operation.
*/
export interface DocumentClassifierFilter {
/**
@@ -4745,7 +5523,8 @@ export interface ListEntitiesDetectionJobsResponse {
/**
* 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./>
+ * filtering parameter in a request. For more information, see the + *ListEntityRecognizers operation./>
*/
export interface EntityRecognizerFilter {
/**
@@ -4853,7 +5632,7 @@ export interface ListEntityRecognizerSummariesResponse {
EntityRecognizerSummariesList?: EntityRecognizerSummary[];
/**
- * The list entity recognizer summaries.
+ *Identifies the next page of results to return.
*/ NextToken?: string; } @@ -4918,6 +5697,157 @@ export interface ListEventsDetectionJobsResponse { NextToken?: string; } +/** + *Filter the flywheel iterations based on creation time.
+ */ +export interface FlywheelIterationFilter { + /** + *Filter the flywheel iterations to include iterations created after the specified time.
+ */ + CreationTimeAfter?: Date; + + /** + *Filter the flywheel iterations to include iterations created before the specified time.
+ */ + CreationTimeBefore?: Date; +} + +export interface ListFlywheelIterationHistoryRequest { + /** + *The ARN of the flywheel.
+ */ + FlywheelArn: string | undefined; + + /** + *Filter the flywheel iteration history based on creation time.
+ */ + Filter?: FlywheelIterationFilter; + + /** + *Next token
+ */ + NextToken?: string; + + /** + *Maximum number of iteration history results to return
+ */ + MaxResults?: number; +} + +export interface ListFlywheelIterationHistoryResponse { + /** + *List of flywheel iteration properties
+ */ + FlywheelIterationPropertiesList?: FlywheelIterationProperties[]; + + /** + *Next token
+ */ + NextToken?: string; +} + +/** + *Filter the flywheels based on creation time or flywheel status.
+ */ +export interface FlywheelFilter { + /** + *Filter the flywheels based on the flywheel status.
+ */ + Status?: FlywheelStatus | string; + + /** + *Filter the flywheels to include flywheels created after the specified time.
+ */ + CreationTimeAfter?: Date; + + /** + *Filter the flywheels to include flywheels created before the specified time.
+ */ + CreationTimeBefore?: Date; +} + +export interface ListFlywheelsRequest { + /** + *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. + *
+ */ + Filter?: FlywheelFilter; + + /** + *Identifies the next page of results to return.
+ */ + NextToken?: string; + + /** + *Maximum number of results to return in a response. The default is 100.
+ */ + MaxResults?: number; +} + +/** + *Flywheel summary information.
+ */ +export interface FlywheelSummary { + /** + *The Amazon Resource Number (ARN) of the flywheel
+ */ + FlywheelArn?: string; + + /** + *ARN of the active model version for the flywheel.
+ */ + ActiveModelArn?: string; + + /** + *Amazon S3 URI of the data lake location.
+ */ + DataLakeS3Uri?: string; + + /** + *The status of the flywheel.
+ */ + Status?: FlywheelStatus | string; + + /** + *Model type of the flywheel's model.
+ */ + ModelType?: ModelType | string; + + /** + *A description of the status of the flywheel.
+ */ + Message?: string; + + /** + *Creation time of the flywheel.
+ */ + CreationTime?: Date; + + /** + *Last modified time for the flywheel.
+ */ + LastModifiedTime?: Date; + + /** + *The most recent flywheel iteration.
+ */ + LatestFlywheelIteration?: string; +} + +export interface ListFlywheelsResponse { + /** + *A list of flywheel properties retrieved by the service in response to the request. + *
+ */ + FlywheelSummaryList?: FlywheelSummary[]; + + /** + *Identifies the next page of results to return.
+ */ + NextToken?: string; +} + /** *Provides information for filtering a list of dominant language detection jobs. For more * information, see the operation.
@@ -5126,7 +6056,7 @@ export interface ListTagsForResourceResponse { /** *Provides information for filtering a list of dominant language detection jobs. For more - * information, see the operation.
+ * information, see theListTargetedSentimentDetectionJobs operation.
*/
export interface TargetedSentimentDetectionJobFilter {
/**
@@ -5294,7 +6224,7 @@ export interface StartDocumentClassificationJobRequest {
* The Amazon Resource Name (ARN) of the document classifier to use to process the * job.
*/ - DocumentClassifierArn: string | undefined; + DocumentClassifierArn?: string; /** *Specifies the format and location of the input data for the job.
@@ -5345,17 +6275,22 @@ export interface StartDocumentClassificationJobRequest { VpcConfig?: VpcConfig; /** - *Tags to be associated with the document classification job. A tag is a key-value pair that + *
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.
*/ Tags?: Tag[]; + + /** + *The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
+ */ + FlywheelArn?: string; } export interface StartDocumentClassificationJobResponse { /** *The identifier generated for the job. To get the status of the job, use this identifier - * with the operation.
+ * with theDescribeDocumentClassificationJob operation.
*/
JobId?: string;
@@ -5386,7 +6321,8 @@ export interface StartDocumentClassificationJobResponse {
* COMPLETED - The job was successfully completed and the output is available.
*FAILED - The job did not complete. For details, use the operation.
+ *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 @@ -5398,6 +6334,11 @@ export interface StartDocumentClassificationJobResponse { *
The ARN of the custom classification model.
+ */ + DocumentClassifierArn?: string; } export interface StartDominantLanguageDetectionJobRequest { @@ -5454,7 +6395,7 @@ export interface StartDominantLanguageDetectionJobRequest { VpcConfig?: VpcConfig; /** - *Tags to be associated with the dominant language detection job. A tag is a key-value pair + *
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.
*/ @@ -5571,11 +6512,16 @@ export interface StartEntitiesDetectionJobRequest { VpcConfig?: VpcConfig; /** - *Tags to be associated with the entities detection job. A tag is a key-value pair that adds + *
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.
*/ Tags?: Tag[]; + + /** + *The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
+ */ + FlywheelArn?: string; } export interface StartEntitiesDetectionJobResponse { @@ -5624,6 +6570,11 @@ export interface StartEntitiesDetectionJobResponse { *The ARN of the custom entity recognition model.
+ */ + EntityRecognizerArn?: string; } export interface StartEventsDetectionJobRequest { @@ -5665,7 +6616,7 @@ export interface StartEventsDetectionJobRequest { TargetEventTypes: string[] | undefined; /** - *Tags to be associated with the events detection job. A tag is a key-value pair that adds + *
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.
*/ @@ -5699,6 +6650,31 @@ export interface StartEventsDetectionJobResponse { JobStatus?: JobStatus | string; } +export interface StartFlywheelIterationRequest { + /** + *The ARN of the flywheel.
+ */ + FlywheelArn: string | undefined; + + /** + *A unique identifier for the request. If you don't set the client request token, Amazon + * Comprehend generates one.
+ */ + ClientRequestToken?: string; +} + +export interface StartFlywheelIterationResponse { + /** + * + */ + FlywheelArn?: string; + + /** + * + */ + FlywheelIterationId?: string; +} + export interface StartKeyPhrasesDetectionJobRequest { /** *Specifies the format and location of the input data for the job.
@@ -5760,7 +6736,7 @@ export interface StartKeyPhrasesDetectionJobRequest { VpcConfig?: VpcConfig; /** - *Tags to be associated with the key phrases detection job. A tag is a key-value pair that + *
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.
*/ @@ -5856,7 +6832,7 @@ export interface StartPiiEntitiesDetectionJobRequest { ClientRequestToken?: string; /** - *Tags to be associated with the PII entities detection job. A tag is a key-value pair that + *
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.
*/ @@ -5949,7 +6925,7 @@ export interface StartSentimentDetectionJobRequest { VpcConfig?: VpcConfig; /** - *Tags to be associated with the sentiment detection job. A tag is a key-value pair that + *
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.
*/ @@ -6057,7 +7033,7 @@ export interface StartTargetedSentimentDetectionJobRequest { VpcConfig?: VpcConfig; /** - *Tags to be associated with the targeted sentiment detection job. A tag is a key-value pair that + *
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.
*/ @@ -6067,7 +7043,7 @@ export interface StartTargetedSentimentDetectionJobRequest { export interface StartTargetedSentimentDetectionJobResponse { /** *The identifier generated for the job. To get the status of a job, use this identifier with - * the operation.
+ * theDescribeTargetedSentimentDetectionJob operation.
*/
JobId?: string;
@@ -6098,7 +7074,8 @@ export interface StartTargetedSentimentDetectionJobResponse {
* COMPLETED - The job was successfully completed and the output is available.
* *FAILED - The job did not complete. To get details, use the operation.
+ *FAILED - The job did not complete. To get details, use the
+ * DescribeTargetedSentimentDetectionJob operation.
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.
+ *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.
*/ DataAccessRoleArn: string | undefined; @@ -6166,7 +7143,7 @@ export interface StartTopicsDetectionJobRequest { VpcConfig?: VpcConfig; /** - *Tags to be associated with the topics detection job. A tag is a key-value pair that adds + *
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.
*/ @@ -6338,151 +7315,6 @@ export interface StopSentimentDetectionJobResponse { JobStatus?: JobStatus | string; } -export interface StopTargetedSentimentDetectionJobRequest { - /** - *The identifier of the targeted sentiment detection job to stop.
- */ - JobId: string | undefined; -} - -export interface StopTargetedSentimentDetectionJobResponse { - /** - *The identifier of the targeted sentiment detection job to stop.
- */ - JobId?: string; - - /** - *Either STOP_REQUESTED if the job is currently running, or
- * STOPPED if the job was previously stopped with the
- * StopSentimentDetectionJob operation.
The Amazon Resource Name (ARN) that identifies the document classifier currently being - * trained.
- */ - DocumentClassifierArn: string | undefined; -} - -export interface StopTrainingDocumentClassifierResponse {} - -export interface StopTrainingEntityRecognizerRequest { - /** - *The Amazon Resource Name (ARN) that identifies the entity recognizer currently being - * trained.
- */ - EntityRecognizerArn: string | undefined; -} - -export interface StopTrainingEntityRecognizerResponse {} - -/** - *Concurrent modification of the tags associated with an Amazon Comprehend resource is not - * supported.
- */ -export class ConcurrentModificationException extends __BaseException { - readonly name: "ConcurrentModificationException" = "ConcurrentModificationException"; - readonly $fault: "client" = "client"; - Message?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want - * to associate the tags.
- */ - ResourceArn: string | undefined; - - /** - *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.
- */ - Tags: Tag[] | undefined; -} - -export interface TagResourceResponse {} - -/** - *The request contains more tag keys than can be associated with a resource (50 tag keys per - * resource).
- */ -export class TooManyTagKeysException extends __BaseException { - readonly name: "TooManyTagKeysException" = "TooManyTagKeysException"; - readonly $fault: "client" = "client"; - Message?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you - * want to remove the tags.
- */ - ResourceArn: string | undefined; - - /** - *The initial part of a key-value pair that forms a tag being removed from a given resource. - * For example, a tag with "Sales" as the key might be added to a resource to indicate its use by - * the sales department. Keys must be unique and cannot be duplicated for a particular resource. - *
- */ - TagKeys: string[] | undefined; -} - -export interface UntagResourceResponse {} - -export interface UpdateEndpointRequest { - /** - *The Amazon Resource Number (ARN) of the endpoint being updated.
- */ - EndpointArn: string | undefined; - - /** - *The ARN of the new model to use when updating an existing endpoint.
- */ - DesiredModelArn?: 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?: number; - - /** - *Data access role ARN to use in case the new model is encrypted with a customer CMK.
- */ - DesiredDataAccessRoleArn?: string; -} - -export interface UpdateEndpointResponse {} - /** * @internal */ @@ -6784,237 +7616,381 @@ export const DocumentReaderConfigFilterSensitiveLog = (obj: DocumentReaderConfig */ export const ClassifyDocumentRequestFilterSensitiveLog = (obj: ClassifyDocumentRequest): any => ({ ...obj, - ...(obj.Text && { Text: SENSITIVE_STRING }), + ...(obj.Text && { Text: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const DocumentClassFilterSensitiveLog = (obj: DocumentClass): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ExtractedCharactersListItemFilterSensitiveLog = (obj: ExtractedCharactersListItem): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DocumentMetadataFilterSensitiveLog = (obj: DocumentMetadata): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DocumentTypeListItemFilterSensitiveLog = (obj: DocumentTypeListItem): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ErrorsListItemFilterSensitiveLog = (obj: ErrorsListItem): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DocumentLabelFilterSensitiveLog = (obj: DocumentLabel): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ClassifyDocumentResponseFilterSensitiveLog = (obj: ClassifyDocumentResponse): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ContainsPiiEntitiesRequestFilterSensitiveLog = (obj: ContainsPiiEntitiesRequest): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const EntityLabelFilterSensitiveLog = (obj: EntityLabel): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ContainsPiiEntitiesResponseFilterSensitiveLog = (obj: ContainsPiiEntitiesResponse): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DatasetAugmentedManifestsListItemFilterSensitiveLog = (obj: DatasetAugmentedManifestsListItem): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DatasetDocumentClassifierInputDataConfigFilterSensitiveLog = ( + obj: DatasetDocumentClassifierInputDataConfig +): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DatasetEntityRecognizerAnnotationsFilterSensitiveLog = (obj: DatasetEntityRecognizerAnnotations): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DatasetEntityRecognizerDocumentsFilterSensitiveLog = (obj: DatasetEntityRecognizerDocuments): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DatasetEntityRecognizerEntityListFilterSensitiveLog = (obj: DatasetEntityRecognizerEntityList): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DatasetEntityRecognizerInputDataConfigFilterSensitiveLog = ( + obj: DatasetEntityRecognizerInputDataConfig +): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DatasetInputDataConfigFilterSensitiveLog = (obj: DatasetInputDataConfig): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const TagFilterSensitiveLog = (obj: Tag): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const CreateDatasetRequestFilterSensitiveLog = (obj: CreateDatasetRequest): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const CreateDatasetResponseFilterSensitiveLog = (obj: CreateDatasetResponse): any => ({ + ...obj, }); /** * @internal */ -export const DocumentClassFilterSensitiveLog = (obj: DocumentClass): any => ({ +export const DocumentClassifierInputDataConfigFilterSensitiveLog = (obj: DocumentClassifierInputDataConfig): any => ({ ...obj, }); /** * @internal */ -export const ExtractedCharactersListItemFilterSensitiveLog = (obj: ExtractedCharactersListItem): any => ({ +export const DocumentClassifierOutputDataConfigFilterSensitiveLog = (obj: DocumentClassifierOutputDataConfig): any => ({ ...obj, }); /** * @internal */ -export const DocumentMetadataFilterSensitiveLog = (obj: DocumentMetadata): any => ({ +export const VpcConfigFilterSensitiveLog = (obj: VpcConfig): any => ({ ...obj, }); /** * @internal */ -export const DocumentTypeListItemFilterSensitiveLog = (obj: DocumentTypeListItem): any => ({ +export const CreateDocumentClassifierRequestFilterSensitiveLog = (obj: CreateDocumentClassifierRequest): any => ({ ...obj, }); /** * @internal */ -export const ErrorsListItemFilterSensitiveLog = (obj: ErrorsListItem): any => ({ +export const CreateDocumentClassifierResponseFilterSensitiveLog = (obj: CreateDocumentClassifierResponse): any => ({ ...obj, }); /** * @internal */ -export const DocumentLabelFilterSensitiveLog = (obj: DocumentLabel): any => ({ +export const CreateEndpointRequestFilterSensitiveLog = (obj: CreateEndpointRequest): any => ({ ...obj, }); /** * @internal */ -export const ClassifyDocumentResponseFilterSensitiveLog = (obj: ClassifyDocumentResponse): any => ({ +export const CreateEndpointResponseFilterSensitiveLog = (obj: CreateEndpointResponse): any => ({ ...obj, }); /** * @internal */ -export const ContainsPiiEntitiesRequestFilterSensitiveLog = (obj: ContainsPiiEntitiesRequest): any => ({ +export const EntityRecognizerAnnotationsFilterSensitiveLog = (obj: EntityRecognizerAnnotations): any => ({ ...obj, }); /** * @internal */ -export const EntityLabelFilterSensitiveLog = (obj: EntityLabel): any => ({ +export const EntityRecognizerDocumentsFilterSensitiveLog = (obj: EntityRecognizerDocuments): any => ({ ...obj, }); /** * @internal */ -export const ContainsPiiEntitiesResponseFilterSensitiveLog = (obj: ContainsPiiEntitiesResponse): any => ({ +export const EntityRecognizerEntityListFilterSensitiveLog = (obj: EntityRecognizerEntityList): any => ({ ...obj, }); /** * @internal */ -export const DocumentClassifierInputDataConfigFilterSensitiveLog = (obj: DocumentClassifierInputDataConfig): any => ({ +export const EntityTypesListItemFilterSensitiveLog = (obj: EntityTypesListItem): any => ({ ...obj, }); /** * @internal */ -export const DocumentClassifierOutputDataConfigFilterSensitiveLog = (obj: DocumentClassifierOutputDataConfig): any => ({ +export const EntityRecognizerInputDataConfigFilterSensitiveLog = (obj: EntityRecognizerInputDataConfig): any => ({ ...obj, }); /** * @internal */ -export const TagFilterSensitiveLog = (obj: Tag): any => ({ +export const CreateEntityRecognizerRequestFilterSensitiveLog = (obj: CreateEntityRecognizerRequest): any => ({ ...obj, }); /** * @internal */ -export const VpcConfigFilterSensitiveLog = (obj: VpcConfig): any => ({ +export const CreateEntityRecognizerResponseFilterSensitiveLog = (obj: CreateEntityRecognizerResponse): any => ({ ...obj, }); /** * @internal */ -export const CreateDocumentClassifierRequestFilterSensitiveLog = (obj: CreateDocumentClassifierRequest): any => ({ +export const DataSecurityConfigFilterSensitiveLog = (obj: DataSecurityConfig): any => ({ ...obj, }); /** * @internal */ -export const CreateDocumentClassifierResponseFilterSensitiveLog = (obj: CreateDocumentClassifierResponse): any => ({ +export const DocumentClassificationConfigFilterSensitiveLog = (obj: DocumentClassificationConfig): any => ({ ...obj, }); /** * @internal */ -export const CreateEndpointRequestFilterSensitiveLog = (obj: CreateEndpointRequest): any => ({ +export const EntityRecognitionConfigFilterSensitiveLog = (obj: EntityRecognitionConfig): any => ({ ...obj, }); /** * @internal */ -export const CreateEndpointResponseFilterSensitiveLog = (obj: CreateEndpointResponse): any => ({ +export const TaskConfigFilterSensitiveLog = (obj: TaskConfig): any => ({ ...obj, }); /** * @internal */ -export const EntityRecognizerAnnotationsFilterSensitiveLog = (obj: EntityRecognizerAnnotations): any => ({ +export const CreateFlywheelRequestFilterSensitiveLog = (obj: CreateFlywheelRequest): any => ({ ...obj, }); /** * @internal */ -export const EntityRecognizerDocumentsFilterSensitiveLog = (obj: EntityRecognizerDocuments): any => ({ +export const CreateFlywheelResponseFilterSensitiveLog = (obj: CreateFlywheelResponse): any => ({ ...obj, }); /** * @internal */ -export const EntityRecognizerEntityListFilterSensitiveLog = (obj: EntityRecognizerEntityList): any => ({ +export const DeleteDocumentClassifierRequestFilterSensitiveLog = (obj: DeleteDocumentClassifierRequest): any => ({ ...obj, }); /** * @internal */ -export const EntityTypesListItemFilterSensitiveLog = (obj: EntityTypesListItem): any => ({ +export const DeleteDocumentClassifierResponseFilterSensitiveLog = (obj: DeleteDocumentClassifierResponse): any => ({ ...obj, }); /** * @internal */ -export const EntityRecognizerInputDataConfigFilterSensitiveLog = (obj: EntityRecognizerInputDataConfig): any => ({ +export const DeleteEndpointRequestFilterSensitiveLog = (obj: DeleteEndpointRequest): any => ({ ...obj, }); /** * @internal */ -export const CreateEntityRecognizerRequestFilterSensitiveLog = (obj: CreateEntityRecognizerRequest): any => ({ +export const DeleteEndpointResponseFilterSensitiveLog = (obj: DeleteEndpointResponse): any => ({ ...obj, }); /** * @internal */ -export const CreateEntityRecognizerResponseFilterSensitiveLog = (obj: CreateEntityRecognizerResponse): any => ({ +export const DeleteEntityRecognizerRequestFilterSensitiveLog = (obj: DeleteEntityRecognizerRequest): any => ({ ...obj, }); /** * @internal */ -export const DeleteDocumentClassifierRequestFilterSensitiveLog = (obj: DeleteDocumentClassifierRequest): any => ({ +export const DeleteEntityRecognizerResponseFilterSensitiveLog = (obj: DeleteEntityRecognizerResponse): any => ({ ...obj, }); /** * @internal */ -export const DeleteDocumentClassifierResponseFilterSensitiveLog = (obj: DeleteDocumentClassifierResponse): any => ({ +export const DeleteFlywheelRequestFilterSensitiveLog = (obj: DeleteFlywheelRequest): any => ({ ...obj, }); /** * @internal */ -export const DeleteEndpointRequestFilterSensitiveLog = (obj: DeleteEndpointRequest): any => ({ +export const DeleteFlywheelResponseFilterSensitiveLog = (obj: DeleteFlywheelResponse): any => ({ ...obj, }); /** * @internal */ -export const DeleteEndpointResponseFilterSensitiveLog = (obj: DeleteEndpointResponse): any => ({ +export const DeleteResourcePolicyRequestFilterSensitiveLog = (obj: DeleteResourcePolicyRequest): any => ({ ...obj, }); /** * @internal */ -export const DeleteEntityRecognizerRequestFilterSensitiveLog = (obj: DeleteEntityRecognizerRequest): any => ({ +export const DeleteResourcePolicyResponseFilterSensitiveLog = (obj: DeleteResourcePolicyResponse): any => ({ ...obj, }); /** * @internal */ -export const DeleteEntityRecognizerResponseFilterSensitiveLog = (obj: DeleteEntityRecognizerResponse): any => ({ +export const DescribeDatasetRequestFilterSensitiveLog = (obj: DescribeDatasetRequest): any => ({ ...obj, }); /** * @internal */ -export const DeleteResourcePolicyRequestFilterSensitiveLog = (obj: DeleteResourcePolicyRequest): any => ({ +export const DatasetPropertiesFilterSensitiveLog = (obj: DatasetProperties): any => ({ ...obj, }); /** * @internal */ -export const DeleteResourcePolicyResponseFilterSensitiveLog = (obj: DeleteResourcePolicyResponse): any => ({ +export const DescribeDatasetResponseFilterSensitiveLog = (obj: DescribeDatasetResponse): any => ({ ...obj, }); @@ -7164,6 +8140,13 @@ export const DescribeEntityRecognizerRequestFilterSensitiveLog = (obj: DescribeE ...obj, }); +/** + * @internal + */ +export const EntityRecognizerOutputDataConfigFilterSensitiveLog = (obj: EntityRecognizerOutputDataConfig): any => ({ + ...obj, +}); + /** * @internal */ @@ -7233,6 +8216,55 @@ export const DescribeEventsDetectionJobResponseFilterSensitiveLog = (obj: Descri ...obj, }); +/** + * @internal + */ +export const DescribeFlywheelRequestFilterSensitiveLog = (obj: DescribeFlywheelRequest): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const FlywheelPropertiesFilterSensitiveLog = (obj: FlywheelProperties): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DescribeFlywheelResponseFilterSensitiveLog = (obj: DescribeFlywheelResponse): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DescribeFlywheelIterationRequestFilterSensitiveLog = (obj: DescribeFlywheelIterationRequest): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const FlywheelModelEvaluationMetricsFilterSensitiveLog = (obj: FlywheelModelEvaluationMetrics): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const FlywheelIterationPropertiesFilterSensitiveLog = (obj: FlywheelIterationProperties): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DescribeFlywheelIterationResponseFilterSensitiveLog = (obj: DescribeFlywheelIterationResponse): any => ({ + ...obj, +}); + /** * @internal */ @@ -7509,6 +8541,27 @@ export const ImportModelResponseFilterSensitiveLog = (obj: ImportModelResponse): ...obj, }); +/** + * @internal + */ +export const DatasetFilterFilterSensitiveLog = (obj: DatasetFilter): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ListDatasetsRequestFilterSensitiveLog = (obj: ListDatasetsRequest): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ListDatasetsResponseFilterSensitiveLog = (obj: ListDatasetsResponse): any => ({ + ...obj, +}); + /** * @internal */ @@ -7724,6 +8777,59 @@ export const ListEventsDetectionJobsResponseFilterSensitiveLog = (obj: ListEvent ...obj, }); +/** + * @internal + */ +export const FlywheelIterationFilterFilterSensitiveLog = (obj: FlywheelIterationFilter): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ListFlywheelIterationHistoryRequestFilterSensitiveLog = ( + obj: ListFlywheelIterationHistoryRequest +): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ListFlywheelIterationHistoryResponseFilterSensitiveLog = ( + obj: ListFlywheelIterationHistoryResponse +): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const FlywheelFilterFilterSensitiveLog = (obj: FlywheelFilter): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ListFlywheelsRequestFilterSensitiveLog = (obj: ListFlywheelsRequest): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const FlywheelSummaryFilterSensitiveLog = (obj: FlywheelSummary): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ListFlywheelsResponseFilterSensitiveLog = (obj: ListFlywheelsResponse): any => ({ + ...obj, +}); + /** * @internal */ @@ -7933,6 +9039,20 @@ export const StartEventsDetectionJobResponseFilterSensitiveLog = (obj: StartEven ...obj, }); +/** + * @internal + */ +export const StartFlywheelIterationRequestFilterSensitiveLog = (obj: StartFlywheelIterationRequest): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const StartFlywheelIterationResponseFilterSensitiveLog = (obj: StartFlywheelIterationResponse): any => ({ + ...obj, +}); + /** * @internal */ @@ -8102,99 +9222,3 @@ export const StopSentimentDetectionJobRequestFilterSensitiveLog = (obj: StopSent export const StopSentimentDetectionJobResponseFilterSensitiveLog = (obj: StopSentimentDetectionJobResponse): any => ({ ...obj, }); - -/** - * @internal - */ -export const StopTargetedSentimentDetectionJobRequestFilterSensitiveLog = ( - obj: StopTargetedSentimentDetectionJobRequest -): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const StopTargetedSentimentDetectionJobResponseFilterSensitiveLog = ( - obj: StopTargetedSentimentDetectionJobResponse -): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const StopTrainingDocumentClassifierRequestFilterSensitiveLog = ( - obj: StopTrainingDocumentClassifierRequest -): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const StopTrainingDocumentClassifierResponseFilterSensitiveLog = ( - obj: StopTrainingDocumentClassifierResponse -): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const StopTrainingEntityRecognizerRequestFilterSensitiveLog = ( - obj: StopTrainingEntityRecognizerRequest -): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const StopTrainingEntityRecognizerResponseFilterSensitiveLog = ( - obj: StopTrainingEntityRecognizerResponse -): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const TagResourceRequestFilterSensitiveLog = (obj: TagResourceRequest): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const TagResourceResponseFilterSensitiveLog = (obj: TagResourceResponse): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const UntagResourceRequestFilterSensitiveLog = (obj: UntagResourceRequest): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const UntagResourceResponseFilterSensitiveLog = (obj: UntagResourceResponse): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const UpdateEndpointRequestFilterSensitiveLog = (obj: UpdateEndpointRequest): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const UpdateEndpointResponseFilterSensitiveLog = (obj: UpdateEndpointResponse): any => ({ - ...obj, -}); diff --git a/clients/client-comprehend/src/models/models_1.ts b/clients/client-comprehend/src/models/models_1.ts new file mode 100644 index 000000000000..832b0cf5fc0e --- /dev/null +++ b/clients/client-comprehend/src/models/models_1.ts @@ -0,0 +1,341 @@ +// smithy-typescript generated code +import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client"; + +import { ComprehendServiceException as __BaseException } from "./ComprehendServiceException"; +import { FlywheelProperties, JobStatus, Tag, VpcConfig } from "./models_0"; + +export interface StopTargetedSentimentDetectionJobRequest { + /** + *The identifier of the targeted sentiment detection job to stop.
+ */ + JobId: string | undefined; +} + +export interface StopTargetedSentimentDetectionJobResponse { + /** + *The identifier of the targeted sentiment detection job to stop.
+ */ + JobId?: string; + + /** + *Either STOP_REQUESTED if the job is currently running, or
+ * STOPPED if the job was previously stopped with the
+ * StopSentimentDetectionJob operation.
The Amazon Resource Name (ARN) that identifies the document classifier currently being + * trained.
+ */ + DocumentClassifierArn: string | undefined; +} + +export interface StopTrainingDocumentClassifierResponse {} + +export interface StopTrainingEntityRecognizerRequest { + /** + *The Amazon Resource Name (ARN) that identifies the entity recognizer currently being + * trained.
+ */ + EntityRecognizerArn: string | undefined; +} + +export interface StopTrainingEntityRecognizerResponse {} + +/** + *Concurrent modification of the tags associated with an Amazon Comprehend resource is not + * supported.
+ */ +export class ConcurrentModificationException extends __BaseException { + readonly name: "ConcurrentModificationException" = "ConcurrentModificationException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want + * to associate the tags.
+ */ + ResourceArn: string | undefined; + + /** + *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.
+ */ + Tags: Tag[] | undefined; +} + +export interface TagResourceResponse {} + +/** + *The request contains more tag keys than can be associated with a resource (50 tag keys per + * resource).
+ */ +export class TooManyTagKeysException extends __BaseException { + readonly name: "TooManyTagKeysException" = "TooManyTagKeysException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you + * want to remove the tags.
+ */ + ResourceArn: string | undefined; + + /** + *The initial part of a key-value pair that forms a tag being removed from a given resource. + * For example, a tag with "Sales" as the key might be added to a resource to indicate its use by + * the sales department. Keys must be unique and cannot be duplicated for a particular resource. + *
+ */ + TagKeys: string[] | undefined; +} + +export interface UntagResourceResponse {} + +export interface UpdateEndpointRequest { + /** + *The Amazon Resource Number (ARN) of the endpoint being updated.
+ */ + EndpointArn: string | undefined; + + /** + *The ARN of the new model to use when updating an existing endpoint.
+ */ + DesiredModelArn?: 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?: number; + + /** + *Data access role ARN to use in case the new model is encrypted with a customer CMK.
+ */ + DesiredDataAccessRoleArn?: string; + + /** + *The Amazon Resource Number (ARN) of the flywheel
+ */ + FlywheelArn?: string; +} + +export interface UpdateEndpointResponse { + /** + *The Amazon Resource Number (ARN) of the new model.
+ */ + DesiredModelArn?: string; +} + +/** + *Data security configuration.
+ */ +export interface UpdateDataSecurityConfig { + /** + *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.
+ */ + VolumeKmsKeyId?: 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.
+ */ + VpcConfig?: VpcConfig; +} + +export interface UpdateFlywheelRequest { + /** + *The Amazon Resource Number (ARN) of the flywheel to update.
+ */ + FlywheelArn: string | undefined; + + /** + *The Amazon Resource Number (ARN) of the active model version.
+ */ + ActiveModelArn?: string; + + /** + *The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that + * grants Amazon Comprehend permission to access the flywheel data.
+ */ + DataAccessRoleArn?: string; + + /** + *Flywheel data security configuration.
+ */ + DataSecurityConfig?: UpdateDataSecurityConfig; +} + +export interface UpdateFlywheelResponse { + /** + *The flywheel properties.
+ */ + FlywheelProperties?: FlywheelProperties; +} + +/** + * @internal + */ +export const StopTargetedSentimentDetectionJobRequestFilterSensitiveLog = ( + obj: StopTargetedSentimentDetectionJobRequest +): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const StopTargetedSentimentDetectionJobResponseFilterSensitiveLog = ( + obj: StopTargetedSentimentDetectionJobResponse +): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const StopTrainingDocumentClassifierRequestFilterSensitiveLog = ( + obj: StopTrainingDocumentClassifierRequest +): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const StopTrainingDocumentClassifierResponseFilterSensitiveLog = ( + obj: StopTrainingDocumentClassifierResponse +): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const StopTrainingEntityRecognizerRequestFilterSensitiveLog = ( + obj: StopTrainingEntityRecognizerRequest +): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const StopTrainingEntityRecognizerResponseFilterSensitiveLog = ( + obj: StopTrainingEntityRecognizerResponse +): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const TagResourceRequestFilterSensitiveLog = (obj: TagResourceRequest): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const TagResourceResponseFilterSensitiveLog = (obj: TagResourceResponse): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const UntagResourceRequestFilterSensitiveLog = (obj: UntagResourceRequest): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const UntagResourceResponseFilterSensitiveLog = (obj: UntagResourceResponse): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const UpdateEndpointRequestFilterSensitiveLog = (obj: UpdateEndpointRequest): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const UpdateEndpointResponseFilterSensitiveLog = (obj: UpdateEndpointResponse): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const UpdateDataSecurityConfigFilterSensitiveLog = (obj: UpdateDataSecurityConfig): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const UpdateFlywheelRequestFilterSensitiveLog = (obj: UpdateFlywheelRequest): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const UpdateFlywheelResponseFilterSensitiveLog = (obj: UpdateFlywheelResponse): any => ({ + ...obj, +}); diff --git a/clients/client-comprehend/src/pagination/ListDatasetsPaginator.ts b/clients/client-comprehend/src/pagination/ListDatasetsPaginator.ts new file mode 100644 index 000000000000..1b23cb6be19c --- /dev/null +++ b/clients/client-comprehend/src/pagination/ListDatasetsPaginator.ts @@ -0,0 +1,61 @@ +// smithy-typescript generated code +import { Paginator } from "@aws-sdk/types"; + +import { + ListDatasetsCommand, + ListDatasetsCommandInput, + ListDatasetsCommandOutput, +} from "../commands/ListDatasetsCommand"; +import { Comprehend } from "../Comprehend"; +import { ComprehendClient } from "../ComprehendClient"; +import { ComprehendPaginationConfiguration } from "./Interfaces"; + +/** + * @private + */ +const makePagedClientRequest = async ( + client: ComprehendClient, + input: ListDatasetsCommandInput, + ...args: any +): PromiseThe block represents a line of text or one word of text.
\nWORD - A word that's detected on a document page. \n A word is one or more ISO basic Latin script characters that aren't separated by spaces.
\nLINE - A string of tab-delimited, contiguous words \n that are detected on a document page
\nThe block represents a line of text or one word of text.
\nWORD - A word that's detected on a document page.\n A word is one or more ISO basic Latin script characters that aren't separated by spaces.
\nLINE - A string of tab-delimited, contiguous words\n that are detected on a document page
\nA list of child blocks of the current block. \n For example, a LINE object has child blocks for each WORD block that's part of the line of text.
" + "smithy.api#documentation": "A list of child blocks of the current block.\n For example, a LINE object has child blocks for each WORD block that's part of the line of text.
" } } }, @@ -814,7 +838,7 @@ } }, "traits": { - "smithy.api#documentation": "The bounding box around the detected page\n or around an element on a document page. \n The left (x-coordinate) and top (y-coordinate) are coordinates that \n represent the top and left sides of the bounding box. Note that the upper-left \n corner of the image is the origin (0,0).
\nFor additional information, see BoundingBox in the Amazon Textract API reference.
" + "smithy.api#documentation": "The bounding box around the detected page\n or around an element on a document page.\n The left (x-coordinate) and top (y-coordinate) are coordinates that\n represent the top and left sides of the bounding box. Note that the upper-left\n corner of the image is the origin (0,0).
\nFor additional information, see BoundingBox in the Amazon Textract API reference.
" } }, "com.amazonaws.comprehend#ChildBlock": { @@ -955,7 +979,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new document classification request to analyze a single document in real-time,\n using a previously created and trained custom model and an endpoint.
\nYou can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
\nIf the system detects errors while processing a page in the input document, \n 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 \n InvalidRequestException error response. \n For details about this exception, see\n \n Errors in semi-structured documents in the Comprehend Developer Guide. \n
Creates a new document classification request to analyze a single document in real-time,\n using a previously created and trained custom model and an endpoint.
\nYou can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
\nIf the system detects errors while processing a page in the input document,\n 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\n InvalidRequestException error response.\n For details about this exception, see\n \n Errors in semi-structured documents in the Comprehend Developer Guide.\n
Use the Bytes parameter to input a text, PDF, Word or image file.\n You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText \n or AnalyzeDocument output file.
Provide the input document as a sequence of base64-encoded bytes. \n If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode \n the document file bytes for you.
\nThe maximum length of this field depends on the input document type. For details, see\n \n Inputs for real-time custom analysis in the Comprehend Developer Guide.
\nIf you use the Bytes parameter, do not use the Text parameter.
Use the Bytes parameter to input a text, PDF, Word or image file.\n You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText\n or AnalyzeDocument output file.
Provide the input document as a sequence of base64-encoded bytes.\n If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode\n the document file bytes for you.
\nThe maximum length of this field depends on the input document type. For details, see\n \n Inputs for real-time custom analysis in the Comprehend Developer Guide.
\nIf you use the Bytes parameter, do not use the Text parameter.
Provides configuration parameters to override the default actions for extracting text \n from PDF documents and image files.
" + "smithy.api#documentation": "Provides configuration parameters to override the default actions for extracting text\n from PDF documents and image files.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ClassifyDocumentResponse": { @@ -1018,11 +1045,12 @@ "Errors": { "target": "com.amazonaws.comprehend#ListOfErrors", "traits": { - "smithy.api#documentation": "Page-level errors that the system detected while processing the input document. \n The field is empty if the system encountered no errors.
" + "smithy.api#documentation": "Page-level errors that the system detected while processing the input document.\n The field is empty if the system encountered no errors.
" } } }, "traits": { + "smithy.api#output": {}, "smithy.api#sensitive": {} } }, @@ -1043,7 +1071,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?$" + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0-9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))?$" } }, "com.amazonaws.comprehend#ComprehendArnName": { @@ -1056,6 +1084,16 @@ "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" } }, + "com.amazonaws.comprehend#ComprehendDatasetArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])*/dataset/[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, "com.amazonaws.comprehend#ComprehendEndpointArn": { "type": "string", "traits": { @@ -1076,6 +1114,16 @@ "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" } }, + "com.amazonaws.comprehend#ComprehendFlywheelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, "com.amazonaws.comprehend#ComprehendModelArn": { "type": "string", "traits": { @@ -1114,6 +1162,9 @@ { "target": "com.amazonaws.comprehend#ContainsPiiEntities" }, + { + "target": "com.amazonaws.comprehend#CreateDataset" + }, { "target": "com.amazonaws.comprehend#CreateDocumentClassifier" }, @@ -1123,6 +1174,9 @@ { "target": "com.amazonaws.comprehend#CreateEntityRecognizer" }, + { + "target": "com.amazonaws.comprehend#CreateFlywheel" + }, { "target": "com.amazonaws.comprehend#DeleteDocumentClassifier" }, @@ -1132,9 +1186,15 @@ { "target": "com.amazonaws.comprehend#DeleteEntityRecognizer" }, + { + "target": "com.amazonaws.comprehend#DeleteFlywheel" + }, { "target": "com.amazonaws.comprehend#DeleteResourcePolicy" }, + { + "target": "com.amazonaws.comprehend#DescribeDataset" + }, { "target": "com.amazonaws.comprehend#DescribeDocumentClassificationJob" }, @@ -1156,6 +1216,12 @@ { "target": "com.amazonaws.comprehend#DescribeEventsDetectionJob" }, + { + "target": "com.amazonaws.comprehend#DescribeFlywheel" + }, + { + "target": "com.amazonaws.comprehend#DescribeFlywheelIteration" + }, { "target": "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJob" }, @@ -1198,6 +1264,9 @@ { "target": "com.amazonaws.comprehend#ImportModel" }, + { + "target": "com.amazonaws.comprehend#ListDatasets" + }, { "target": "com.amazonaws.comprehend#ListDocumentClassificationJobs" }, @@ -1225,6 +1294,12 @@ { "target": "com.amazonaws.comprehend#ListEventsDetectionJobs" }, + { + "target": "com.amazonaws.comprehend#ListFlywheelIterationHistory" + }, + { + "target": "com.amazonaws.comprehend#ListFlywheels" + }, { "target": "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobs" }, @@ -1258,6 +1333,9 @@ { "target": "com.amazonaws.comprehend#StartEventsDetectionJob" }, + { + "target": "com.amazonaws.comprehend#StartFlywheelIteration" + }, { "target": "com.amazonaws.comprehend#StartKeyPhrasesDetectionJob" }, @@ -1308,6 +1386,9 @@ }, { "target": "com.amazonaws.comprehend#UpdateEndpoint" + }, + { + "target": "com.amazonaws.comprehend#UpdateFlywheel" } ], "traits": { @@ -1329,7 +1410,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -1358,13 +1439,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -1372,23 +1452,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": [ { @@ -1397,67 +1474,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" + } ] } ], @@ -1466,90 +1518,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", @@ -1557,7 +1734,7 @@ { "conditions": [], "endpoint": { - "url": "https://comprehend-fips.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://comprehend.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, @@ -1566,74 +1743,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" } ] } @@ -1642,42 +1758,29 @@ "smithy.rules#endpointTests": { "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 } }, { @@ -1688,48 +1791,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 } }, { @@ -1740,48 +1830,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 } }, { @@ -1792,100 +1843,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 } }, { @@ -1896,979 +1934,281 @@ } }, "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" + "UseDualStack": true, + "Endpoint": "https://example.com" } } ], @@ -2876,26 +2216,1150 @@ } } }, - "com.amazonaws.comprehend#ConcurrentModificationException": { + "com.amazonaws.comprehend#ConcurrentModificationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehend#String" + } + }, + "traits": { + "smithy.api#documentation": "Concurrent modification of the tags associated with an Amazon Comprehend resource is not\n supported.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.comprehend#ContainsPiiEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ContainsPiiEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ContainsPiiEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "Analyzes input text for the presence of personally identifiable information (PII) and\n returns the labels of identified PII entity types such as name, address, bank account number,\n or phone number.
" + } + }, + "com.amazonaws.comprehend#ContainsPiiEntitiesRequest": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "A UTF-8 text string. The maximum string size is 100 KB.
", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "The language of the input documents. Currently, English is the only valid language.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ContainsPiiEntitiesResponse": { + "type": "structure", + "members": { + "Labels": { + "target": "com.amazonaws.comprehend#ListOfEntityLabels", + "traits": { + "smithy.api#documentation": "The labels used in the document being analyzed. Individual labels represent personally\n identifiable information (PII) entity types.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#CreateDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#CreateDatasetRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#CreateDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a dataset to upload training or test data for a model associated with a flywheel.\n For more information about datasets, see \n Flywheel overview in the Amazon Comprehend Developer Guide.
" + } + }, + "com.amazonaws.comprehend#CreateDatasetRequest": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.
", + "smithy.api#required": {} + } + }, + "DatasetName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "Name of the dataset.
", + "smithy.api#required": {} + } + }, + "DatasetType": { + "target": "com.amazonaws.comprehend#DatasetType", + "traits": { + "smithy.api#documentation": "The dataset type. You can specify that the data in a dataset is for training\n the model or for testing the model.
" + } + }, + "Description": { + "target": "com.amazonaws.comprehend#Description", + "traits": { + "smithy.api#documentation": "Description of the dataset.
" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#DatasetInputDataConfig", + "traits": { + "smithy.api#documentation": "Information about the input data configuration. The type of input data varies based\n on the format of the input and whether the data is for a classifier model or an entity recognition model.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.
", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "Tags for the dataset.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#CreateDatasetResponse": { + "type": "structure", + "members": { + "DatasetArn": { + "target": "com.amazonaws.comprehend#ComprehendDatasetArn", + "traits": { + "smithy.api#documentation": "The ARN of the dataset.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#CreateDocumentClassifier": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#CreateDocumentClassifierRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#CreateDocumentClassifierResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new document classifier that you can use to categorize documents. To create a\n classifier, you provide a set of training documents that labeled with the categories that you\n want to use. After the classifier is trained you can use it to categorize a set of labeled\n documents into the categories. For more information, see\n Document Classification in the Comprehend Developer Guide.\n
" + } + }, + "com.amazonaws.comprehend#CreateDocumentClassifierRequest": { + "type": "structure", + "members": { + "DocumentClassifierName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "The name of the document classifier.
", + "smithy.api#required": {} + } + }, + "VersionName": { + "target": "com.amazonaws.comprehend#VersionName", + "traits": { + "smithy.api#documentation": "The version name given to the newly created classifier. Version names can have a maximum\n of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The\n version name must be unique among all models with the same classifier name in the account/AWS\n Region.
" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "Tags to associate with the document classifier. A tag is a key-value\n pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n
" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#DocumentClassifierInputDataConfig", + "traits": { + "smithy.api#documentation": "Specifies the format and location of the input data for the job.
", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig", + "traits": { + "smithy.api#documentation": "Enables the addition of output results configuration parameters for custom classifier\n jobs.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.
", + "smithy.api#idempotencyToken": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "The language of the input documents. You can specify any of the languages\n supported by Amazon Comprehend. All documents must be in the same language.
", + "smithy.api#required": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your custom classifier. For more information, see Amazon\n VPC.
" + } + }, + "Mode": { + "target": "com.amazonaws.comprehend#DocumentClassifierMode", + "traits": { + "smithy.api#documentation": "Indicates the mode in which the classifier will be trained. The classifier can be trained\n in multi-class mode, which identifies one and only one class for each document, or multi-label\n mode, which identifies one or more labels for each document. In multi-label mode, multiple\n labels for an individual document are separated by a delimiter. The default delimiter between\n labels is a pipe (|).
" + } + }, + "ModelKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The resource-based policy to attach to your custom document classifier model. You can use\n this policy to allow another AWS account to import your custom model.
\nProvide your policy as a JSON body that you enter as a UTF-8 encoded string without line\n breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the\n JSON body is also enclosed in double quotes, then you must escape the double quotes that are\n inside the policy:
\n\n \"{\\\"attribute\\\": \\\"value\\\", \\\"attribute\\\": [\\\"value\\\"]}\"\n
To avoid escaping quotes, you can use single quotes to enclose the policy and double\n quotes to enclose the JSON names and values:
\n\n '{\"attribute\": \"value\", \"attribute\": [\"value\"]}'\n
The Amazon Resource Name (ARN) that identifies the document classifier.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#CreateEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#CreateEndpointRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#CreateEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a model-specific endpoint for synchronous inference for a previously trained\n custom model \n For information about endpoints, see Managing endpoints.
" + } + }, + "com.amazonaws.comprehend#CreateEndpointRequest": { + "type": "structure", + "members": { + "EndpointName": { + "target": "com.amazonaws.comprehend#ComprehendEndpointName", + "traits": { + "smithy.api#documentation": "This is the descriptive suffix that becomes part of the EndpointArn used for\n all subsequent requests to this resource.
The Amazon Resource Number (ARN) of the model to which the endpoint will be\n attached.
" + } + }, + "DesiredInferenceUnits": { + "target": "com.amazonaws.comprehend#InferenceUnitsInteger", + "traits": { + "smithy.api#documentation": "The desired number of inference units to be used by the model using this endpoint.\n \n Each inference unit represents of a throughput of 100 characters per second.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "An idempotency token provided by the customer. If this token matches a previous endpoint\n creation request, Amazon Comprehend will not return a ResourceInUseException.\n
Tags to associate with the endpoint. A tag is a key-value pair that adds\n metadata to the endpoint. For example, a tag with \"Sales\" as the key might be added to an\n endpoint to indicate its use by the sales department.
" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to trained custom models encrypted with a customer\n managed key (ModelKmsKeyId).
" + } + }, + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be\n attached.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#CreateEndpointResponse": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.comprehend#ComprehendEndpointArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint being created.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the model to which the endpoint is\n attached.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#CreateEntityRecognizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#CreateEntityRecognizerRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#CreateEntityRecognizerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an entity recognizer using submitted files. After your\n CreateEntityRecognizer request is submitted, you can check job status using the\n DescribeEntityRecognizer API.
The name given to the newly created recognizer. Recognizer names can be a maximum of 256\n characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name\n must be unique in the account/region.
", + "smithy.api#required": {} + } + }, + "VersionName": { + "target": "com.amazonaws.comprehend#VersionName", + "traits": { + "smithy.api#documentation": "The version name given to the newly created recognizer. Version names can be a maximum of\n 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The\n version name must be unique among all models with the same recognizer name in the account/ AWS\n Region.
" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "Tags to associate with the entity recognizer. A tag is a key-value pair\n that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n
" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#EntityRecognizerInputDataConfig", + "traits": { + "smithy.api#documentation": "Specifies the format and location of the input data. The S3 bucket containing the input\n data must be located in the same region as the entity recognizer being created.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.
", + "smithy.api#idempotencyToken": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "You can specify any of the following languages: English\n (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), German (\"de\"), or Portuguese (\"pt\").\n If you plan to use this entity recognizer with PDF, Word, or image input files, you must\n specify English as the language.\n All training documents must be in the same language.
", + "smithy.api#required": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your custom entity recognizer. For more information, see\n Amazon\n VPC.
" + } + }, + "ModelKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The JSON resource-based policy to attach to your custom entity recognizer model. You can\n use this policy to allow another AWS account to import your custom model.
\nProvide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for\n your policy, enclose the attribute names and values in double quotes. If the JSON body is also\n enclosed in double quotes, then you must escape the double quotes that are inside the\n policy:
\n\n \"{\\\"attribute\\\": \\\"value\\\", \\\"attribute\\\": [\\\"value\\\"]}\"\n
To avoid escaping quotes, you can use single quotes to enclose the policy and double\n quotes to enclose the JSON names and values:
\n\n '{\"attribute\": \"value\", \"attribute\": [\"value\"]}'\n
The Amazon Resource Name (ARN) that identifies the entity recognizer.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#CreateFlywheel": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#CreateFlywheelRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#CreateFlywheelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "A flywheel is an AWS resource that orchestrates the ongoing training of a model for custom classification\n or custom entity recognition. You can create a flywheel to start with an existing trained model, or\n Comprehend can create and train a new model.
\nWhen you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training\n data and test data for all versions of the model.
\nTo use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's\n training data and test data into the flywheel's data lake.
\nTo use the flywheel with a new model, you need to provide a dataset for training data (and optional test data)\n when you create the flywheel.
\nFor more information about flywheels, see \n Flywheel overview in the Amazon Comprehend Developer Guide.
" + } + }, + "com.amazonaws.comprehend#CreateFlywheelRequest": { + "type": "structure", + "members": { + "FlywheelName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "Name for the flywheel.
", + "smithy.api#required": {} + } + }, + "ActiveModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version.
" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.
", + "smithy.api#required": {} + } + }, + "TaskConfig": { + "target": "com.amazonaws.comprehend#TaskConfig", + "traits": { + "smithy.api#documentation": "Configuration about the custom classifier associated with the flywheel.
" + } + }, + "ModelType": { + "target": "com.amazonaws.comprehend#ModelType", + "traits": { + "smithy.api#documentation": "The model type.
" + } + }, + "DataLakeS3Uri": { + "target": "com.amazonaws.comprehend#FlywheelS3Uri", + "traits": { + "smithy.api#documentation": "Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an\n existing S3 bucket. The flywheel creates the data lake at this location.
", + "smithy.api#required": {} + } + }, + "DataSecurityConfig": { + "target": "com.amazonaws.comprehend#DataSecurityConfig", + "traits": { + "smithy.api#documentation": "Data security configurations.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.
", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "The tags to associate with this flywheel.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#CreateFlywheelResponse": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel.
" + } + }, + "ActiveModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the active model version.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#CustomerInputString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#CustomerInputStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#CustomerInputString" + }, + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#DataSecurityConfig": { + "type": "structure", + "members": { + "ModelKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
ID for the KMS key that Amazon Comprehend uses to encrypt the volume.
" + } + }, + "DataLakeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "ID for the KMS key that Amazon Comprehend uses to encrypt the data in the data lake.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig" + } + }, + "traits": { + "smithy.api#documentation": "Data security configuration.
" + } + }, + "com.amazonaws.comprehend#DatasetAugmentedManifestsList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DatasetAugmentedManifestsListItem" + } + }, + "com.amazonaws.comprehend#DatasetAugmentedManifestsListItem": { + "type": "structure", + "members": { + "AttributeNames": { + "target": "com.amazonaws.comprehend#AttributeNamesList", + "traits": { + "smithy.api#documentation": "The JSON attribute that contains the annotations for your training documents. The number\n of attribute names that you specify depends on whether your augmented manifest file is the\n output of a single labeling job or a chained labeling job.
\nIf your file is the output of a single labeling job, specify the LabelAttributeName key\n that was used when the job was created in Ground Truth.
\nIf your file is the output of a chained labeling job, specify the LabelAttributeName key\n for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from\n an individual job.
", + "smithy.api#required": {} + } + }, + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "The Amazon S3 location of the augmented manifest file.
", + "smithy.api#required": {} + } + }, + "AnnotationDataS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 prefix to the annotation files that are referred in the augmented manifest\n file.
" + } + }, + "SourceDocumentsS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest\n file.
" + } + }, + "DocumentType": { + "target": "com.amazonaws.comprehend#AugmentedManifestsDocumentTypeFormat", + "traits": { + "smithy.api#documentation": "The type of augmented manifest. If you don't specify, the default is PlainTextDocument.
\n\n PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that\n is encoded in UTF-8.
An augmented manifest file that provides training data for your custom model.\n An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
" + } + }, + "com.amazonaws.comprehend#DatasetDataFormat": { + "type": "enum", + "members": { + "COMPREHEND_CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPREHEND_CSV" + } + }, + "AUGMENTED_MANIFEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUGMENTED_MANIFEST" + } + } + } + }, + "com.amazonaws.comprehend#DatasetDocumentClassifierInputDataConfig": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API\n endpoint that you are calling. The URI can point to a single input file or it can provide the\n prefix for a collection of input files.
\nFor example, if you use the URI S3://bucketName/prefix, if the prefix is a\n single file, Amazon Comprehend uses that file as input. If more than one file begins with the\n prefix, Amazon Comprehend uses all of them as input.
This parameter is required if you set DataFormat to\n COMPREHEND_CSV.
Indicates the delimiter used to separate each label for training a multi-label classifier.\n The default delimiter between labels is a pipe (|). You can use a different character as a\n delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the\n training documents use a delimiter other than the default or the delimiter you specify, the\n labels on that line will be combined to make a single unique label, such as\n LABELLABELLABEL.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the dataset input data configuration for a document classifier model.
\nFor more information on how the input file is formatted, see Preparing training data\n in the Comprehend Developer Guide.
" + } + }, + "com.amazonaws.comprehend#DatasetEntityRecognizerAnnotations": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "Specifies the Amazon S3 location where the training documents for an entity recognizer\n are located. The URI must be in the same region as the API endpoint that you are\n calling.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the annotations associated with a entity recognizer.
" + } + }, + "com.amazonaws.comprehend#DatasetEntityRecognizerDocuments": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "Specifies the Amazon S3 location where the documents for the dataset\n are located.
", + "smithy.api#required": {} + } + }, + "InputFormat": { + "target": "com.amazonaws.comprehend#InputFormat", + "traits": { + "smithy.api#documentation": "Specifies how the text in an input file should be processed. This is optional, and the\n default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document.\n Use this option when you are processing large documents, such as newspaper articles or\n scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document.\n Use this option when you are processing many short documents, such as text messages.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the documents submitted with a dataset for an entity recognizer model.
" + } + }, + "com.amazonaws.comprehend#DatasetEntityRecognizerEntityList": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "Specifies the Amazon S3 location where the entity list is located.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the dataset entity list for an entity recognizer model.
\nFor more information on how the input file is formatted, see Preparing training data\n in the Comprehend Developer Guide.
" + } + }, + "com.amazonaws.comprehend#DatasetEntityRecognizerInputDataConfig": { + "type": "structure", + "members": { + "Annotations": { + "target": "com.amazonaws.comprehend#DatasetEntityRecognizerAnnotations", + "traits": { + "smithy.api#documentation": "The S3 location of the annotation documents for your custom entity recognizer.
" + } + }, + "Documents": { + "target": "com.amazonaws.comprehend#DatasetEntityRecognizerDocuments", + "traits": { + "smithy.api#documentation": "The format and location of the training documents for your custom entity\n recognizer.
", + "smithy.api#required": {} + } + }, + "EntityList": { + "target": "com.amazonaws.comprehend#DatasetEntityRecognizerEntityList", + "traits": { + "smithy.api#documentation": "The S3 location of the entity list for your custom entity recognizer.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the format and location of the input data. You must provide either the\n Annotations parameter or the EntityList parameter.
Filter the datasets based on the dataset status.
" + } + }, + "DatasetType": { + "target": "com.amazonaws.comprehend#DatasetType", + "traits": { + "smithy.api#documentation": "Filter the datasets based on the dataset type.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "Filter the datasets to include datasets created after the specified time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "Filter the datasets to include datasets created before the specified time.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Filter the datasets based on creation time or dataset status.
" + } + }, + "com.amazonaws.comprehend#DatasetInputDataConfig": { + "type": "structure", + "members": { + "AugmentedManifests": { + "target": "com.amazonaws.comprehend#DatasetAugmentedManifestsList", + "traits": { + "smithy.api#documentation": "A list of augmented manifest files that provide training data for your custom model. An\n augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground\n Truth.
" + } + }, + "DataFormat": { + "target": "com.amazonaws.comprehend#DatasetDataFormat", + "traits": { + "smithy.api#documentation": "\n COMPREHEND_CSV: The data format is a two-column CSV file, where the\n first column contains labels and the second column contains documents.
\n AUGMENTED_MANIFEST: The data format
The input properties for training a document classifier model.
\nFor more information on how the input file is formatted, see Preparing training data\n in the Comprehend Developer Guide.
" + } + }, + "EntityRecognizerInputDataConfig": { + "target": "com.amazonaws.comprehend#DatasetEntityRecognizerInputDataConfig", + "traits": { + "smithy.api#documentation": "The input properties for training an entity recognizer model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the format and location of the input data for the dataset.
" + } + }, + "com.amazonaws.comprehend#DatasetProperties": { + "type": "structure", + "members": { + "DatasetArn": { + "target": "com.amazonaws.comprehend#ComprehendDatasetArn", + "traits": { + "smithy.api#documentation": "The ARN of the dataset.
" + } + }, + "DatasetName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "The name of the dataset.
" + } + }, + "DatasetType": { + "target": "com.amazonaws.comprehend#DatasetType", + "traits": { + "smithy.api#documentation": "The dataset type (training data or test data).
" + } + }, + "DatasetS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "The S3 URI where the dataset is stored.
" + } + }, + "Description": { + "target": "com.amazonaws.comprehend#Description", + "traits": { + "smithy.api#documentation": "Description of the dataset.
" + } + }, + "Status": { + "target": "com.amazonaws.comprehend#DatasetStatus", + "traits": { + "smithy.api#documentation": "The dataset status. While the system creates the dataset, the status is CREATING.\n When the dataset is ready to use, the status changes to COMPLETED.
A description of the status of the dataset.
" + } + }, + "NumberOfDocuments": { + "target": "com.amazonaws.comprehend#NumberOfDocuments", + "traits": { + "smithy.api#documentation": "The number of documents in the dataset.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "Creation time of the dataset.
" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "Time when the data from the dataset becomes available in the data lake.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Properties associated with the dataset.
" + } + }, + "com.amazonaws.comprehend#DatasetPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DatasetProperties" + } + }, + "com.amazonaws.comprehend#DatasetStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.comprehend#DatasetType": { + "type": "enum", + "members": { + "TRAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAIN" + } + }, + "TEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEST" + } + } + } + }, + "com.amazonaws.comprehend#DeleteDocumentClassifier": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DeleteDocumentClassifierRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DeleteDocumentClassifierResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a previously created document classifier
\nOnly those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted.\n If an active inference job is using the model, a ResourceInUseException will be\n returned.
This is an asynchronous action that puts the classifier into a DELETING state, and it is\n then removed by a background job. Once removed, the classifier disappears from your account\n and is no longer available for use.
" + } + }, + "com.amazonaws.comprehend#DeleteDocumentClassifierRequest": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.comprehend#String" + "DocumentClassifierArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the document classifier.
", + "smithy.api#required": {} + } } }, "traits": { - "smithy.api#documentation": "Concurrent modification of the tags associated with an Amazon Comprehend resource is not\n supported.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#ContainsPiiEntities": { + "com.amazonaws.comprehend#DeleteDocumentClassifierResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DeleteEndpoint": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#ContainsPiiEntitiesRequest" + "target": "com.amazonaws.comprehend#DeleteEndpointRequest" }, "output": { - "target": "com.amazonaws.comprehend#ContainsPiiEntitiesResponse" + "target": "com.amazonaws.comprehend#DeleteEndpointResponse" }, "errors": [ { @@ -2905,53 +3369,48 @@ "target": "com.amazonaws.comprehend#InvalidRequestException" }, { - "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + "target": "com.amazonaws.comprehend#ResourceInUseException" }, { - "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Analyzes input text for the presence of personally identifiable information (PII) and\n returns the labels of identified PII entity types such as name, address, bank account number,\n or phone number.
" + "smithy.api#documentation": "Deletes a model-specific endpoint for a previously-trained custom model. All endpoints\n must be deleted in order for the model to be deleted.\n For information about endpoints, see Managing endpoints.
" } }, - "com.amazonaws.comprehend#ContainsPiiEntitiesRequest": { + "com.amazonaws.comprehend#DeleteEndpointRequest": { "type": "structure", "members": { - "Text": { - "target": "com.amazonaws.comprehend#String", - "traits": { - "smithy.api#documentation": "A UTF-8 text string. The maximum string size is 100 KB.
", - "smithy.api#required": {} - } - }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "EndpointArn": { + "target": "com.amazonaws.comprehend#ComprehendEndpointArn", "traits": { - "smithy.api#documentation": "The language of the input documents. Currently, English is the only valid language.
", + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint being deleted.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#ContainsPiiEntitiesResponse": { + "com.amazonaws.comprehend#DeleteEndpointResponse": { "type": "structure", - "members": { - "Labels": { - "target": "com.amazonaws.comprehend#ListOfEntityLabels", - "traits": { - "smithy.api#documentation": "The labels used in the document being analyzed. Individual labels represent personally\n identifiable information (PII) entity types.
" - } - } + "members": {}, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.comprehend#CreateDocumentClassifier": { + "com.amazonaws.comprehend#DeleteEntityRecognizer": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#CreateDocumentClassifierRequest" + "target": "com.amazonaws.comprehend#DeleteEntityRecognizerRequest" }, "output": { - "target": "com.amazonaws.comprehend#CreateDocumentClassifierResponse" + "target": "com.amazonaws.comprehend#DeleteEntityRecognizerResponse" }, "errors": [ { @@ -2960,135 +3419,157 @@ { "target": "com.amazonaws.comprehend#InvalidRequestException" }, - { - "target": "com.amazonaws.comprehend#KmsKeyValidationException" - }, { "target": "com.amazonaws.comprehend#ResourceInUseException" }, { - "target": "com.amazonaws.comprehend#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.comprehend#TooManyRequestsException" + "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, { - "target": "com.amazonaws.comprehend#TooManyTagsException" + "target": "com.amazonaws.comprehend#ResourceUnavailableException" }, { - "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Creates a new document classifier that you can use to categorize documents. To create a\n classifier, you provide a set of training documents that labeled with the categories that you\n want to use. After the classifier is trained you can use it to categorize a set of labeled\n documents into the categories. For more information, see\n Document Classification in the Comprehend Developer Guide.\n
" + "smithy.api#documentation": "Deletes an entity recognizer.
\nOnly those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted.\n If an active inference job is using the model, a ResourceInUseException will be\n returned.
This is an asynchronous action that puts the recognizer into a DELETING state, and it is\n then removed by a background job. Once removed, the recognizer disappears from your account\n and is no longer available for use.
" } }, - "com.amazonaws.comprehend#CreateDocumentClassifierRequest": { + "com.amazonaws.comprehend#DeleteEntityRecognizerRequest": { "type": "structure", "members": { - "DocumentClassifierName": { - "target": "com.amazonaws.comprehend#ComprehendArnName", - "traits": { - "smithy.api#documentation": "The name of the document classifier.
", - "smithy.api#required": {} - } - }, - "VersionName": { - "target": "com.amazonaws.comprehend#VersionName", - "traits": { - "smithy.api#documentation": "The version name given to the newly created classifier. Version names can have a maximum\n of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The\n version name must be unique among all models with the same classifier name in the account/AWS\n Region.
" - } - }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "EntityRecognizerArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your input data.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the entity recognizer.
", "smithy.api#required": {} } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DeleteEntityRecognizerResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DeleteFlywheel": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DeleteFlywheelRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DeleteFlywheelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" }, - "Tags": { - "target": "com.amazonaws.comprehend#TagList", - "traits": { - "smithy.api#documentation": "Tags to be associated with the document classifier being created. A tag is a key-value\n pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n
" - } + { + "target": "com.amazonaws.comprehend#InvalidRequestException" }, - "InputDataConfig": { - "target": "com.amazonaws.comprehend#DocumentClassifierInputDataConfig", - "traits": { - "smithy.api#documentation": "Specifies the format and location of the input data for the job.
", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.comprehend#ResourceInUseException" }, - "OutputDataConfig": { - "target": "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig", - "traits": { - "smithy.api#documentation": "Enables the addition of output results configuration parameters for custom classifier\n jobs.
" - } + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, - "ClientRequestToken": { - "target": "com.amazonaws.comprehend#ClientRequestTokenString", - "traits": { - "smithy.api#documentation": "A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.
", - "smithy.api#idempotencyToken": {} - } + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a flywheel. When you delete the flywheel, Amazon Comprehend\n does not delete the data lake or the model associated with the flywheel.
\nFor more information about flywheels, see \n Flywheel overview in the Amazon Comprehend Developer Guide.
" + } + }, + "com.amazonaws.comprehend#DeleteFlywheelRequest": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", "traits": { - "smithy.api#documentation": "The language of the input documents. You can specify any of the following languages\n supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"),\n Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.
", + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel to delete.
", "smithy.api#required": {} } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DeleteFlywheelResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DeleteResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", - "traits": { - "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your custom classifier. For more information, see Amazon\n VPC.
" - } - }, - "Mode": { - "target": "com.amazonaws.comprehend#DocumentClassifierMode", - "traits": { - "smithy.api#documentation": "Indicates the mode in which the classifier will be trained. The classifier can be trained\n in multi-class mode, which identifies one and only one class for each document, or multi-label\n mode, which identifies one or more labels for each document. In multi-label mode, multiple\n labels for an individual document are separated by a delimiter. The default delimiter between\n labels is a pipe (|).
" - } + { + "target": "com.amazonaws.comprehend#InvalidRequestException" }, - "ModelKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a resource-based policy that is attached to a custom model.
" + } + }, + "com.amazonaws.comprehend#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", "traits": { - "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.
", + "smithy.api#required": {} } }, - "ModelPolicy": { - "target": "com.amazonaws.comprehend#Policy", + "PolicyRevisionId": { + "target": "com.amazonaws.comprehend#PolicyRevisionId", "traits": { - "smithy.api#documentation": "The resource-based policy to attach to your custom document classifier model. You can use\n this policy to allow another AWS account to import your custom model.
\nProvide your policy as a JSON body that you enter as a UTF-8 encoded string without line\n breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the\n JSON body is also enclosed in double quotes, then you must escape the double quotes that are\n inside the policy:
\n\n \"{\\\"attribute\\\": \\\"value\\\", \\\"attribute\\\": [\\\"value\\\"]}\"\n
To avoid escaping quotes, you can use single quotes to enclose the policy and double\n quotes to enclose the JSON names and values:
\n\n '{\"attribute\": \"value\", \"attribute\": [\"value\"]}'\n
The revision ID of the policy to delete.
" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#CreateDocumentClassifierResponse": { + "com.amazonaws.comprehend#DeleteResourcePolicyResponse": { "type": "structure", - "members": { - "DocumentClassifierArn": { - "target": "com.amazonaws.comprehend#DocumentClassifierArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the document classifier.
" - } - } + "members": {}, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.comprehend#CreateEndpoint": { + "com.amazonaws.comprehend#DescribeDataset": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#CreateEndpointRequest" + "target": "com.amazonaws.comprehend#DescribeDatasetRequest" }, "output": { - "target": "com.amazonaws.comprehend#CreateEndpointResponse" + "target": "com.amazonaws.comprehend#DescribeDatasetResponse" }, "errors": [ { @@ -3097,92 +3578,53 @@ { "target": "com.amazonaws.comprehend#InvalidRequestException" }, - { - "target": "com.amazonaws.comprehend#ResourceInUseException" - }, - { - "target": "com.amazonaws.comprehend#ResourceLimitExceededException" - }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, - { - "target": "com.amazonaws.comprehend#ResourceUnavailableException" - }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" - }, - { - "target": "com.amazonaws.comprehend#TooManyTagsException" } ], "traits": { - "smithy.api#documentation": "Creates a model-specific endpoint for synchronous inference for a previously trained\n custom model \n For information about endpoints, see Managing endpoints.
" + "smithy.api#documentation": "Returns information about the dataset that you specify. \n For more information about datasets, see \n Flywheel overview in the Amazon Comprehend Developer Guide.
" } }, - "com.amazonaws.comprehend#CreateEndpointRequest": { + "com.amazonaws.comprehend#DescribeDatasetRequest": { "type": "structure", "members": { - "EndpointName": { - "target": "com.amazonaws.comprehend#ComprehendEndpointName", - "traits": { - "smithy.api#documentation": "This is the descriptive suffix that becomes part of the EndpointArn used for\n all subsequent requests to this resource.
The Amazon Resource Number (ARN) of the model to which the endpoint will be\n attached.
", + "smithy.api#documentation": "The ARN of the dataset.
", "smithy.api#required": {} } - }, - "DesiredInferenceUnits": { - "target": "com.amazonaws.comprehend#InferenceUnitsInteger", - "traits": { - "smithy.api#documentation": "The desired number of inference units to be used by the model using this endpoint.\n \n Each inference unit represents of a throughput of 100 characters per second.
", - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.comprehend#ClientRequestTokenString", - "traits": { - "smithy.api#documentation": "An idempotency token provided by the customer. If this token matches a previous endpoint\n creation request, Amazon Comprehend will not return a ResourceInUseException.\n
Tags associated with the endpoint being created. A tag is a key-value pair that adds\n metadata to the endpoint. For example, a tag with \"Sales\" as the key might be added to an\n endpoint to indicate its use by the sales department.
" - } - }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to trained custom models encrypted with a customer\n managed key (ModelKmsKeyId).
" - } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#CreateEndpointResponse": { + "com.amazonaws.comprehend#DescribeDatasetResponse": { "type": "structure", "members": { - "EndpointArn": { - "target": "com.amazonaws.comprehend#ComprehendEndpointArn", + "DatasetProperties": { + "target": "com.amazonaws.comprehend#DatasetProperties", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint being created.
" + "smithy.api#documentation": "The dataset properties.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.comprehend#CreateEntityRecognizer": { + "com.amazonaws.comprehend#DescribeDocumentClassificationJob": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#CreateEntityRecognizerRequest" + "target": "com.amazonaws.comprehend#DescribeDocumentClassificationJobRequest" }, "output": { - "target": "com.amazonaws.comprehend#CreateEntityRecognizerResponse" + "target": "com.amazonaws.comprehend#DescribeDocumentClassificationJobResponse" }, "errors": [ { @@ -3192,143 +3634,162 @@ "target": "com.amazonaws.comprehend#InvalidRequestException" }, { - "target": "com.amazonaws.comprehend#KmsKeyValidationException" - }, - { - "target": "com.amazonaws.comprehend#ResourceInUseException" - }, - { - "target": "com.amazonaws.comprehend#ResourceLimitExceededException" + "target": "com.amazonaws.comprehend#JobNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" - }, - { - "target": "com.amazonaws.comprehend#TooManyTagsException" - }, - { - "target": "com.amazonaws.comprehend#UnsupportedLanguageException" } ], "traits": { - "smithy.api#documentation": "Creates an entity recognizer using submitted files. After your\n CreateEntityRecognizer request is submitted, you can check job status using the\n API.
Gets the properties associated with a document classification job. Use this operation to\n get the status of a classification job.
" } }, - "com.amazonaws.comprehend#CreateEntityRecognizerRequest": { + "com.amazonaws.comprehend#DescribeDocumentClassificationJobRequest": { "type": "structure", "members": { - "RecognizerName": { - "target": "com.amazonaws.comprehend#ComprehendArnName", - "traits": { - "smithy.api#documentation": "The name given to the newly created recognizer. Recognizer names can be a maximum of 256\n characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name\n must be unique in the account/region.
", - "smithy.api#required": {} - } - }, - "VersionName": { - "target": "com.amazonaws.comprehend#VersionName", - "traits": { - "smithy.api#documentation": "The version name given to the newly created recognizer. Version names can be a maximum of\n 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The\n version name must be unique among all models with the same recognizer name in the account/ AWS\n Region.
" - } - }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your input data.
", + "smithy.api#documentation": "The identifier that Amazon Comprehend generated for the job. The \n StartDocumentClassificationJob operation returns this identifier in its response.
Tags to be associated with the entity recognizer being created. A tag is a key-value pair\n that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n
" + "smithy.api#documentation": "An object that describes the properties associated with the document classification\n job.
" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeDocumentClassifier": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeDocumentClassifierRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeDocumentClassifierResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" }, - "InputDataConfig": { - "target": "com.amazonaws.comprehend#EntityRecognizerInputDataConfig", - "traits": { - "smithy.api#documentation": "Specifies the format and location of the input data. The S3 bucket containing the input\n data must be located in the same region as the entity recognizer being created.
", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.comprehend#InvalidRequestException" }, - "ClientRequestToken": { - "target": "com.amazonaws.comprehend#ClientRequestTokenString", - "traits": { - "smithy.api#documentation": "A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.
", - "smithy.api#idempotencyToken": {} - } + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the properties associated with a document classifier.
" + } + }, + "com.amazonaws.comprehend#DescribeDocumentClassifierRequest": { + "type": "structure", + "members": { + "DocumentClassifierArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", "traits": { - "smithy.api#documentation": "You can specify any of the following languages: English\n (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), German (\"de\"), or Portuguese (\"pt\").\n If you plan to use this entity recognizer with PDF, Word, or image input files, you must \n specify English as the language. \n All training documents must be in the same language.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the document classifier. The \n CreateDocumentClassifier operation returns this identifier in its response.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
An object that contains the properties associated with a document classifier.
" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", - "traits": { - "smithy.api#documentation": "Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your custom entity recognizer. For more information, see\n Amazon\n VPC.
" - } + { + "target": "com.amazonaws.comprehend#InvalidRequestException" }, - "ModelKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", - "traits": { - "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The JSON resource-based policy to attach to your custom entity recognizer model. You can\n use this policy to allow another AWS account to import your custom model.
\nProvide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for\n your policy, enclose the attribute names and values in double quotes. If the JSON body is also\n enclosed in double quotes, then you must escape the double quotes that are inside the\n policy:
\n\n \"{\\\"attribute\\\": \\\"value\\\", \\\"attribute\\\": [\\\"value\\\"]}\"\n
To avoid escaping quotes, you can use single quotes to enclose the policy and double\n quotes to enclose the JSON names and values:
\n\n '{\"attribute\": \"value\", \"attribute\": [\"value\"]}'\n
Gets the properties associated with a dominant language detection job. Use this operation\n to get the status of a detection job.
" } }, - "com.amazonaws.comprehend#CreateEntityRecognizerResponse": { + "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJobRequest": { "type": "structure", "members": { - "EntityRecognizerArn": { - "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the entity recognizer.
" + "smithy.api#documentation": "The identifier that Amazon Comprehend generated for the job. The \n StartDominantLanguageDetectionJob operation returns this identifier in its response.
An object that contains the properties associated with a dominant language detection\n job.
" + } + } }, "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#sensitive": {} + "smithy.api#output": {} } }, - "com.amazonaws.comprehend#DeleteDocumentClassifier": { + "com.amazonaws.comprehend#DescribeEndpoint": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DeleteDocumentClassifierRequest" + "target": "com.amazonaws.comprehend#DescribeEndpointRequest" }, "output": { - "target": "com.amazonaws.comprehend#DeleteDocumentClassifierResponse" + "target": "com.amazonaws.comprehend#DescribeEndpointResponse" }, "errors": [ { @@ -3337,46 +3798,53 @@ { "target": "com.amazonaws.comprehend#InvalidRequestException" }, - { - "target": "com.amazonaws.comprehend#ResourceInUseException" - }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, - { - "target": "com.amazonaws.comprehend#ResourceUnavailableException" - }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Deletes a previously created document classifier
\nOnly those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted.\n If an active inference job is using the model, a ResourceInUseException will be\n returned.
This is an asynchronous action that puts the classifier into a DELETING state, and it is\n then removed by a background job. Once removed, the classifier disappears from your account\n and is no longer available for use.
" + "smithy.api#documentation": "Gets the properties associated with a specific endpoint. Use this operation to get the\n status of an endpoint.\n For information about endpoints, see Managing endpoints.
" } }, - "com.amazonaws.comprehend#DeleteDocumentClassifierRequest": { + "com.amazonaws.comprehend#DescribeEndpointRequest": { "type": "structure", "members": { - "DocumentClassifierArn": { - "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "EndpointArn": { + "target": "com.amazonaws.comprehend#ComprehendEndpointArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the document classifier.
", + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint being described.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#DeleteDocumentClassifierResponse": { + "com.amazonaws.comprehend#DescribeEndpointResponse": { "type": "structure", - "members": {} + "members": { + "EndpointProperties": { + "target": "com.amazonaws.comprehend#EndpointProperties", + "traits": { + "smithy.api#documentation": "Describes information associated with the specific endpoint.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - "com.amazonaws.comprehend#DeleteEndpoint": { + "com.amazonaws.comprehend#DescribeEntitiesDetectionJob": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DeleteEndpointRequest" + "target": "com.amazonaws.comprehend#DescribeEntitiesDetectionJobRequest" }, "output": { - "target": "com.amazonaws.comprehend#DeleteEndpointResponse" + "target": "com.amazonaws.comprehend#DescribeEntitiesDetectionJobResponse" }, "errors": [ { @@ -3386,42 +3854,52 @@ "target": "com.amazonaws.comprehend#InvalidRequestException" }, { - "target": "com.amazonaws.comprehend#ResourceInUseException" - }, - { - "target": "com.amazonaws.comprehend#ResourceNotFoundException" + "target": "com.amazonaws.comprehend#JobNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Deletes a model-specific endpoint for a previously-trained custom model. All endpoints\n must be deleted in order for the model to be deleted.\n For information about endpoints, see Managing endpoints.
" + "smithy.api#documentation": "Gets the properties associated with an entities detection job. Use this operation to get\n the status of a detection job.
" } }, - "com.amazonaws.comprehend#DeleteEndpointRequest": { + "com.amazonaws.comprehend#DescribeEntitiesDetectionJobRequest": { "type": "structure", "members": { - "EndpointArn": { - "target": "com.amazonaws.comprehend#ComprehendEndpointArn", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint being deleted.
", + "smithy.api#documentation": "The identifier that Amazon Comprehend generated for the job. The \n StartEntitiesDetectionJob operation returns this identifier in its response.
An object that contains the properties associated with an entities detection job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - "com.amazonaws.comprehend#DeleteEntityRecognizer": { + "com.amazonaws.comprehend#DescribeEntityRecognizer": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DeleteEntityRecognizerRequest" + "target": "com.amazonaws.comprehend#DescribeEntityRecognizerRequest" }, "output": { - "target": "com.amazonaws.comprehend#DeleteEntityRecognizerResponse" + "target": "com.amazonaws.comprehend#DescribeEntityRecognizerResponse" }, "errors": [ { @@ -3430,24 +3908,18 @@ { "target": "com.amazonaws.comprehend#InvalidRequestException" }, - { - "target": "com.amazonaws.comprehend#ResourceInUseException" - }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, - { - "target": "com.amazonaws.comprehend#ResourceUnavailableException" - }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Deletes an entity recognizer.
\nOnly those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted.\n If an active inference job is using the model, a ResourceInUseException will be\n returned.
This is an asynchronous action that puts the recognizer into a DELETING state, and it is\n then removed by a background job. Once removed, the recognizer disappears from your account\n and is no longer available for use.
" + "smithy.api#documentation": "Provides details about an entity recognizer including status, S3 buckets containing\n training data, recognizer metadata, metrics, and so on.
" } }, - "com.amazonaws.comprehend#DeleteEntityRecognizerRequest": { + "com.amazonaws.comprehend#DescribeEntityRecognizerRequest": { "type": "structure", "members": { "EntityRecognizerArn": { @@ -3457,19 +3929,32 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#DeleteEntityRecognizerResponse": { + "com.amazonaws.comprehend#DescribeEntityRecognizerResponse": { "type": "structure", - "members": {} + "members": { + "EntityRecognizerProperties": { + "target": "com.amazonaws.comprehend#EntityRecognizerProperties", + "traits": { + "smithy.api#documentation": "Describes information associated with an entity recognizer.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - "com.amazonaws.comprehend#DeleteResourcePolicy": { + "com.amazonaws.comprehend#DescribeEventsDetectionJob": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DeleteResourcePolicyRequest" + "target": "com.amazonaws.comprehend#DescribeEventsDetectionJobRequest" }, "output": { - "target": "com.amazonaws.comprehend#DeleteResourcePolicyResponse" + "target": "com.amazonaws.comprehend#DescribeEventsDetectionJobResponse" }, "errors": [ { @@ -3479,42 +3964,78 @@ "target": "com.amazonaws.comprehend#InvalidRequestException" }, { - "target": "com.amazonaws.comprehend#ResourceNotFoundException" + "target": "com.amazonaws.comprehend#JobNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Deletes a resource-based policy that is attached to a custom model.
" + "smithy.api#documentation": "Gets the status and details of an events detection job.
" } }, - "com.amazonaws.comprehend#DeleteResourcePolicyRequest": { + "com.amazonaws.comprehend#DescribeEventsDetectionJobRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.comprehend#ComprehendModelArn", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.
", + "smithy.api#documentation": "The identifier of the events detection job.
", "smithy.api#required": {} } - }, - "PolicyRevisionId": { - "target": "com.amazonaws.comprehend#PolicyRevisionId", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeEventsDetectionJobResponse": { + "type": "structure", + "members": { + "EventsDetectionJobProperties": { + "target": "com.amazonaws.comprehend#EventsDetectionJobProperties", "traits": { - "smithy.api#documentation": "The revision ID of the policy to delete.
" + "smithy.api#documentation": "An object that contains the properties associated with an event detection job.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.comprehend#DeleteResourcePolicyResponse": { - "type": "structure", - "members": {} + "com.amazonaws.comprehend#DescribeFlywheel": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeFlywheelRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeFlywheelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Provides configuration information about the flywheel. For more information about flywheels, see \n Flywheel overview in the Amazon Comprehend Developer Guide.
" + } }, - "com.amazonaws.comprehend#DescribeDocumentClassificationJob": { + "com.amazonaws.comprehend#DescribeFlywheelIteration": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DescribeDocumentClassificationJobRequest" + "target": "com.amazonaws.comprehend#DescribeFlywheelIterationRequest" }, "output": { - "target": "com.amazonaws.comprehend#DescribeDocumentClassificationJobResponse" + "target": "com.amazonaws.comprehend#DescribeFlywheelIterationResponse" }, "errors": [ { @@ -3524,46 +4045,88 @@ "target": "com.amazonaws.comprehend#InvalidRequestException" }, { - "target": "com.amazonaws.comprehend#JobNotFoundException" + "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Gets the properties associated with a document classification job. Use this operation to\n get the status of a classification job.
" + "smithy.api#documentation": "Retrieve the configuration properties of a flywheel iteration.\n For more information about flywheels, see \n Flywheel overview in the Amazon Comprehend Developer Guide.
" } }, - "com.amazonaws.comprehend#DescribeDocumentClassificationJobRequest": { + "com.amazonaws.comprehend#DescribeFlywheelIterationRequest": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.comprehend#JobId", + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", "traits": { - "smithy.api#documentation": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its\n response.
", + "smithy.api#documentation": "", + "smithy.api#required": {} + } + }, + "FlywheelIterationId": { + "target": "com.amazonaws.comprehend#FlywheelIterationId", + "traits": { + "smithy.api#documentation": "", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#DescribeDocumentClassificationJobResponse": { + "com.amazonaws.comprehend#DescribeFlywheelIterationResponse": { "type": "structure", "members": { - "DocumentClassificationJobProperties": { - "target": "com.amazonaws.comprehend#DocumentClassificationJobProperties", + "FlywheelIterationProperties": { + "target": "com.amazonaws.comprehend#FlywheelIterationProperties", "traits": { - "smithy.api#documentation": "An object that describes the properties associated with the document classification\n job.
" + "smithy.api#documentation": "The configuration properties of a flywheel iteration.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.comprehend#DescribeDocumentClassifier": { + "com.amazonaws.comprehend#DescribeFlywheelRequest": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#DescribeFlywheelResponse": { + "type": "structure", + "members": { + "FlywheelProperties": { + "target": "com.amazonaws.comprehend#FlywheelProperties", + "traits": { + "smithy.api#documentation": "The flywheel properties.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJob": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DescribeDocumentClassifierRequest" + "target": "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJobRequest" }, "output": { - "target": "com.amazonaws.comprehend#DescribeDocumentClassifierResponse" + "target": "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJobResponse" }, "errors": [ { @@ -3573,46 +4136,52 @@ "target": "com.amazonaws.comprehend#InvalidRequestException" }, { - "target": "com.amazonaws.comprehend#ResourceNotFoundException" + "target": "com.amazonaws.comprehend#JobNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Gets the properties associated with a document classifier.
" + "smithy.api#documentation": "Gets the properties associated with a key phrases detection job. Use this operation to get\n the status of a detection job.
" } }, - "com.amazonaws.comprehend#DescribeDocumentClassifierRequest": { + "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJobRequest": { "type": "structure", "members": { - "DocumentClassifierArn": { - "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its\n response.
", + "smithy.api#documentation": "The identifier that Amazon Comprehend generated for the job. The \n StartKeyPhrasesDetectionJob operation returns this identifier in its\n response.
An object that contains the properties associated with a document classifier.
" + "smithy.api#documentation": "An object that contains the properties associated with a key phrases detection job.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJob": { + "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJob": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJobRequest" + "target": "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobRequest" }, "output": { - "target": "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJobResponse" + "target": "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobResponse" }, "errors": [ { @@ -3629,10 +4198,10 @@ } ], "traits": { - "smithy.api#documentation": "Gets the properties associated with a dominant language detection job. Use this operation\n to get the status of a detection job.
" + "smithy.api#documentation": "Gets the properties associated with a PII entities detection job. For example, you can use\n this operation to get the job status.
" } }, - "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJobRequest": { + "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobRequest": { "type": "structure", "members": { "JobId": { @@ -3642,26 +4211,29 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJobResponse": { - "type": "structure", - "members": { - "DominantLanguageDetectionJobProperties": { - "target": "com.amazonaws.comprehend#DominantLanguageDetectionJobProperties", - "traits": { - "smithy.api#documentation": "An object that contains the properties associated with a dominant language detection\n job.
" - } + "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobResponse": { + "type": "structure", + "members": { + "PiiEntitiesDetectionJobProperties": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobProperties" } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.comprehend#DescribeEndpoint": { + "com.amazonaws.comprehend#DescribeResourcePolicy": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DescribeEndpointRequest" + "target": "com.amazonaws.comprehend#DescribeResourcePolicyRequest" }, "output": { - "target": "com.amazonaws.comprehend#DescribeEndpointResponse" + "target": "com.amazonaws.comprehend#DescribeResourcePolicyResponse" }, "errors": [ { @@ -3672,45 +4244,66 @@ }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Gets the properties associated with a specific endpoint. Use this operation to get the\n status of an endpoint.\n For information about endpoints, see Managing endpoints.
" + "smithy.api#documentation": "Gets the details of a resource-based policy that is attached to a custom model, including\n the JSON body of the policy.
" } }, - "com.amazonaws.comprehend#DescribeEndpointRequest": { + "com.amazonaws.comprehend#DescribeResourcePolicyRequest": { "type": "structure", "members": { - "EndpointArn": { - "target": "com.amazonaws.comprehend#ComprehendEndpointArn", + "ResourceArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint being described.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom model version that has the resource policy.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#DescribeEndpointResponse": { + "com.amazonaws.comprehend#DescribeResourcePolicyResponse": { "type": "structure", "members": { - "EndpointProperties": { - "target": "com.amazonaws.comprehend#EndpointProperties", + "ResourcePolicy": { + "target": "com.amazonaws.comprehend#Policy", "traits": { - "smithy.api#documentation": "Describes information associated with the specific endpoint.
" + "smithy.api#documentation": "The JSON body of the resource-based policy.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the policy was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the policy was last modified.
" + } + }, + "PolicyRevisionId": { + "target": "com.amazonaws.comprehend#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a\n new revision ID, and it deletes the prior version of the policy.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.comprehend#DescribeEntitiesDetectionJob": { + "com.amazonaws.comprehend#DescribeSentimentDetectionJob": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DescribeEntitiesDetectionJobRequest" + "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJobRequest" }, "output": { - "target": "com.amazonaws.comprehend#DescribeEntitiesDetectionJobResponse" + "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJobResponse" }, "errors": [ { @@ -3727,10 +4320,10 @@ } ], "traits": { - "smithy.api#documentation": "Gets the properties associated with an entities detection job. Use this operation to get\n the status of a detection job.
" + "smithy.api#documentation": "Gets the properties associated with a sentiment detection job. Use this operation to get\n the status of a detection job.
" } }, - "com.amazonaws.comprehend#DescribeEntitiesDetectionJobRequest": { + "com.amazonaws.comprehend#DescribeSentimentDetectionJobRequest": { "type": "structure", "members": { "JobId": { @@ -3740,26 +4333,32 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#DescribeEntitiesDetectionJobResponse": { + "com.amazonaws.comprehend#DescribeSentimentDetectionJobResponse": { "type": "structure", "members": { - "EntitiesDetectionJobProperties": { - "target": "com.amazonaws.comprehend#EntitiesDetectionJobProperties", + "SentimentDetectionJobProperties": { + "target": "com.amazonaws.comprehend#SentimentDetectionJobProperties", "traits": { - "smithy.api#documentation": "An object that contains the properties associated with an entities detection job.
" + "smithy.api#documentation": "An object that contains the properties associated with a sentiment detection job.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.comprehend#DescribeEntityRecognizer": { + "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJob": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DescribeEntityRecognizerRequest" + "target": "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJobRequest" }, "output": { - "target": "com.amazonaws.comprehend#DescribeEntityRecognizerResponse" + "target": "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJobResponse" }, "errors": [ { @@ -3769,46 +4368,52 @@ "target": "com.amazonaws.comprehend#InvalidRequestException" }, { - "target": "com.amazonaws.comprehend#ResourceNotFoundException" + "target": "com.amazonaws.comprehend#JobNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "Provides details about an entity recognizer including status, S3 buckets containing\n training data, recognizer metadata, metrics, and so on.
" + "smithy.api#documentation": "Gets the properties associated with a targeted sentiment detection job. Use this operation\n to get the status of the job.
" } }, - "com.amazonaws.comprehend#DescribeEntityRecognizerRequest": { + "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJobRequest": { "type": "structure", "members": { - "EntityRecognizerArn": { - "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the entity recognizer.
", + "smithy.api#documentation": "The identifier that Amazon Comprehend generated for the job. The \n StartTargetedSentimentDetectionJob operation returns this identifier in its\n response.
Describes information associated with an entity recognizer.
" + "smithy.api#documentation": "An object that contains the properties associated with a targeted sentiment detection job.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.comprehend#DescribeEventsDetectionJob": { + "com.amazonaws.comprehend#DescribeTopicsDetectionJob": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DescribeEventsDetectionJobRequest" + "target": "com.amazonaws.comprehend#DescribeTopicsDetectionJobRequest" }, "output": { - "target": "com.amazonaws.comprehend#DescribeEventsDetectionJobResponse" + "target": "com.amazonaws.comprehend#DescribeTopicsDetectionJobResponse" }, "errors": [ { @@ -3825,39 +4430,55 @@ } ], "traits": { - "smithy.api#documentation": "Gets the status and details of an events detection job.
" + "smithy.api#documentation": "Gets the properties associated with a topic detection job. Use this operation to get\n the status of a detection job.
" } }, - "com.amazonaws.comprehend#DescribeEventsDetectionJobRequest": { + "com.amazonaws.comprehend#DescribeTopicsDetectionJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "The identifier of the events detection job.
", + "smithy.api#documentation": "The identifier assigned by the user to the detection job.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#DescribeEventsDetectionJobResponse": { + "com.amazonaws.comprehend#DescribeTopicsDetectionJobResponse": { "type": "structure", "members": { - "EventsDetectionJobProperties": { - "target": "com.amazonaws.comprehend#EventsDetectionJobProperties", + "TopicsDetectionJobProperties": { + "target": "com.amazonaws.comprehend#TopicsDetectionJobProperties", "traits": { - "smithy.api#documentation": "An object that contains the properties associated with an event detection job.
" + "smithy.api#documentation": "The list of properties for the requested job.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJob": { + "com.amazonaws.comprehend#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^([a-zA-Z0-9_])[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$" + } + }, + "com.amazonaws.comprehend#DetectDominantLanguage": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJobRequest" + "target": "com.amazonaws.comprehend#DetectDominantLanguageRequest" }, "output": { - "target": "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJobResponse" + "target": "com.amazonaws.comprehend#DetectDominantLanguageResponse" }, "errors": [ { @@ -3867,46 +4488,50 @@ "target": "com.amazonaws.comprehend#InvalidRequestException" }, { - "target": "com.amazonaws.comprehend#JobNotFoundException" - }, - { - "target": "com.amazonaws.comprehend#TooManyRequestsException" + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" } ], "traits": { - "smithy.api#documentation": "Gets the properties associated with a key phrases detection job. Use this operation to get\n the status of a detection job.
" + "smithy.api#documentation": "Determines the dominant language of the input text. For a list of languages that Amazon\n Comprehend can detect, see Amazon Comprehend Supported Languages.
" } }, - "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJobRequest": { + "com.amazonaws.comprehend#DetectDominantLanguageRequest": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.comprehend#JobId", + "Text": { + "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { - "smithy.api#documentation": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its\n response.
", + "smithy.api#documentation": "A UTF-8 text string. The string must contain at least 20 characters. The maximum string size is 100 KB.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJobResponse": { + "com.amazonaws.comprehend#DetectDominantLanguageResponse": { "type": "structure", "members": { - "KeyPhrasesDetectionJobProperties": { - "target": "com.amazonaws.comprehend#KeyPhrasesDetectionJobProperties", + "Languages": { + "target": "com.amazonaws.comprehend#ListOfDominantLanguages", "traits": { - "smithy.api#documentation": "An object that contains the properties associated with a key phrases detection job.\n
" + "smithy.api#documentation": "The languages that Amazon Comprehend detected in the input text. For each language, the\n response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend\n has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the\n IETF Tools web site.
" } } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} } }, - "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJob": { + "com.amazonaws.comprehend#DetectEntities": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobRequest" + "target": "com.amazonaws.comprehend#DetectEntitiesRequest" }, "output": { - "target": "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobResponse" + "target": "com.amazonaws.comprehend#DetectEntitiesResponse" }, "errors": [ { @@ -3916,43 +4541,103 @@ "target": "com.amazonaws.comprehend#InvalidRequestException" }, { - "target": "com.amazonaws.comprehend#JobNotFoundException" + "target": "com.amazonaws.comprehend#ResourceUnavailableException" }, { - "target": "com.amazonaws.comprehend#TooManyRequestsException" + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" } ], "traits": { - "smithy.api#documentation": "Gets the properties associated with a PII entities detection job. For example, you can use\n this operation to get the job status.
" + "smithy.api#documentation": "Detects named entities in input text when you use the pre-trained model.\n Detects custom entities if you have a custom entity recognition model.
\n\n When detecting named entities using the pre-trained model, use plain text as the input.\n For more information about named entities, see\n Entities in the Comprehend Developer Guide.
\nWhen you use a custom entity recognition model,\n you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
\nIf the system detects errors while processing a page in the input document, the API response\n includes an entry in Errors for each error.
If the system detects a document-level error in your input document, the API returns an\n InvalidRequestException error response.\n For details about this exception, see\n \n Errors in semi-structured documents in the Comprehend Developer Guide.\n
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its\n response.
", - "smithy.api#required": {} + "smithy.api#documentation": "A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter,\n do not use the Bytes parameter.
The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon\n Comprehend uses the language of your custom model, and it ignores any language code that you\n specify here.
\nAll input documents must be in the same language.
" + } + }, + "EndpointArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerEndpointArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of an endpoint that is associated with a custom entity\n recognition model. Provide an endpoint if you want to detect entities by using your own custom\n model instead of the default model that is used by Amazon Comprehend.
\nIf you specify an endpoint, Amazon Comprehend uses the language of your custom model, and\n it ignores any language code that you provide in your request.
\nFor information about endpoints, see Managing endpoints.
" + } + }, + "Bytes": { + "target": "com.amazonaws.comprehend#SemiStructuredDocumentBlob", + "traits": { + "smithy.api#documentation": "This field applies only when you use a custom entity recognition model that\n was trained with PDF annotations. For other cases,\n enter your text input in the Text field.
\n Use the Bytes parameter to input a text, PDF, Word or image file.\n Using a plain-text file in the Bytes parameter is equivelent to using the\n Text parameter (the Entities field in the response is identical).
You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText\n or AnalyzeDocument output file.
Provide the input document as a sequence of base64-encoded bytes.\n If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode\n the document file bytes for you.
\nThe maximum length of this field depends on the input document type. For details, see\n \n Inputs for real-time custom analysis in the Comprehend Developer Guide.
\nIf you use the Bytes parameter, do not use the Text parameter.
Provides configuration parameters to override the default actions for extracting text\n from PDF documents and image files.
" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobResponse": { + "com.amazonaws.comprehend#DetectEntitiesResponse": { "type": "structure", "members": { - "PiiEntitiesDetectionJobProperties": { - "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobProperties" + "Entities": { + "target": "com.amazonaws.comprehend#ListOfEntities", + "traits": { + "smithy.api#documentation": "A collection of entities identified in the input text. For each entity, the response\n provides the entity text, entity type, where the entity text begins and ends, and the level of\n confidence that Amazon Comprehend has in the detection.
\nIf your request uses a custom entity recognition model, Amazon Comprehend detects the\n entities that the model is trained to recognize. Otherwise, it detects the default entity\n types. For a list of default entity types, see\n Entities in the Comprehend Developer Guide.\n
" + } + }, + "DocumentMetadata": { + "target": "com.amazonaws.comprehend#DocumentMetadata", + "traits": { + "smithy.api#documentation": "Information about the document, discovered during text extraction. This field is present\n in the response only if your request used the Byte parameter.
The document type for each page in the input document. This field is present\n in the response only if your request used the Byte parameter.
Information about each block of text in the input document.\n Blocks are nested. A page block contains a block for each line of text,\n which contains a block for each word.
\nThe 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.
Page-level errors that the system detected while processing the input document.\n The field is empty if the system encountered no errors.
" + } } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} } }, - "com.amazonaws.comprehend#DescribeResourcePolicy": { + "com.amazonaws.comprehend#DetectKeyPhrases": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DescribeResourcePolicyRequest" + "target": "com.amazonaws.comprehend#DetectKeyPhrasesRequest" }, "output": { - "target": "com.amazonaws.comprehend#DescribeResourcePolicyResponse" + "target": "com.amazonaws.comprehend#DetectKeyPhrasesResponse" }, "errors": [ { @@ -3962,61 +4647,60 @@ "target": "com.amazonaws.comprehend#InvalidRequestException" }, { - "target": "com.amazonaws.comprehend#ResourceNotFoundException" + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" } ], "traits": { - "smithy.api#documentation": "Gets the details of a resource-based policy that is attached to a custom model, including\n the JSON body of the policy.
" + "smithy.api#documentation": "Detects the key noun phrases found in the text.
" } }, - "com.amazonaws.comprehend#DescribeResourcePolicyRequest": { + "com.amazonaws.comprehend#DetectKeyPhrasesRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.comprehend#ComprehendModelArn", + "Text": { + "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom model version that has the resource policy.
", + "smithy.api#documentation": "A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded\n characters.
", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#DescribeResourcePolicyResponse": { + "com.amazonaws.comprehend#DetectKeyPhrasesResponse": { "type": "structure", "members": { - "ResourcePolicy": { - "target": "com.amazonaws.comprehend#Policy", - "traits": { - "smithy.api#documentation": "The JSON body of the resource-based policy.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.comprehend#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the policy was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.comprehend#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the policy was last modified.
" - } - }, - "PolicyRevisionId": { - "target": "com.amazonaws.comprehend#PolicyRevisionId", + "KeyPhrases": { + "target": "com.amazonaws.comprehend#ListOfKeyPhrases", "traits": { - "smithy.api#documentation": "The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a\n new revision ID, and it deletes the prior version of the policy.
" + "smithy.api#documentation": "A collection of key phrases that Amazon Comprehend identified in the input text. For\n each key phrase, the response provides the text of the key phrase, where the key phrase begins\n and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the\n detection.
" } } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} } }, - "com.amazonaws.comprehend#DescribeSentimentDetectionJob": { + "com.amazonaws.comprehend#DetectPiiEntities": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJobRequest" + "target": "com.amazonaws.comprehend#DetectPiiEntitiesRequest" }, "output": { - "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJobResponse" + "target": "com.amazonaws.comprehend#DetectPiiEntitiesResponse" }, "errors": [ { @@ -4026,46 +4710,59 @@ "target": "com.amazonaws.comprehend#InvalidRequestException" }, { - "target": "com.amazonaws.comprehend#JobNotFoundException" + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" }, { - "target": "com.amazonaws.comprehend#TooManyRequestsException" + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" } ], "traits": { - "smithy.api#documentation": "Gets the properties associated with a sentiment detection job. Use this operation to get\n the status of a detection job.
" + "smithy.api#documentation": "Inspects the input text for entities that contain personally identifiable information\n (PII) and returns information about them.
" } }, - "com.amazonaws.comprehend#DescribeSentimentDetectionJobRequest": { + "com.amazonaws.comprehend#DetectPiiEntitiesRequest": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.comprehend#JobId", + "Text": { + "target": "com.amazonaws.comprehend#String", "traits": { - "smithy.api#documentation": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its\n response.
", + "smithy.api#documentation": "A UTF-8 text string. The maximum string size is 100 KB.
", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "The language of the input documents. Currently, English is the only valid language.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#DescribeSentimentDetectionJobResponse": { + "com.amazonaws.comprehend#DetectPiiEntitiesResponse": { "type": "structure", "members": { - "SentimentDetectionJobProperties": { - "target": "com.amazonaws.comprehend#SentimentDetectionJobProperties", + "Entities": { + "target": "com.amazonaws.comprehend#ListOfPiiEntities", "traits": { - "smithy.api#documentation": "An object that contains the properties associated with a sentiment detection job.
" + "smithy.api#documentation": "A collection of PII entities identified in the input text. For each entity, the response\n provides the entity type, where the entity text begins and ends, and the level of confidence\n that Amazon Comprehend has in the detection.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJob": { + "com.amazonaws.comprehend#DetectSentiment": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJobRequest" + "target": "com.amazonaws.comprehend#DetectSentimentRequest" }, "output": { - "target": "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJobResponse" + "target": "com.amazonaws.comprehend#DetectSentimentResponse" }, "errors": [ { @@ -4075,46 +4772,66 @@ "target": "com.amazonaws.comprehend#InvalidRequestException" }, { - "target": "com.amazonaws.comprehend#JobNotFoundException" + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" }, { - "target": "com.amazonaws.comprehend#TooManyRequestsException" + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" } ], "traits": { - "smithy.api#documentation": "Gets the properties associated with a targeted sentiment detection job. Use this operation\n to get the status of the job.
" + "smithy.api#documentation": "Inspects text and returns an inference of the prevailing sentiment\n (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its\n response.
", + "smithy.api#documentation": "A UTF-8 text string. The maximum string size is 5 KB.
\nAmazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text\n and ignores any additional text in the input.
\nThe language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#DescribeTargetedSentimentDetectionJobResponse": { + "com.amazonaws.comprehend#DetectSentimentResponse": { "type": "structure", "members": { - "TargetedSentimentDetectionJobProperties": { - "target": "com.amazonaws.comprehend#TargetedSentimentDetectionJobProperties", + "Sentiment": { + "target": "com.amazonaws.comprehend#SentimentType", "traits": { - "smithy.api#documentation": "An object that contains the properties associated with a targeted sentiment detection job.
" + "smithy.api#documentation": "The inferred sentiment that Amazon Comprehend has the highest level of confidence\n in.
" + } + }, + "SentimentScore": { + "target": "com.amazonaws.comprehend#SentimentScore", + "traits": { + "smithy.api#documentation": "An object that lists the sentiments, and their corresponding confidence\n levels.
" } } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} } }, - "com.amazonaws.comprehend#DescribeTopicsDetectionJob": { + "com.amazonaws.comprehend#DetectSyntax": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DescribeTopicsDetectionJobRequest" + "target": "com.amazonaws.comprehend#DetectSyntaxRequest" }, "output": { - "target": "com.amazonaws.comprehend#DescribeTopicsDetectionJobResponse" + "target": "com.amazonaws.comprehend#DetectSyntaxResponse" }, "errors": [ { @@ -4124,46 +4841,60 @@ "target": "com.amazonaws.comprehend#InvalidRequestException" }, { - "target": "com.amazonaws.comprehend#JobNotFoundException" + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" }, { - "target": "com.amazonaws.comprehend#TooManyRequestsException" + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" } ], "traits": { - "smithy.api#documentation": "Gets the properties associated with a topic detection job. Use this operation to get\n the status of a detection job.
" + "smithy.api#documentation": "Inspects text for syntax and the part of speech of words in the document. For more\n information, see\n Syntax in the Comprehend Developer Guide.\n
" } }, - "com.amazonaws.comprehend#DescribeTopicsDetectionJobRequest": { + "com.amazonaws.comprehend#DetectSyntaxRequest": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.comprehend#JobId", + "Text": { + "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { - "smithy.api#documentation": "The identifier assigned by the user to the detection job.
", + "smithy.api#documentation": "A UTF-8 string. The maximum string size is 5 KB.
", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#SyntaxLanguageCode", + "traits": { + "smithy.api#documentation": "The language code of the input documents. You can specify any of the following languages\n supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"),\n Italian (\"it\"), or Portuguese (\"pt\").
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#DescribeTopicsDetectionJobResponse": { + "com.amazonaws.comprehend#DetectSyntaxResponse": { "type": "structure", "members": { - "TopicsDetectionJobProperties": { - "target": "com.amazonaws.comprehend#TopicsDetectionJobProperties", + "SyntaxTokens": { + "target": "com.amazonaws.comprehend#ListOfSyntaxTokens", "traits": { - "smithy.api#documentation": "The list of properties for the requested job.
" + "smithy.api#documentation": "A collection of syntax tokens describing the text. For each token, the response provides\n the text, the token type, where the text begins and ends, and the level of confidence that\n Amazon Comprehend has that the token is correct. For a list of token types, see\n Syntax in the Comprehend Developer Guide.\n
" } } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} } }, - "com.amazonaws.comprehend#DetectDominantLanguage": { + "com.amazonaws.comprehend#DetectTargetedSentiment": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DetectDominantLanguageRequest" + "target": "com.amazonaws.comprehend#DetectTargetedSentimentRequest" }, "output": { - "target": "com.amazonaws.comprehend#DetectDominantLanguageResponse" + "target": "com.amazonaws.comprehend#DetectTargetedSentimentResponse" }, "errors": [ { @@ -4174,1105 +4905,1226 @@ }, { "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" } ], "traits": { - "smithy.api#documentation": "Determines the dominant language of the input text. For a list of languages that Amazon\n Comprehend can detect, see Amazon Comprehend Supported Languages.
" + "smithy.api#documentation": "Inspects the input text and returns a sentiment analysis for each entity identified in the text.
\nFor more information about targeted sentiment, see Targeted sentiment.
" } }, - "com.amazonaws.comprehend#DetectDominantLanguageRequest": { + "com.amazonaws.comprehend#DetectTargetedSentimentRequest": { "type": "structure", "members": { "Text": { "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { - "smithy.api#documentation": "A UTF-8 text string. The string must contain at least 20 characters. The maximum string size is 100 KB.
", + "smithy.api#documentation": "A UTF-8 text string. The maximum string length is 5 KB.
", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "The language of the input documents. Currently, English is the only supported language.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.comprehend#DetectDominantLanguageResponse": { + "com.amazonaws.comprehend#DetectTargetedSentimentResponse": { "type": "structure", "members": { - "Languages": { - "target": "com.amazonaws.comprehend#ListOfDominantLanguages", + "Entities": { + "target": "com.amazonaws.comprehend#ListOfTargetedSentimentEntities", "traits": { - "smithy.api#documentation": "The languages that Amazon Comprehend detected in the input text. For each language, the\n response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend\n has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the\n IETF Tools web site.
" + "smithy.api#documentation": "Targeted sentiment analysis for each of the entities identified in the input text.
" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.comprehend#DocumentClass": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "The name of the class.
" + } + }, + "Score": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "The confidence score that Amazon Comprehend has this class correctly attributed.
" + } + }, + "Page": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "Page number in the input document. This field is present\n in the response only if your request includes the Byte parameter.
Specifies the class that categorizes the document being analyzed
" + } + }, + "com.amazonaws.comprehend#DocumentClassificationConfig": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.comprehend#DocumentClassifierMode", + "traits": { + "smithy.api#documentation": "Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.
One or more labels to associate with the custom classifier.
" } } }, "traits": { - "smithy.api#sensitive": {} + "smithy.api#documentation": "Configuration required for a custom classification model.
" } }, - "com.amazonaws.comprehend#DetectEntities": { - "type": "operation", - "input": { - "target": "com.amazonaws.comprehend#DetectEntitiesRequest" - }, - "output": { - "target": "com.amazonaws.comprehend#DetectEntitiesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.comprehend#InternalServerException" - }, - { - "target": "com.amazonaws.comprehend#InvalidRequestException" + "com.amazonaws.comprehend#DocumentClassificationJobFilter": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "Filters on the name of the job.
" + } }, - { - "target": "com.amazonaws.comprehend#ResourceUnavailableException" + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "Filters the list based on job status. Returns only jobs with the specified status.
" + } }, - { - "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.
" + } }, - { - "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.
" + } } - ], + }, "traits": { - "smithy.api#documentation": "Detects named entities in input text when you use the pre-trained model. \n Detects custom entities if you have a custom entity recognition model.
\n\n When detecting named entities using the pre-trained model, use plain text as the input.\n For more information about named entities, see\n Entities in the Comprehend Developer Guide.
\nWhen you use a custom entity recognition model, \n you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
\nIf the system detects errors while processing a page in the input document, the API response \n includes an entry in Errors for each error.
If the system detects a document-level error in your input document, the API returns an \n InvalidRequestException error response. \n For details about this exception, see\n \n Errors in semi-structured documents in the Comprehend Developer Guide. \n
Provides information for filtering a list of document classification jobs. For more\n information, see the operation. You can\n provide only one filter parameter in each request.
" } }, - "com.amazonaws.comprehend#DetectEntitiesRequest": { + "com.amazonaws.comprehend#DocumentClassificationJobProperties": { "type": "structure", "members": { - "Text": { - "target": "com.amazonaws.comprehend#CustomerInputString", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter,\n do not use the Bytes parameter.
The identifier assigned to the document classification job.
" } }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", "traits": { - "smithy.api#documentation": "The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon\n Comprehend uses the language of your custom model, and it ignores any language code that you\n specify here.
\nAll input documents must be in the same language.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:
\n\n arn:\n
The following is an example job ARN:
\n\n arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab\n
The Amazon Resource Name of an endpoint that is associated with a custom entity\n recognition model. Provide an endpoint if you want to detect entities by using your own custom\n model instead of the default model that is used by Amazon Comprehend.
\nIf you specify an endpoint, Amazon Comprehend uses the language of your custom model, and\n it ignores any language code that you provide in your request.
\nFor information about endpoints, see Managing endpoints.
" + "smithy.api#documentation": "The name that you assigned to the document classification job.
" } }, - "Bytes": { - "target": "com.amazonaws.comprehend#SemiStructuredDocumentBlob", + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", "traits": { - "smithy.api#documentation": "This field applies only when you use a custom entity recognition model that\n was trained with PDF annotations. For other cases, \n enter your text input in the Text field.
\n Use the Bytes parameter to input a text, PDF, Word or image file.\n Using a plain-text file in the Bytes parameter is equivelent to using the \n Text parameter (the Entities field in the response is identical).
You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText \n or AnalyzeDocument output file.
Provide the input document as a sequence of base64-encoded bytes. \n If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode \n the document file bytes for you.
\nThe maximum length of this field depends on the input document type. For details, see\n \n Inputs for real-time custom analysis in the Comprehend Developer Guide.
\nIf you use the Bytes parameter, do not use the Text parameter.
The current status of the document classification job. If the status is\n FAILED, the Message field shows the reason for the failure.
Provides configuration parameters to override the default actions for extracting text \n from PDF documents and image files.
" + "smithy.api#documentation": "A description of the status of the job.
" } - } - } - }, - "com.amazonaws.comprehend#DetectEntitiesResponse": { - "type": "structure", - "members": { - "Entities": { - "target": "com.amazonaws.comprehend#ListOfEntities", + }, + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "A collection of entities identified in the input text. For each entity, the response\n provides the entity text, entity type, where the entity text begins and ends, and the level of\n confidence that Amazon Comprehend has in the detection.
\nIf your request uses a custom entity recognition model, Amazon Comprehend detects the\n entities that the model is trained to recognize. Otherwise, it detects the default entity\n types. For a list of default entity types, see\n Entities in the Comprehend Developer Guide.\n
" + "smithy.api#documentation": "The time that the document classification job was submitted for processing.
" } }, - "DocumentMetadata": { - "target": "com.amazonaws.comprehend#DocumentMetadata", + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "Information about the document, discovered during text extraction. This field is present\n in the response only if your request used the Byte parameter.
The time that the document classification job completed.
" } }, - "DocumentType": { - "target": "com.amazonaws.comprehend#ListOfDocumentType", + "DocumentClassifierArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", "traits": { - "smithy.api#documentation": "The document type for each page in the input document. This field is present\n in the response only if your request used the Byte parameter.
The Amazon Resource Name (ARN) that identifies the document classifier.
" } }, - "Blocks": { - "target": "com.amazonaws.comprehend#ListOfBlocks", + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { - "smithy.api#documentation": "Information about each block of text in the input document. \n Blocks are nested. A page block contains a block for each line of text, \n which contains a block for each word.
\nThe 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.
The input data configuration that you supplied when you created the document\n classification job.
" } }, - "Errors": { - "target": "com.amazonaws.comprehend#ListOfErrors", + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "The output data configuration that you supplied when you created the document\n classification job.
" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Page-level errors that the system detected while processing the input document. \n The field is empty if the system encountered no errors.
" + "smithy.api#documentation": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your document classification job. For more information, see Amazon\n VPC.
" + } + }, + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel
" } } }, "traits": { - "smithy.api#sensitive": {} + "smithy.api#documentation": "Provides information about a document classification job.
" } }, - "com.amazonaws.comprehend#DetectKeyPhrases": { - "type": "operation", - "input": { - "target": "com.amazonaws.comprehend#DetectKeyPhrasesRequest" - }, - "output": { - "target": "com.amazonaws.comprehend#DetectKeyPhrasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.comprehend#InternalServerException" - }, - { - "target": "com.amazonaws.comprehend#InvalidRequestException" - }, - { - "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" - }, - { - "target": "com.amazonaws.comprehend#UnsupportedLanguageException" - } - ], + "com.amazonaws.comprehend#DocumentClassificationJobPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DocumentClassificationJobProperties" + } + }, + "com.amazonaws.comprehend#DocumentClassifierArn": { + "type": "string", "traits": { - "smithy.api#documentation": "Detects the key noun phrases found in the text.
" + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?$" } }, - "com.amazonaws.comprehend#DetectKeyPhrasesRequest": { - "type": "structure", + "com.amazonaws.comprehend#DocumentClassifierAugmentedManifestsList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#AugmentedManifestsListItem" + } + }, + "com.amazonaws.comprehend#DocumentClassifierDataFormat": { + "type": "enum", "members": { - "Text": { - "target": "com.amazonaws.comprehend#CustomerInputString", + "COMPREHEND_CSV": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded\n characters.
", - "smithy.api#required": {} + "smithy.api#enumValue": "COMPREHEND_CSV" } }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "AUGMENTED_MANIFEST": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.
", - "smithy.api#required": {} + "smithy.api#enumValue": "AUGMENTED_MANIFEST" } } } }, - "com.amazonaws.comprehend#DetectKeyPhrasesResponse": { + "com.amazonaws.comprehend#DocumentClassifierEndpointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.comprehend#DocumentClassifierFilter": { "type": "structure", "members": { - "KeyPhrases": { - "target": "com.amazonaws.comprehend#ListOfKeyPhrases", + "Status": { + "target": "com.amazonaws.comprehend#ModelStatus", "traits": { - "smithy.api#documentation": "A collection of key phrases that Amazon Comprehend identified in the input text. For\n each key phrase, the response provides the text of the key phrase, where the key phrase begins\n and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the\n detection.
" + "smithy.api#documentation": "Filters the list of classifiers based on status.
" + } + }, + "DocumentClassifierName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "The name that you assigned to the document classifier
" + } + }, + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "Filters the list of classifiers based on the time that the classifier was submitted for\n processing. Returns only classifiers submitted before the specified time. Classifiers are\n returned in ascending order, oldest to newest.
" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "Filters the list of classifiers based on the time that the classifier was submitted for\n processing. Returns only classifiers submitted after the specified time. Classifiers are\n returned in descending order, newest to oldest.
" } } }, "traits": { - "smithy.api#sensitive": {} + "smithy.api#documentation": "Provides information for filtering a list of document classifiers. You can only specify\n one filtering parameter in a request. For more information, see the \n ListDocumentClassifiers operation.
The format of your training data:
\n\n COMPREHEND_CSV: A two-column CSV file, where labels are provided in the\n first column, and documents are provided in the second. If you use this value, you must\n provide the S3Uri parameter in your request.
\n AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon\n SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON\n object that contains a training document and its associated labels.
If you use this value, you must provide the AugmentedManifests parameter\n in your request.
If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the\n default.
The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API\n endpoint that you are calling. The URI can point to a single input file or it can provide the\n prefix for a collection of input files.
\nFor example, if you use the URI S3://bucketName/prefix, if the prefix is a\n single file, Amazon Comprehend uses that file as input. If more than one file begins with the\n prefix, Amazon Comprehend uses all of them as input.
This parameter is required if you set DataFormat to\n COMPREHEND_CSV.
This specifies the Amazon S3 location where the test annotations for an entity recognizer\n are located. The URI must be in the same AWS Region as the API endpoint that you are\n calling.
" + } }, - { - "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + "LabelDelimiter": { + "target": "com.amazonaws.comprehend#LabelDelimiter", + "traits": { + "smithy.api#documentation": "Indicates the delimiter used to separate each label for training a multi-label classifier.\n The default delimiter between labels is a pipe (|). You can use a different character as a\n delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the\n training documents use a delimiter other than the default or the delimiter you specify, the\n labels on that line will be combined to make a single unique label, such as\n LABELLABELLABEL.
" + } }, - { - "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + "AugmentedManifests": { + "target": "com.amazonaws.comprehend#DocumentClassifierAugmentedManifestsList", + "traits": { + "smithy.api#documentation": "A list of augmented manifest files that provide training data for your custom model. An\n augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground\n Truth.
\nThis parameter is required if you set DataFormat to\n AUGMENTED_MANIFEST.
Inspects the input text for entities that contain personally identifiable information\n (PII) and returns information about them.
" + "smithy.api#documentation": "The input properties for training a document classifier.
\nFor more information on how the input file is formatted, see\n Preparing training data in the Comprehend Developer Guide.\n
" } }, - "com.amazonaws.comprehend#DetectPiiEntitiesRequest": { - "type": "structure", + "com.amazonaws.comprehend#DocumentClassifierMode": { + "type": "enum", "members": { - "Text": { - "target": "com.amazonaws.comprehend#String", + "MULTI_CLASS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A UTF-8 text string. The maximum string size is 100 KB.
", - "smithy.api#required": {} + "smithy.api#enumValue": "MULTI_CLASS" } }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "MULTI_LABEL": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The language of the input documents. Currently, English is the only valid language.
", - "smithy.api#required": {} + "smithy.api#enumValue": "MULTI_LABEL" } } } }, - "com.amazonaws.comprehend#DetectPiiEntitiesResponse": { + "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig": { "type": "structure", "members": { - "Entities": { - "target": "com.amazonaws.comprehend#ListOfPiiEntities", + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "A collection of PII entities identified in the input text. For each entity, the response\n provides the entity type, where the entity text begins and ends, and the level of confidence\n that Amazon Comprehend has in the detection.
" + "smithy.api#documentation": "When you use the OutputDataConfig object while creating a custom\n classifier, you specify the Amazon S3 location where you want to write the confusion matrix.\n The URI must be in the same region as the API endpoint that you are calling. The location is\n 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\n directory specific to the job. The S3Uri field contains the location of the\n output file, called output.tar.gz. It is a compressed archive that contains the\n confusion matrix.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the\n output results from an analysis job. The KmsKeyId can be one of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
KMS Key Alias: \"alias/ExampleAlias\"\n
ARN of a KMS Key Alias:\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n
The Amazon S3 prefix for the data lake location of the flywheel statistics.
" + } } - ], + }, "traits": { - "smithy.api#documentation": "Inspects text and returns an inference of the prevailing sentiment\n (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
Provides output results configuration parameters for custom classifier jobs.
" } }, - "com.amazonaws.comprehend#DetectSentimentRequest": { + "com.amazonaws.comprehend#DocumentClassifierProperties": { "type": "structure", "members": { - "Text": { - "target": "com.amazonaws.comprehend#CustomerInputString", + "DocumentClassifierArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", "traits": { - "smithy.api#documentation": "A UTF-8 text string. The maximum string size is 5 KB.
\nAmazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text\n and ignores any additional text in the input.
\nThe Amazon Resource Name (ARN) that identifies the document classifier.
" } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.
", - "smithy.api#required": {} + "smithy.api#documentation": "The language code for the language of the documents that the classifier was trained\n on.
" } - } - } - }, - "com.amazonaws.comprehend#DetectSentimentResponse": { - "type": "structure", - "members": { - "Sentiment": { - "target": "com.amazonaws.comprehend#SentimentType", + }, + "Status": { + "target": "com.amazonaws.comprehend#ModelStatus", "traits": { - "smithy.api#documentation": "The inferred sentiment that Amazon Comprehend has the highest level of confidence\n in.
" + "smithy.api#documentation": "The status of the document classifier. If the status is TRAINED the\n classifier is ready to use. If the status is FAILED you can see additional\n information about why the classifier wasn't trained in the Message field.
An object that lists the sentiments, and their corresponding confidence\n levels.
" + "smithy.api#documentation": "Additional information about the status of the classifier.
" } - } - }, - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.comprehend#DetectSyntax": { - "type": "operation", - "input": { - "target": "com.amazonaws.comprehend#DetectSyntaxRequest" - }, - "output": { - "target": "com.amazonaws.comprehend#DetectSyntaxResponse" - }, - "errors": [ - { - "target": "com.amazonaws.comprehend#InternalServerException" }, - { - "target": "com.amazonaws.comprehend#InvalidRequestException" + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the document classifier was submitted for training.
" + } }, - { - "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "The time that training the document classifier completed.
" + } }, - { - "target": "com.amazonaws.comprehend#UnsupportedLanguageException" - } - ], - "traits": { - "smithy.api#documentation": "Inspects text for syntax and the part of speech of words in the document. For more\n information, see\n Syntax in the Comprehend Developer Guide.\n
" - } - }, - "com.amazonaws.comprehend#DetectSyntaxRequest": { - "type": "structure", - "members": { - "Text": { - "target": "com.amazonaws.comprehend#CustomerInputString", + "TrainingStartTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "A UTF-8 string. The maximum string size is 5 KB.
", - "smithy.api#required": {} + "smithy.api#documentation": "Indicates the time when the training starts on documentation classifiers. You are billed\n for the time interval between this time and the value of TrainingEndTime.
" } }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#SyntaxLanguageCode", + "TrainingEndTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "The language code of the input documents. You can specify any of the following languages\n supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"),\n Italian (\"it\"), or Portuguese (\"pt\").
", - "smithy.api#required": {} + "smithy.api#documentation": "The time that training of the document classifier was completed. Indicates the time when\n the training completes on documentation classifiers. You are billed for the time interval\n between this time and the value of TrainingStartTime.
" } - } - } - }, - "com.amazonaws.comprehend#DetectSyntaxResponse": { - "type": "structure", - "members": { - "SyntaxTokens": { - "target": "com.amazonaws.comprehend#ListOfSyntaxTokens", + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#DocumentClassifierInputDataConfig", "traits": { - "smithy.api#documentation": "A collection of syntax tokens describing the text. For each token, the response provides\n the text, the token type, where the text begins and ends, and the level of confidence that\n Amazon Comprehend has that the token is correct. For a list of token types, see\n Syntax in the Comprehend Developer Guide.\n
" + "smithy.api#documentation": "The input data configuration that you supplied when you created the document classifier\n for training.
" } - } - }, - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.comprehend#DetectTargetedSentiment": { - "type": "operation", - "input": { - "target": "com.amazonaws.comprehend#DetectTargetedSentimentRequest" - }, - "output": { - "target": "com.amazonaws.comprehend#DetectTargetedSentimentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.comprehend#InternalServerException" }, - { - "target": "com.amazonaws.comprehend#InvalidRequestException" + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig", + "traits": { + "smithy.api#documentation": "Provides output results configuration parameters for custom classifier jobs.
" + } }, - { - "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + "ClassifierMetadata": { + "target": "com.amazonaws.comprehend#ClassifierMetadata", + "traits": { + "smithy.api#documentation": "Information about the document classifier, including the number of documents used for\n training the classifier, the number of documents used for test the classifier, and an accuracy\n rating.
" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your custom classifier. For more information, see Amazon\n VPC.
" + } + }, + "Mode": { + "target": "com.amazonaws.comprehend#DocumentClassifierMode", + "traits": { + "smithy.api#documentation": "Indicates the mode in which the specific classifier was trained. This also indicates the\n format of input documents and the format of the confusion matrix. Each classifier can only be\n trained in one mode and this cannot be changed once the classifier is trained.
" + } + }, + "ModelKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The version name that you assigned to the document classifier.
" + } + }, + "SourceModelArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source model. This model was imported from a\n different AWS account to create the document classifier model in your AWS account.
" + } }, - { - "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel
" + } } - ], + }, "traits": { - "smithy.api#documentation": "Inspects the input text and returns a sentiment analysis for each entity identified in the text.
\nFor more information about targeted sentiment, see Targeted sentiment.
" + "smithy.api#documentation": "Provides information about a document classifier.
" } }, - "com.amazonaws.comprehend#DetectTargetedSentimentRequest": { + "com.amazonaws.comprehend#DocumentClassifierPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DocumentClassifierProperties" + } + }, + "com.amazonaws.comprehend#DocumentClassifierSummariesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DocumentClassifierSummary" + } + }, + "com.amazonaws.comprehend#DocumentClassifierSummary": { "type": "structure", "members": { - "Text": { - "target": "com.amazonaws.comprehend#CustomerInputString", + "DocumentClassifierName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", "traits": { - "smithy.api#documentation": "A UTF-8 text string. The maximum string length is 5 KB.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name that you assigned the document classifier.
" } }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "NumberOfVersions": { + "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "The language of the input documents. Currently, English is the only supported language.
", - "smithy.api#required": {} + "smithy.api#documentation": "The number of versions you created.
" } - } - } - }, - "com.amazonaws.comprehend#DetectTargetedSentimentResponse": { - "type": "structure", - "members": { - "Entities": { - "target": "com.amazonaws.comprehend#ListOfTargetedSentimentEntities", + }, + "LatestVersionCreatedAt": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "Targeted sentiment analysis for each of the entities identified in the input text.
" + "smithy.api#documentation": "The time that the latest document classifier version was submitted for processing.
" + } + }, + "LatestVersionName": { + "target": "com.amazonaws.comprehend#VersionName", + "traits": { + "smithy.api#documentation": "The version name you assigned to the latest document classifier version.
" + } + }, + "LatestVersionStatus": { + "target": "com.amazonaws.comprehend#ModelStatus", + "traits": { + "smithy.api#documentation": "Provides the status of the latest document classifier version.
" } } }, "traits": { - "smithy.api#sensitive": {} + "smithy.api#documentation": "Describes information about a document classifier and its versions.
" } }, - "com.amazonaws.comprehend#DocumentClass": { + "com.amazonaws.comprehend#DocumentLabel": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.comprehend#String", "traits": { - "smithy.api#documentation": "The name of the class.
" + "smithy.api#documentation": "The name of the label.
" } }, "Score": { "target": "com.amazonaws.comprehend#Float", "traits": { - "smithy.api#documentation": "The confidence score that Amazon Comprehend has this class correctly attributed.
" + "smithy.api#documentation": "The confidence score that Amazon Comprehend has this label correctly attributed.
" } }, "Page": { "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "Page number in the input document. This field is present\n in the response only if your request includes the Byte parameter.
Page number where the label occurs. This field is present\n in the response only if your request includes the Byte parameter.
Specifies the class that categorizes the document being analyzed
" + "smithy.api#documentation": "Specifies one of the label or labels that categorize the document being analyzed.
" } }, - "com.amazonaws.comprehend#DocumentClassificationJobFilter": { + "com.amazonaws.comprehend#DocumentMetadata": { "type": "structure", "members": { - "JobName": { - "target": "com.amazonaws.comprehend#JobName", + "Pages": { + "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "Filters on the name of the job.
" + "smithy.api#documentation": "Number of pages in the document.
" } }, - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", + "ExtractedCharacters": { + "target": "com.amazonaws.comprehend#ListOfExtractedCharacters", "traits": { - "smithy.api#documentation": "Filters the list based on job status. Returns only jobs with the specified status.
" + "smithy.api#documentation": "List of pages in the document, with the number of characters extracted from each page.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the document, discovered during text extraction.
" + } + }, + "com.amazonaws.comprehend#DocumentReadAction": { + "type": "enum", + "members": { + "TEXTRACT_DETECT_DOCUMENT_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXTRACT_DETECT_DOCUMENT_TEXT" } }, - "SubmitTimeBefore": { - "target": "com.amazonaws.comprehend#Timestamp", + "TEXTRACT_ANALYZE_DOCUMENT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.
" + "smithy.api#enumValue": "TEXTRACT_ANALYZE_DOCUMENT" + } + } + } + }, + "com.amazonaws.comprehend#DocumentReadFeatureTypes": { + "type": "enum", + "members": { + "TABLES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TABLES" } }, - "SubmitTimeAfter": { - "target": "com.amazonaws.comprehend#Timestamp", + "FORMS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.
" + "smithy.api#enumValue": "FORMS" } } }, "traits": { - "smithy.api#documentation": "Provides information for filtering a list of document classification jobs. For more\n information, see the operation. You can\n provide only one filter parameter in each request.
" + "smithy.api#documentation": "Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT\n as the read action, you must specify one or both of the following values:
\n TABLES - Returns additional information about any tables that are detected in the input document.
\n FORMS - Returns additional information about any forms that are detected in the input document.
The identifier assigned to the document classification job.
" + "smithy.api#enumValue": "SERVICE_DEFAULT" } }, - "JobArn": { - "target": "com.amazonaws.comprehend#ComprehendArn", + "FORCE_DOCUMENT_READ_ACTION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:
\n\n arn:\n
The following is an example job ARN:
\n\n arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab\n
The name that you assigned to the document classification job.
" + "smithy.api#documentation": "This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files.\n Enter one of the following values:
\n\n TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText\n API operation.
\n TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument\n API operation.
The current status of the document classification job. If the status is\n FAILED, the Message field shows the reason for the failure.
Determines the text extraction actions for PDF files. Enter one of the following values:
\n\n SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.
\n FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by\n DocumentReadAction for all PDF files, including digital PDF files.
A description of the status of the job.
" + "smithy.api#documentation": "Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT\n as the read action, you must specify one or both of the following values:
\n TABLES - Returns information about any tables that are detected in the input document.
\n FORMS - Returns information and the data from any forms that are detected in the input document.
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
\nBy default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:
\n\n Word files - Amazon Comprehend parser extracts the text.
\n\n Digital PDF files - Amazon Comprehend parser extracts the text.
\n\n Image files and scanned PDF files - Amazon Comprehend uses the Amazon Textract DetectDocumentText\n API to extract the text.
\n DocumentReaderConfig does not apply to plain text files or Word files.
\n For image files and PDF documents, you can override these default actions using the fields listed below.\n For more information, see \n Setting text extraction options.\n
" + } + }, + "com.amazonaws.comprehend#DocumentType": { + "type": "enum", + "members": { + "NATIVE_PDF": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The time that the document classification job was submitted for processing.
" + "smithy.api#enumValue": "NATIVE_PDF" } }, - "EndTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "SCANNED_PDF": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The time that the document classification job completed.
" + "smithy.api#enumValue": "SCANNED_PDF" } }, - "DocumentClassifierArn": { - "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "MS_WORD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the document classifier.
" + "smithy.api#enumValue": "MS_WORD" } }, - "InputDataConfig": { - "target": "com.amazonaws.comprehend#InputDataConfig", + "IMAGE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The input data configuration that you supplied when you created the document\n classification job.
" + "smithy.api#enumValue": "IMAGE" } }, - "OutputDataConfig": { - "target": "com.amazonaws.comprehend#OutputDataConfig", + "PLAIN_TEXT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The output data configuration that you supplied when you created the document\n classification job.
" + "smithy.api#enumValue": "PLAIN_TEXT" } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
" + "smithy.api#enumValue": "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON" } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "TEXTRACT_ANALYZE_DOCUMENT_JSON": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Page number.
" } }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", + "Type": { + "target": "com.amazonaws.comprehend#DocumentType", "traits": { - "smithy.api#documentation": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your document classification job. For more information, see Amazon\n VPC.
" + "smithy.api#documentation": "Document type.
" } } }, - "traits": { - "smithy.api#documentation": "Provides information about a document classification job.
" - } - }, - "com.amazonaws.comprehend#DocumentClassificationJobPropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.comprehend#DocumentClassificationJobProperties" - } - }, - "com.amazonaws.comprehend#DocumentClassifierArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?$" - } - }, - "com.amazonaws.comprehend#DocumentClassifierAugmentedManifestsList": { - "type": "list", - "member": { - "target": "com.amazonaws.comprehend#AugmentedManifestsListItem" + "traits": { + "smithy.api#documentation": "Document type for each page in the document.
" } }, - "com.amazonaws.comprehend#DocumentClassifierDataFormat": { - "type": "enum", + "com.amazonaws.comprehend#DominantLanguage": { + "type": "structure", "members": { - "COMPREHEND_CSV": { - "target": "smithy.api#Unit", + "LanguageCode": { + "target": "com.amazonaws.comprehend#String", "traits": { - "smithy.api#enumValue": "COMPREHEND_CSV" + "smithy.api#documentation": "The RFC 5646 language code for the dominant language. For more information about RFC\n 5646, see Tags for Identifying\n Languages on the IETF Tools web site.
" } }, - "AUGMENTED_MANIFEST": { - "target": "smithy.api#Unit", + "Score": { + "target": "com.amazonaws.comprehend#Float", "traits": { - "smithy.api#enumValue": "AUGMENTED_MANIFEST" + "smithy.api#documentation": "The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.
" } } - } - }, - "com.amazonaws.comprehend#DocumentClassifierEndpointArn": { - "type": "string", + }, "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + "smithy.api#documentation": "Returns the code for the dominant language in the input text and the level of\n confidence that Amazon Comprehend has in the accuracy of the detection.
" } }, - "com.amazonaws.comprehend#DocumentClassifierFilter": { + "com.amazonaws.comprehend#DominantLanguageDetectionJobFilter": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.comprehend#ModelStatus", + "JobName": { + "target": "com.amazonaws.comprehend#JobName", "traits": { - "smithy.api#documentation": "Filters the list of classifiers based on status.
" + "smithy.api#documentation": "Filters on the name of the job.
" } }, - "DocumentClassifierName": { - "target": "com.amazonaws.comprehend#ComprehendArnName", + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", "traits": { - "smithy.api#documentation": "The name that you assigned to the document classifier
" + "smithy.api#documentation": "Filters the list of jobs based on job status. Returns only jobs with the specified\n status.
" } }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "Filters the list of classifiers based on the time that the classifier was submitted for\n processing. Returns only classifiers submitted before the specified time. Classifiers are\n returned in ascending order, oldest to newest.
" + "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.
" } }, "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "Filters the list of classifiers based on the time that the classifier was submitted for\n processing. Returns only classifiers submitted after the specified time. Classifiers are\n returned in descending order, newest to oldest.
" + "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.
" } } }, "traits": { - "smithy.api#documentation": "Provides information for filtering a list of document classifiers. You can only specify\n one filtering parameter in a request. For more information, see the operation.
" + "smithy.api#documentation": "Provides information for filtering a list of dominant language detection jobs. For more\n information, see the \n operation.
" } }, - "com.amazonaws.comprehend#DocumentClassifierInputDataConfig": { + "com.amazonaws.comprehend#DominantLanguageDetectionJobProperties": { "type": "structure", "members": { - "DataFormat": { - "target": "com.amazonaws.comprehend#DocumentClassifierDataFormat", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "The format of your training data:
\n\n COMPREHEND_CSV: A two-column CSV file, where labels are provided in the\n first column, and documents are provided in the second. If you use this value, you must\n provide the S3Uri parameter in your request.
\n AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon\n SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON\n object that contains a training document and its associated labels.
If you use this value, you must provide the AugmentedManifests parameter\n in your request.
If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the\n default.
The identifier assigned to the dominant language detection job.
" } }, - "S3Uri": { - "target": "com.amazonaws.comprehend#S3Uri", + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", "traits": { - "smithy.api#documentation": "The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API\n endpoint that you are calling. The URI can point to a single input file or it can provide the\n prefix for a collection of input files.
\nFor example, if you use the URI S3://bucketName/prefix, if the prefix is a\n single file, Amazon Comprehend uses that file as input. If more than one file begins with the\n prefix, Amazon Comprehend uses all of them as input.
This parameter is required if you set DataFormat to\n COMPREHEND_CSV.
The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique,\n fully qualified identifier for the job. It includes the AWS account, Region, and the job ID.\n The format of the ARN is as follows:
\n\n arn:\n
The following is an example job ARN:
\n\n arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab\n
This specifies the Amazon S3 location where the test annotations for an entity recognizer\n are located. The URI must be in the same AWS Region as the API endpoint that you are\n calling.
" + "smithy.api#documentation": "The name that you assigned to the dominant language detection job.
" } }, - "LabelDelimiter": { - "target": "com.amazonaws.comprehend#LabelDelimiter", + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", "traits": { - "smithy.api#documentation": "Indicates the delimiter used to separate each label for training a multi-label classifier.\n The default delimiter between labels is a pipe (|). You can use a different character as a\n delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the\n training documents use a delimiter other than the default or the delimiter you specify, the\n labels on that line will be combined to make a single unique label, such as\n LABELLABELLABEL.
" + "smithy.api#documentation": "The current status of the dominant language detection job. If the status is\n FAILED, the Message field shows the reason for the failure.
A list of augmented manifest files that provide training data for your custom model. An\n augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground\n Truth.
\nThis parameter is required if you set DataFormat to\n AUGMENTED_MANIFEST.
A description for the status of a job.
" } - } - }, - "traits": { - "smithy.api#documentation": "The input properties for training a document classifier.
\nFor more information on how the input file is formatted, see\n Preparing training data in the Comprehend Developer Guide.\n
" - } - }, - "com.amazonaws.comprehend#DocumentClassifierMode": { - "type": "enum", - "members": { - "MULTI_CLASS": { - "target": "smithy.api#Unit", + }, + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#enumValue": "MULTI_CLASS" + "smithy.api#documentation": "The time that the dominant language detection job was submitted for processing.
" } }, - "MULTI_LABEL": { - "target": "smithy.api#Unit", + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#enumValue": "MULTI_LABEL" + "smithy.api#documentation": "The time that the dominant language detection job completed.
" } - } - } - }, - "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig": { - "type": "structure", - "members": { - "S3Uri": { - "target": "com.amazonaws.comprehend#S3Uri", + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { - "smithy.api#documentation": "When you use the OutputDataConfig object while creating a custom\n classifier, you specify the Amazon S3 location where you want to write the confusion matrix.\n The URI must be in the same region as the API endpoint that you are calling. The location is\n 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\n directory specific to the job. The S3Uri field contains the location of the\n output file, called output.tar.gz. It is a compressed archive that contains the\n confusion matrix.
The input data configuration that you supplied when you created the dominant language\n detection job.
" } }, - "KmsKeyId": { + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "The output data configuration that you supplied when you created the dominant language\n detection job.
" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
" + } + }, + "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the\n output results from an analysis job. The KmsKeyId can be one of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
KMS Key Alias: \"alias/ExampleAlias\"\n
ARN of a KMS Key Alias:\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your dominant language detection job. For more information, see\n Amazon\n VPC.
" } } }, "traits": { - "smithy.api#documentation": "Provides output results configuration parameters for custom classifier jobs.
" + "smithy.api#documentation": "Provides information about a dominant language detection job.
" } }, - "com.amazonaws.comprehend#DocumentClassifierProperties": { + "com.amazonaws.comprehend#DominantLanguageDetectionJobPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#DominantLanguageDetectionJobProperties" + } + }, + "com.amazonaws.comprehend#Double": { + "type": "double" + }, + "com.amazonaws.comprehend#EndpointFilter": { "type": "structure", "members": { - "DocumentClassifierArn": { - "target": "com.amazonaws.comprehend#DocumentClassifierArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the document classifier.
" - } - }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "ModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", "traits": { - "smithy.api#documentation": "The language code for the language of the documents that the classifier was trained\n on.
" + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
" } }, "Status": { - "target": "com.amazonaws.comprehend#ModelStatus", - "traits": { - "smithy.api#documentation": "The status of the document classifier. If the status is TRAINED the\n classifier is ready to use. If the status is FAILED you can see additional\n information about why the classifier wasn't trained in the Message field.
Additional information about the status of the classifier.
" + "smithy.api#documentation": "Specifies the status of the endpoint being returned. Possible values are: Creating, Ready,\n Updating, Deleting, Failed.
" } }, - "SubmitTime": { + "CreationTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "The time that the document classifier was submitted for training.
" + "smithy.api#documentation": "Specifies a date before which the returned endpoint or endpoints were created.
" } }, - "EndTime": { + "CreationTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "The time that training the document classifier completed.
" + "smithy.api#documentation": "Specifies a date after which the returned endpoint or endpoints were created.
" } - }, - "TrainingStartTime": { - "target": "com.amazonaws.comprehend#Timestamp", + } + }, + "traits": { + "smithy.api#documentation": "The filter used to determine which endpoints are returned. You can filter jobs on their\n name, model, status, or the date and time that they were created. You can only set one filter\n at a time.
" + } + }, + "com.amazonaws.comprehend#EndpointProperties": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.comprehend#ComprehendEndpointArn", "traits": { - "smithy.api#documentation": "Indicates the time when the training starts on documentation classifiers. You are billed\n for the time interval between this time and the value of TrainingEndTime.
" + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint.
" } }, - "TrainingEndTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "Status": { + "target": "com.amazonaws.comprehend#EndpointStatus", "traits": { - "smithy.api#documentation": "The time that training of the document classifier was completed. Indicates the time when\n the training completes on documentation classifiers. You are billed for the time interval\n between this time and the value of TrainingStartTime.
" + "smithy.api#documentation": "Specifies the status of the endpoint. Because the endpoint updates and creation are\n asynchronous, so customers will need to wait for the endpoint to be Ready status\n before making inference requests.
The input data configuration that you supplied when you created the document classifier\n for training.
" + "smithy.api#documentation": "Specifies a reason for failure in cases of Failed status.
Provides output results configuration parameters for custom classifier jobs.
" + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
" } }, - "ClassifierMetadata": { - "target": "com.amazonaws.comprehend#ClassifierMetadata", + "DesiredModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", "traits": { - "smithy.api#documentation": "Information about the document classifier, including the number of documents used for\n training the classifier, the number of documents used for test the classifier, and an accuracy\n rating.
" + "smithy.api#documentation": "ARN of the new model to use for updating an existing endpoint. This ARN is going to be\n different from the model ARN when the update is in progress
" } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "DesiredInferenceUnits": { + "target": "com.amazonaws.comprehend#InferenceUnitsInteger", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your input data.
" + "smithy.api#documentation": "The desired number of inference units to be used by the model using this endpoint.\n \n Each inference unit represents of a throughput of 100 characters per second.
" } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "CurrentInferenceUnits": { + "target": "com.amazonaws.comprehend#InferenceUnitsInteger", "traits": { - "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The number of inference units currently used by the model using this endpoint.
" } }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", + "CreationTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your custom classifier. For more information, see Amazon\n VPC.
" + "smithy.api#documentation": "The creation date and time of the endpoint.
" } }, - "Mode": { - "target": "com.amazonaws.comprehend#DocumentClassifierMode", + "LastModifiedTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "Indicates the mode in which the specific classifier was trained. This also indicates the\n format of input documents and the format of the confusion matrix. Each classifier can only be\n trained in one mode and this cannot be changed once the classifier is trained.
" + "smithy.api#documentation": "The date and time that the endpoint was last modified.
" } }, - "ModelKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to trained custom models encrypted with a customer\n managed key (ModelKmsKeyId).
" } }, - "VersionName": { - "target": "com.amazonaws.comprehend#VersionName", + "DesiredDataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "The version name that you assigned to the document classifier.
" + "smithy.api#documentation": "Data access role ARN to use in case the new model is encrypted with a customer KMS\n key.
" } }, - "SourceModelArn": { - "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source model. This model was imported from a\n different AWS account to create the document classifier model in your AWS account.
" + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel
" } } }, "traits": { - "smithy.api#documentation": "Provides information about a document classifier.
" - } - }, - "com.amazonaws.comprehend#DocumentClassifierPropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.comprehend#DocumentClassifierProperties" + "smithy.api#documentation": "Specifies information about the specified endpoint.\n For information about endpoints, see Managing endpoints.
" } }, - "com.amazonaws.comprehend#DocumentClassifierSummariesList": { + "com.amazonaws.comprehend#EndpointPropertiesList": { "type": "list", "member": { - "target": "com.amazonaws.comprehend#DocumentClassifierSummary" + "target": "com.amazonaws.comprehend#EndpointProperties" } }, - "com.amazonaws.comprehend#DocumentClassifierSummary": { - "type": "structure", + "com.amazonaws.comprehend#EndpointStatus": { + "type": "enum", "members": { - "DocumentClassifierName": { - "target": "com.amazonaws.comprehend#ComprehendArnName", + "CREATING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name that you assigned the document classifier.
" + "smithy.api#enumValue": "CREATING" } }, - "NumberOfVersions": { - "target": "com.amazonaws.comprehend#Integer", + "DELETING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The number of versions you created.
" + "smithy.api#enumValue": "DELETING" } }, - "LatestVersionCreatedAt": { - "target": "com.amazonaws.comprehend#Timestamp", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The time that the latest document classifier version was submitted for processing.
" + "smithy.api#enumValue": "FAILED" } }, - "LatestVersionName": { - "target": "com.amazonaws.comprehend#VersionName", + "IN_SERVICE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The version name you assigned to the latest document classifier version.
" + "smithy.api#enumValue": "IN_SERVICE" } }, - "LatestVersionStatus": { - "target": "com.amazonaws.comprehend#ModelStatus", + "UPDATING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Provides the status of the latest document classifier version.
" + "smithy.api#enumValue": "UPDATING" } } - }, - "traits": { - "smithy.api#documentation": "Describes information about a document classifier and its versions.
" } }, - "com.amazonaws.comprehend#DocumentLabel": { + "com.amazonaws.comprehend#EntitiesDetectionJobFilter": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.comprehend#String", + "JobName": { + "target": "com.amazonaws.comprehend#JobName", "traits": { - "smithy.api#documentation": "The name of the label.
" + "smithy.api#documentation": "Filters on the name of the job.
" } }, - "Score": { - "target": "com.amazonaws.comprehend#Float", + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", "traits": { - "smithy.api#documentation": "The confidence score that Amazon Comprehend has this label correctly attributed.
" + "smithy.api#documentation": "Filters the list of jobs based on job status. Returns only jobs with the specified\n status.
" } }, - "Page": { - "target": "com.amazonaws.comprehend#Integer", + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "Page number where the label occurs. This field is present\n in the response only if your request includes the Byte parameter.
Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.
" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.
" } } }, "traits": { - "smithy.api#documentation": "Specifies one of the label or labels that categorize the document being analyzed.
" + "smithy.api#documentation": "Provides information for filtering a list of dominant language detection jobs. For more\n information, see the operation.
" } }, - "com.amazonaws.comprehend#DocumentMetadata": { + "com.amazonaws.comprehend#EntitiesDetectionJobProperties": { "type": "structure", "members": { - "Pages": { - "target": "com.amazonaws.comprehend#Integer", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "Number of pages in the document.
" + "smithy.api#documentation": "The identifier assigned to the entities detection job.
" } }, - "ExtractedCharacters": { - "target": "com.amazonaws.comprehend#ListOfExtractedCharacters", + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", "traits": { - "smithy.api#documentation": "List of pages in the document, with the number of characters extracted from each page.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:
\n\n arn:\n
The following is an example job ARN:
\n\n arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab\n
Information about the document, discovered during text extraction.
" - } - }, - "com.amazonaws.comprehend#DocumentReadAction": { - "type": "enum", - "members": { - "TEXTRACT_DETECT_DOCUMENT_TEXT": { - "target": "smithy.api#Unit", + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", "traits": { - "smithy.api#enumValue": "TEXTRACT_DETECT_DOCUMENT_TEXT" + "smithy.api#documentation": "The name that you assigned the entities detection job.
" } }, - "TEXTRACT_ANALYZE_DOCUMENT": { - "target": "smithy.api#Unit", + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", "traits": { - "smithy.api#enumValue": "TEXTRACT_ANALYZE_DOCUMENT" + "smithy.api#documentation": "The current status of the entities detection job. If the status is FAILED,\n the Message field shows the reason for the failure.
A description of the status of a job.
" } }, - "FORMS": { - "target": "smithy.api#Unit", + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#enumValue": "FORMS" + "smithy.api#documentation": "The time that the entities detection job was submitted for processing.
" } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT \n as the read action, you must specify one or both of the following values:
\n TABLES - Returns additional information about any tables that are detected in the input document.
\n FORMS - Returns additional information about any forms that are detected in the input document.
The time that the entities detection job completed
" } }, - "FORCE_DOCUMENT_READ_ACTION": { - "target": "smithy.api#Unit", + "EntityRecognizerArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", "traits": { - "smithy.api#enumValue": "FORCE_DOCUMENT_READ_ACTION" + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the entity recognizer.
" } - } - } - }, - "com.amazonaws.comprehend#DocumentReaderConfig": { - "type": "structure", - "members": { - "DocumentReadAction": { - "target": "com.amazonaws.comprehend#DocumentReadAction", + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { - "smithy.api#documentation": "This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files.\n Enter one of the following values:
\n\n TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText\n API operation.
\n TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument \n API operation.
The input data configuration that you supplied when you created the entities detection\n job.
" } }, - "DocumentReadMode": { - "target": "com.amazonaws.comprehend#DocumentReadMode", + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { - "smithy.api#documentation": "Determines the text extraction actions for PDF files. Enter one of the following values:
\n\n SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.
\n FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by\n DocumentReadAction for all PDF files, including digital PDF files.
The output data configuration that you supplied when you created the entities detection\n job.
" } }, - "FeatureTypes": { - "target": "com.amazonaws.comprehend#ListOfDocumentReadFeatureTypes", + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT \n as the read action, you must specify one or both of the following values:
\n TABLES - Returns information about any tables that are detected in the input document.
\n FORMS - Returns information and the data from any forms that are detected in the input document.
The language code of the input documents.
" } - } - }, - "traits": { - "smithy.api#documentation": "Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
\nBy default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:
\n\n Word files - Amazon Comprehend parser extracts the text.
\n\n Digital PDF files - Amazon Comprehend parser extracts the text.
\n\n Image files and scanned PDF files - Amazon Comprehend uses the Amazon Textract DetectDocumentText \n API to extract the text.
\n DocumentReaderConfig does not apply to plain text files or Word files.
\n For image files and PDF documents, you can override these default actions using the fields listed below. \n For more information, see \n Setting text extraction options. \n
" - } - }, - "com.amazonaws.comprehend#DocumentType": { - "type": "enum", - "members": { - "NATIVE_PDF": { - "target": "smithy.api#Unit", + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#enumValue": "NATIVE_PDF" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
" } }, - "SCANNED_PDF": { - "target": "smithy.api#Unit", + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#enumValue": "SCANNED_PDF" + "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your entity detection job. For more information, see Amazon\n VPC.
" } - }, - "IMAGE": { - "target": "smithy.api#Unit", + } + }, + "traits": { + "smithy.api#documentation": "Provides information about an entities detection job.
" + } + }, + "com.amazonaws.comprehend#EntitiesDetectionJobPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#EntitiesDetectionJobProperties" + } + }, + "com.amazonaws.comprehend#Entity": { + "type": "structure", + "members": { + "Score": { + "target": "com.amazonaws.comprehend#Float", "traits": { - "smithy.api#enumValue": "IMAGE" + "smithy.api#documentation": "The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.
" } }, - "PLAIN_TEXT": { - "target": "smithy.api#Unit", + "Type": { + "target": "com.amazonaws.comprehend#EntityType", "traits": { - "smithy.api#enumValue": "PLAIN_TEXT" + "smithy.api#documentation": "The entity type. For entity detection using the built-in model, this field contains one of the\n standard entity types listed below.
\nFor custom entity detection, this field contains one of the\n entity types that you specified when you trained your custom model.
" } }, - "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON": { - "target": "smithy.api#Unit", + "Text": { + "target": "com.amazonaws.comprehend#String", "traits": { - "smithy.api#enumValue": "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON" + "smithy.api#documentation": "The text of the entity.
" } }, - "TEXTRACT_ANALYZE_DOCUMENT_JSON": { - "target": "smithy.api#Unit", + "BeginOffset": { + "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#enumValue": "TEXTRACT_ANALYZE_DOCUMENT_JSON" + "smithy.api#documentation": "The zero-based offset from the beginning of the source text to the first character in the\n entity.
\nThis field is empty for non-text input.
" } - } - } - }, - "com.amazonaws.comprehend#DocumentTypeListItem": { - "type": "structure", - "members": { - "Page": { + }, + "EndOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "Page number.
" + "smithy.api#documentation": "The zero-based offset from the beginning of the source text to the last character in the\n entity.
\nThis field is empty for non-text input.
" } }, - "Type": { - "target": "com.amazonaws.comprehend#DocumentType", + "BlockReferences": { + "target": "com.amazonaws.comprehend#ListOfBlockReferences", "traits": { - "smithy.api#documentation": "Document type.
" + "smithy.api#documentation": "A reference to each block for this entity. This field is empty for plain-text input.
" } } }, "traits": { - "smithy.api#documentation": "Document type for each page in the document.
" + "smithy.api#documentation": "Provides information about an entity.
\n" } }, - "com.amazonaws.comprehend#DominantLanguage": { + "com.amazonaws.comprehend#EntityLabel": { "type": "structure", "members": { - "LanguageCode": { - "target": "com.amazonaws.comprehend#String", + "Name": { + "target": "com.amazonaws.comprehend#PiiEntityType", "traits": { - "smithy.api#documentation": "
The RFC 5646 language code for the dominant language. For more information about RFC\n 5646, see Tags for Identifying\n Languages on the IETF Tools web site.
" + "smithy.api#documentation": "The name of the label.
" } }, "Score": { @@ -5283,382 +6135,379 @@ } }, "traits": { - "smithy.api#documentation": "Returns the code for the dominant language in the input text and the level of\n confidence that Amazon Comprehend has in the accuracy of the detection.
" + "smithy.api#documentation": "Specifies one of the label or labels that categorize the personally identifiable\n information (PII) entity being analyzed.
" } }, - "com.amazonaws.comprehend#DominantLanguageDetectionJobFilter": { + "com.amazonaws.comprehend#EntityRecognitionConfig": { "type": "structure", "members": { - "JobName": { - "target": "com.amazonaws.comprehend#JobName", - "traits": { - "smithy.api#documentation": "Filters on the name of the job.
" - } - }, - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", - "traits": { - "smithy.api#documentation": "Filters the list of jobs based on job status. Returns only jobs with the specified\n status.
" - } - }, - "SubmitTimeBefore": { - "target": "com.amazonaws.comprehend#Timestamp", - "traits": { - "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.
" - } - }, - "SubmitTimeAfter": { - "target": "com.amazonaws.comprehend#Timestamp", + "EntityTypes": { + "target": "com.amazonaws.comprehend#EntityTypesList", "traits": { - "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.
" + "smithy.api#documentation": "Up to 25 entity types that the model is trained to recognize.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Provides information for filtering a list of dominant language detection jobs. For more\n information, see the \n operation.
" + "smithy.api#documentation": "Configuration required for an entity recognition model.
" } }, - "com.amazonaws.comprehend#DominantLanguageDetectionJobProperties": { + "com.amazonaws.comprehend#EntityRecognizerAnnotations": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.comprehend#JobId", - "traits": { - "smithy.api#documentation": "The identifier assigned to the dominant language detection job.
" - } - }, - "JobArn": { - "target": "com.amazonaws.comprehend#ComprehendArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique,\n fully qualified identifier for the job. It includes the AWS account, Region, and the job ID.\n The format of the ARN is as follows:
\n\n arn:\n
The following is an example job ARN:
\n\n arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab\n
The name that you assigned to the dominant language detection job.
" - } - }, - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", - "traits": { - "smithy.api#documentation": "The current status of the dominant language detection job. If the status is\n FAILED, the Message field shows the reason for the failure.
A description for the status of a job.
" - } - }, - "SubmitTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "The time that the dominant language detection job was submitted for processing.
" + "smithy.api#documentation": "Specifies the Amazon S3 location where the annotations for an entity recognizer are\n located. The URI must be in the same region as the API endpoint that you are calling.
", + "smithy.api#required": {} } }, - "EndTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "TestS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "The time that the dominant language detection job completed.
" + "smithy.api#documentation": "Specifies the Amazon S3 location where the test annotations for an entity recognizer are\n located. The URI must be in the same region as the API endpoint that you are calling.
" } + } + }, + "traits": { + "smithy.api#documentation": "Describes the annotations associated with a entity recognizer.
" + } + }, + "com.amazonaws.comprehend#EntityRecognizerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 }, - "InputDataConfig": { - "target": "com.amazonaws.comprehend#InputDataConfig", + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?$" + } + }, + "com.amazonaws.comprehend#EntityRecognizerAugmentedManifestsList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#AugmentedManifestsListItem" + } + }, + "com.amazonaws.comprehend#EntityRecognizerDataFormat": { + "type": "enum", + "members": { + "COMPREHEND_CSV": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The input data configuration that you supplied when you created the dominant language\n detection job.
" + "smithy.api#enumValue": "COMPREHEND_CSV" } }, - "OutputDataConfig": { - "target": "com.amazonaws.comprehend#OutputDataConfig", + "AUGMENTED_MANIFEST": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The output data configuration that you supplied when you created the dominant language\n detection job.
" + "smithy.api#enumValue": "AUGMENTED_MANIFEST" } - }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + } + } + }, + "com.amazonaws.comprehend#EntityRecognizerDocuments": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.
" + "smithy.api#documentation": "Specifies the Amazon S3 location where the training documents for an entity recognizer\n are located. The URI must be in the same region as the API endpoint that you are\n calling.
", + "smithy.api#required": {} } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "TestS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Specifies the Amazon S3 location where the test documents for an entity recognizer are\n located. The URI must be in the same AWS Region as the API endpoint that you are\n calling.
" } }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", + "InputFormat": { + "target": "com.amazonaws.comprehend#InputFormat", "traits": { - "smithy.api#documentation": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your dominant language detection job. For more information, see\n Amazon\n VPC.
" + "smithy.api#documentation": "Specifies how the text in an input file should be processed. This is optional, and the\n default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document.\n Use this option when you are processing large documents, such as newspaper articles or\n scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document.\n Use this option when you are processing many short documents, such as text messages.
" } } }, "traits": { - "smithy.api#documentation": "Provides information about a dominant language detection job.
" + "smithy.api#documentation": "Describes the training documents submitted with an entity recognizer.
" } }, - "com.amazonaws.comprehend#DominantLanguageDetectionJobPropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.comprehend#DominantLanguageDetectionJobProperties" + "com.amazonaws.comprehend#EntityRecognizerEndpointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*$" } }, - "com.amazonaws.comprehend#Double": { - "type": "double" - }, - "com.amazonaws.comprehend#EndpointFilter": { + "com.amazonaws.comprehend#EntityRecognizerEntityList": { "type": "structure", "members": { - "ModelArn": { - "target": "com.amazonaws.comprehend#ComprehendModelArn", + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
" + "smithy.api#documentation": "Specifies the Amazon S3 location where the entity list is located. The URI must be in the\n same region as the API endpoint that you are calling.
", + "smithy.api#required": {} } - }, - "Status": { - "target": "com.amazonaws.comprehend#EndpointStatus", + } + }, + "traits": { + "smithy.api#documentation": "Describes the entity list submitted with an entity recognizer.
" + } + }, + "com.amazonaws.comprehend#EntityRecognizerEvaluationMetrics": { + "type": "structure", + "members": { + "Precision": { + "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "Specifies the status of the endpoint being returned. Possible values are: Creating, Ready,\n Updating, Deleting, Failed.
" + "smithy.api#documentation": "A measure of the usefulness of the recognizer results in the test data. High precision\n means that the recognizer returned substantially more relevant results than irrelevant ones.\n
" } }, - "CreationTimeBefore": { - "target": "com.amazonaws.comprehend#Timestamp", + "Recall": { + "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "Specifies a date before which the returned endpoint or endpoints were created.
" + "smithy.api#documentation": "A measure of how complete the recognizer results are for the test data. High recall means\n that the recognizer returned most of the relevant results.
" } }, - "CreationTimeAfter": { - "target": "com.amazonaws.comprehend#Timestamp", + "F1Score": { + "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "Specifies a date after which the returned endpoint or endpoints were created.
" + "smithy.api#documentation": "A measure of how accurate the recognizer results are for the test data. It is derived from\n the Precision and Recall values. The F1Score is the\n harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100,\n where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1,\n where 1 is the best score.\n
The filter used to determine which endpoints are returned. You can filter jobs on their\n name, model, status, or the date and time that they were created. You can only set one filter\n at a time.
" + "smithy.api#documentation": "Detailed information about the accuracy of an entity recognizer.
" } }, - "com.amazonaws.comprehend#EndpointProperties": { + "com.amazonaws.comprehend#EntityRecognizerFilter": { "type": "structure", "members": { - "EndpointArn": { - "target": "com.amazonaws.comprehend#ComprehendEndpointArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint.
" - } - }, "Status": { - "target": "com.amazonaws.comprehend#EndpointStatus", + "target": "com.amazonaws.comprehend#ModelStatus", "traits": { - "smithy.api#documentation": "Specifies the status of the endpoint. Because the endpoint updates and creation are\n asynchronous, so customers will need to wait for the endpoint to be Ready status\n before making inference requests.
The status of an entity recognizer.
" } }, - "Message": { - "target": "com.amazonaws.comprehend#AnyLengthString", + "RecognizerName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", "traits": { - "smithy.api#documentation": "Specifies a reason for failure in cases of Failed status.
The name that you assigned the entity recognizer.
" } }, - "ModelArn": { - "target": "com.amazonaws.comprehend#ComprehendModelArn", + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
" + "smithy.api#documentation": "Filters the list of entities based on the time that the list was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in descending order,\n newest to oldest.
" } }, - "DesiredModelArn": { - "target": "com.amazonaws.comprehend#ComprehendModelArn", + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "ARN of the new model to use for updating an existing endpoint. This ARN is going to be\n different from the model ARN when the update is in progress
" + "smithy.api#documentation": "Filters the list of entities based on the time that the list was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in ascending order,\n oldest to newest.
" } - }, - "DesiredInferenceUnits": { - "target": "com.amazonaws.comprehend#InferenceUnitsInteger", + } + }, + "traits": { + "smithy.api#documentation": "Provides information for filtering a list of entity recognizers. You can only specify one\n filtering parameter in a request. For more information, see the \n ListEntityRecognizers operation./>
The desired number of inference units to be used by the model using this endpoint.\n \n Each inference unit represents of a throughput of 100 characters per second.
" + "smithy.api#documentation": "The format of your training data:
\n\n COMPREHEND_CSV: A CSV file that supplements your training documents. The\n CSV file contains information about the custom entities that your trained model will\n detect. The required format of the file depends on whether you are providing annotations\n or an entity list.
If you use this value, you must provide your CSV file by using either the\n Annotations or EntityList parameters. You must provide your\n training documents by using the Documents parameter.
\n AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon\n SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON\n object that contains a training document and its labels. Each label annotates a named\n entity in the training document.
If you use this value, you must provide the AugmentedManifests parameter\n in your request.
If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the\n default.
The number of inference units currently used by the model using this endpoint.
" + "smithy.api#documentation": "The entity types in the labeled training data that Amazon Comprehend uses to train the\n custom entity recognizer. Any entity types that you don't specify are ignored.
\nA maximum of 25 entity types can be used at one time to train an entity recognizer. Entity\n types must not contain the following invalid characters: \\n (line break), \\\\n (escaped line\n break), \\r (carriage return), \\\\r (escaped carriage return), \\t (tab), \\\\t (escaped tab),\n space, and , (comma).
", + "smithy.api#required": {} } - }, - "CreationTime": { - "target": "com.amazonaws.comprehend#Timestamp", + }, + "Documents": { + "target": "com.amazonaws.comprehend#EntityRecognizerDocuments", "traits": { - "smithy.api#documentation": "The creation date and time of the endpoint.
" + "smithy.api#documentation": "The S3 location of the folder that contains the training documents for your custom entity\n recognizer.
\nThis parameter is required if you set DataFormat to\n COMPREHEND_CSV.
The date and time that the endpoint was last modified.
" + "smithy.api#documentation": "The S3 location of the CSV file that annotates your training documents.
" } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "EntityList": { + "target": "com.amazonaws.comprehend#EntityRecognizerEntityList", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to trained custom models encrypted with a customer\n managed key (ModelKmsKeyId).
" + "smithy.api#documentation": "The S3 location of the CSV file that has the entity list for your custom entity\n recognizer.
" } }, - "DesiredDataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "AugmentedManifests": { + "target": "com.amazonaws.comprehend#EntityRecognizerAugmentedManifestsList", "traits": { - "smithy.api#documentation": "Data access role ARN to use in case the new model is encrypted with a customer KMS\n key.
" + "smithy.api#documentation": "A list of augmented manifest files that provide training data for your custom model. An\n augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground\n Truth.
\nThis parameter is required if you set DataFormat to\n AUGMENTED_MANIFEST.
Specifies information about the specified endpoint.\n For information about endpoints, see Managing endpoints.
" - } - }, - "com.amazonaws.comprehend#EndpointPropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.comprehend#EndpointProperties" + "smithy.api#documentation": "Specifies the format and location of the input data.
" } }, - "com.amazonaws.comprehend#EndpointStatus": { - "type": "enum", + "com.amazonaws.comprehend#EntityRecognizerMetadata": { + "type": "structure", "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", + "NumberOfTrainedDocuments": { + "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#enumValue": "DELETING" + "smithy.api#documentation": "The number of documents in the input data that were used to train the entity recognizer.\n Typically this is 80 to 90 percent of the input documents.
" } }, - "FAILED": { - "target": "smithy.api#Unit", + "NumberOfTestDocuments": { + "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#enumValue": "FAILED" + "smithy.api#documentation": "The number of documents in the input data that were used to test the entity recognizer.\n Typically this is 10 to 20 percent of the input documents.
" } }, - "IN_SERVICE": { - "target": "smithy.api#Unit", + "EvaluationMetrics": { + "target": "com.amazonaws.comprehend#EntityRecognizerEvaluationMetrics", "traits": { - "smithy.api#enumValue": "IN_SERVICE" + "smithy.api#documentation": "Detailed information about the accuracy of an entity recognizer.
" } }, - "UPDATING": { - "target": "smithy.api#Unit", + "EntityTypes": { + "target": "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesList", "traits": { - "smithy.api#enumValue": "UPDATING" + "smithy.api#documentation": "Entity types from the metadata of an entity recognizer.
" } } + }, + "traits": { + "smithy.api#documentation": "Detailed information about an entity recognizer.
", + "smithy.api#sensitive": {} } }, - "com.amazonaws.comprehend#EntitiesDetectionJobFilter": { + "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesListItem" + } + }, + "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesListItem": { "type": "structure", "members": { - "JobName": { - "target": "com.amazonaws.comprehend#JobName", - "traits": { - "smithy.api#documentation": "Filters on the name of the job.
" - } - }, - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", + "Type": { + "target": "com.amazonaws.comprehend#AnyLengthString", "traits": { - "smithy.api#documentation": "Filters the list of jobs based on job status. Returns only jobs with the specified\n status.
" + "smithy.api#documentation": "Type of entity from the list of entity types in the metadata of an entity recognizer.\n
" } }, - "SubmitTimeBefore": { - "target": "com.amazonaws.comprehend#Timestamp", + "EvaluationMetrics": { + "target": "com.amazonaws.comprehend#EntityTypesEvaluationMetrics", "traits": { - "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.
" + "smithy.api#documentation": "Detailed information about the accuracy of the entity recognizer for a specific item on\n the list of entity types.
" } }, - "SubmitTimeAfter": { - "target": "com.amazonaws.comprehend#Timestamp", + "NumberOfTrainMentions": { + "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.
" + "smithy.api#documentation": "Indicates the number of times the given entity type was seen in the training data.
" } } }, "traits": { - "smithy.api#documentation": "Provides information for filtering a list of dominant language detection jobs. For more\n information, see the operation.
" + "smithy.api#documentation": "Individual item from the list of entity types in the metadata of an entity\n recognizer.
" } }, - "com.amazonaws.comprehend#EntitiesDetectionJobProperties": { + "com.amazonaws.comprehend#EntityRecognizerOutputDataConfig": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.comprehend#JobId", + "FlywheelStatsS3Prefix": { + "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "The identifier assigned to the entities detection job.
" + "smithy.api#documentation": "The Amazon S3 prefix for the data lake location of the flywheel statistics.
" } - }, - "JobArn": { - "target": "com.amazonaws.comprehend#ComprehendArn", + } + }, + "traits": { + "smithy.api#documentation": "Output data configuration.
" + } + }, + "com.amazonaws.comprehend#EntityRecognizerProperties": { + "type": "structure", + "members": { + "EntityRecognizerArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:
\n\n arn:\n
The following is an example job ARN:
\n\n arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab\n
The Amazon Resource Name (ARN) that identifies the entity recognizer.
" } }, - "JobName": { - "target": "com.amazonaws.comprehend#JobName", + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "The name that you assigned the entities detection job.
" + "smithy.api#documentation": "The language of the input documents. All documents must be in the same language. Only\n English (\"en\") is currently supported.
" } }, - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", + "Status": { + "target": "com.amazonaws.comprehend#ModelStatus", "traits": { - "smithy.api#documentation": "The current status of the entities detection job. If the status is FAILED,\n the Message field shows the reason for the failure.
Provides the status of the entity recognizer.
" } }, "Message": { "target": "com.amazonaws.comprehend#AnyLengthString", "traits": { - "smithy.api#documentation": "A description of the status of a job.
" + "smithy.api#documentation": "A description of the status of the recognizer.
" } }, "SubmitTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "The time that the entities detection job was submitted for processing.
" + "smithy.api#documentation": "The time that the recognizer was submitted for processing.
" } }, "EndTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "The time that the entities detection job completed
" + "smithy.api#documentation": "The time that the recognizer creation completed.
" } }, - "EntityRecognizerArn": { - "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "TrainingStartTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the entity recognizer.
" + "smithy.api#documentation": "The time that training of the entity recognizer started.
" } }, - "InputDataConfig": { - "target": "com.amazonaws.comprehend#InputDataConfig", + "TrainingEndTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "The input data configuration that you supplied when you created the entities detection\n job.
" + "smithy.api#documentation": "The time that training of the entity recognizer was completed.
" } }, - "OutputDataConfig": { - "target": "com.amazonaws.comprehend#OutputDataConfig", + "InputDataConfig": { + "target": "com.amazonaws.comprehend#EntityRecognizerInputDataConfig", "traits": { - "smithy.api#documentation": "The output data configuration that you supplied when you created the entities detection\n job.
" + "smithy.api#documentation": "The input data properties of an entity recognizer.
" } }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "RecognizerMetadata": { + "target": "com.amazonaws.comprehend#EntityRecognizerMetadata", "traits": { - "smithy.api#documentation": "The language code of the input documents.
" + "smithy.api#documentation": "Provides information about an entity recognizer.
" } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
" } }, "VolumeKmsKeyId": { @@ -5670,804 +6519,785 @@ "VpcConfig": { "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your entity detection job. For more information, see Amazon\n VPC.
" + "smithy.api#documentation": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your custom entity recognizer. For more information, see Amazon\n VPC.
" + } + }, + "ModelKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The version name you assigned to the entity recognizer.
" + } + }, + "SourceModelArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source model. This model was imported from a\n different AWS account to create the entity recognizer model in your AWS account.
" + } + }, + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel
" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#EntityRecognizerOutputDataConfig", + "traits": { + "smithy.api#documentation": "Output data configuration.
" } } }, "traits": { - "smithy.api#documentation": "Provides information about an entities detection job.
" + "smithy.api#documentation": "Describes information about an entity recognizer.
" } }, - "com.amazonaws.comprehend#EntitiesDetectionJobPropertiesList": { + "com.amazonaws.comprehend#EntityRecognizerPropertiesList": { "type": "list", "member": { - "target": "com.amazonaws.comprehend#EntitiesDetectionJobProperties" + "target": "com.amazonaws.comprehend#EntityRecognizerProperties" } }, - "com.amazonaws.comprehend#Entity": { + "com.amazonaws.comprehend#EntityRecognizerSummariesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#EntityRecognizerSummary" + } + }, + "com.amazonaws.comprehend#EntityRecognizerSummary": { "type": "structure", "members": { - "Score": { - "target": "com.amazonaws.comprehend#Float", + "RecognizerName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", "traits": { - "smithy.api#documentation": "The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.
" + "smithy.api#documentation": "The name that you assigned the entity recognizer.
" } }, - "Type": { - "target": "com.amazonaws.comprehend#EntityType", + "NumberOfVersions": { + "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "The entity type. For entity detection using the built-in model, this field contains one of the \n standard entity types listed below.
\nFor custom entity detection, this field contains one of the \n entity types that you specified when you trained your custom model.
" + "smithy.api#documentation": "The number of versions you created.
" } }, - "Text": { - "target": "com.amazonaws.comprehend#String", + "LatestVersionCreatedAt": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "The text of the entity.
" + "smithy.api#documentation": "The time that the latest entity recognizer version was submitted for processing.
" } }, - "BeginOffset": { - "target": "com.amazonaws.comprehend#Integer", + "LatestVersionName": { + "target": "com.amazonaws.comprehend#VersionName", + "traits": { + "smithy.api#documentation": "The version name you assigned to the latest entity recognizer version.
" + } + }, + "LatestVersionStatus": { + "target": "com.amazonaws.comprehend#ModelStatus", + "traits": { + "smithy.api#documentation": "Provides the status of the latest entity recognizer version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the information about an entity recognizer and its versions.
" + } + }, + "com.amazonaws.comprehend#EntityType": { + "type": "enum", + "members": { + "PERSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERSON" + } + }, + "LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOCATION" + } + }, + "ORGANIZATION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The zero-based offset from the beginning of the source text to the first character in the\n entity.
\nThis field is empty for non-text input.
" + "smithy.api#enumValue": "ORGANIZATION" } }, - "EndOffset": { - "target": "com.amazonaws.comprehend#Integer", + "COMMERCIAL_ITEM": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The zero-based offset from the beginning of the source text to the last character in the\n entity.
\nThis field is empty for non-text input.
" + "smithy.api#enumValue": "COMMERCIAL_ITEM" } }, - "BlockReferences": { - "target": "com.amazonaws.comprehend#ListOfBlockReferences", + "EVENT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A reference to each block for this entity. This field is empty for plain-text input.
" + "smithy.api#enumValue": "EVENT" } - } - }, - "traits": { - "smithy.api#documentation": "Provides information about an entity.
\n" - } - }, - "com.amazonaws.comprehend#EntityLabel": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.comprehend#PiiEntityType", + }, + "DATE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "
The name of the label.
" + "smithy.api#enumValue": "DATE" } }, - "Score": { - "target": "com.amazonaws.comprehend#Float", + "QUANTITY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.
" + "smithy.api#enumValue": "QUANTITY" } - } - }, - "traits": { - "smithy.api#documentation": "Specifies one of the label or labels that categorize the personally identifiable\n information (PII) entity being analyzed.
" - } - }, - "com.amazonaws.comprehend#EntityRecognizerAnnotations": { - "type": "structure", - "members": { - "S3Uri": { - "target": "com.amazonaws.comprehend#S3Uri", + }, + "TITLE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Specifies the Amazon S3 location where the annotations for an entity recognizer are\n located. The URI must be in the same region as the API endpoint that you are calling.
", - "smithy.api#required": {} + "smithy.api#enumValue": "TITLE" } }, - "TestS3Uri": { - "target": "com.amazonaws.comprehend#S3Uri", + "OTHER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Specifies the Amazon S3 location where the test annotations for an entity recognizer are\n located. The URI must be in the same region as the API endpoint that you are calling.
" + "smithy.api#enumValue": "OTHER" } } - }, - "traits": { - "smithy.api#documentation": "Describes the annotations associated with a entity recognizer.
" } }, - "com.amazonaws.comprehend#EntityRecognizerArn": { + "com.amazonaws.comprehend#EntityTypeName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?$" - } - }, - "com.amazonaws.comprehend#EntityRecognizerAugmentedManifestsList": { - "type": "list", - "member": { - "target": "com.amazonaws.comprehend#AugmentedManifestsListItem" - } - }, - "com.amazonaws.comprehend#EntityRecognizerDataFormat": { - "type": "enum", - "members": { - "COMPREHEND_CSV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPREHEND_CSV" - } + "max": 64 }, - "AUGMENTED_MANIFEST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUGMENTED_MANIFEST" - } - } + "smithy.api#pattern": "^(?![^\\n\\r\\t,]*\\\\n|\\\\r|\\\\t)[^\\n\\r\\t,]+$" } }, - "com.amazonaws.comprehend#EntityRecognizerDocuments": { + "com.amazonaws.comprehend#EntityTypesEvaluationMetrics": { "type": "structure", "members": { - "S3Uri": { - "target": "com.amazonaws.comprehend#S3Uri", + "Precision": { + "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "Specifies the Amazon S3 location where the training documents for an entity recognizer\n are located. The URI must be in the same region as the API endpoint that you are\n calling.
", - "smithy.api#required": {} + "smithy.api#documentation": "A measure of the usefulness of the recognizer results for a specific entity type in the\n test data. High precision means that the recognizer returned substantially more relevant\n results than irrelevant ones.
" } }, - "TestS3Uri": { - "target": "com.amazonaws.comprehend#S3Uri", + "Recall": { + "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "Specifies the Amazon S3 location where the test documents for an entity recognizer are\n located. The URI must be in the same AWS Region as the API endpoint that you are\n calling.
" + "smithy.api#documentation": "A measure of how complete the recognizer results are for a specific entity type in the\n test data. High recall means that the recognizer returned most of the relevant results.
" } }, - "InputFormat": { - "target": "com.amazonaws.comprehend#InputFormat", + "F1Score": { + "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "Specifies how the text in an input file should be processed. This is optional, and the\n default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document.\n Use this option when you are processing large documents, such as newspaper articles or\n scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document.\n Use this option when you are processing many short documents, such as text messages.
" + "smithy.api#documentation": "A measure of how accurate the recognizer results are for a specific entity type in the\n test data. It is derived from the Precision and Recall values. The\n F1Score is the harmonic average of the two scores. The highest score is 1, and\n the worst score is 0.
Describes the training documents submitted with an entity recognizer.
" + "smithy.api#documentation": "Detailed information about the accuracy of an entity recognizer for a specific entity\n type.
" } }, - "com.amazonaws.comprehend#EntityRecognizerEndpointArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + "com.amazonaws.comprehend#EntityTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#EntityTypesListItem" } }, - "com.amazonaws.comprehend#EntityRecognizerEntityList": { + "com.amazonaws.comprehend#EntityTypesListItem": { "type": "structure", "members": { - "S3Uri": { - "target": "com.amazonaws.comprehend#S3Uri", + "Type": { + "target": "com.amazonaws.comprehend#EntityTypeName", "traits": { - "smithy.api#documentation": "Specifies the Amazon S3 location where the entity list is located. The URI must be in the\n same region as the API endpoint that you are calling.
", + "smithy.api#documentation": "An entity type within a labeled training dataset that Amazon Comprehend uses to train a\n custom entity recognizer.
\nEntity types must not contain the following invalid characters: \\n (line break), \\\\n\n (escaped line break, \\r (carriage return), \\\\r (escaped carriage return), \\t (tab), \\\\t\n (escaped tab), space, and , (comma).
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Describes the entity recognizer submitted with an entity recognizer.
" + "smithy.api#documentation": "An entity type within a labeled training dataset that Amazon Comprehend uses to train a\n custom entity recognizer.
" } }, - "com.amazonaws.comprehend#EntityRecognizerEvaluationMetrics": { + "com.amazonaws.comprehend#ErrorsListItem": { "type": "structure", "members": { - "Precision": { - "target": "com.amazonaws.comprehend#Double", + "Page": { + "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "A measure of the usefulness of the recognizer results in the test data. High precision\n means that the recognizer returned substantially more relevant results than irrelevant ones.\n
" + "smithy.api#documentation": "Page number where the error occurred.
" } }, - "Recall": { - "target": "com.amazonaws.comprehend#Double", + "ErrorCode": { + "target": "com.amazonaws.comprehend#PageBasedErrorCode", "traits": { - "smithy.api#documentation": "A measure of how complete the recognizer results are for the test data. High recall means\n that the recognizer returned most of the relevant results.
" + "smithy.api#documentation": "Error code for the cause of the error.
" } }, - "F1Score": { - "target": "com.amazonaws.comprehend#Double", + "ErrorMessage": { + "target": "com.amazonaws.comprehend#String", "traits": { - "smithy.api#documentation": "A measure of how accurate the recognizer results are for the test data. It is derived from\n the Precision and Recall values. The F1Score is the\n harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100,\n where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1,\n where 1 is the best score.\n
Text message explaining the reason for the error.
" } } }, "traits": { - "smithy.api#documentation": "Detailed information about the accuracy of an entity recognizer.
" + "smithy.api#documentation": "Text extraction encountered one or more page-level errors in the input document.
\nThe ErrorCode contains one of the following values:
TEXTRACT_BAD_PAGE - Amazon Textract cannot read the page. For more information\n about page limits in Amazon Textract, see \n Page Quotas in Amazon Textract.
\nTEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED - The number of requests exceeded your throughput limit.\n For more information about throughput quotas in Amazon Textract, see \n Default quotas in Amazon Textract.
\nPAGE_CHARACTERS_EXCEEDED - Too many text characters on the page (10,000 characters maximum).
\nPAGE_SIZE_EXCEEDED - The maximum page size is 10 MB.
\nINTERNAL_SERVER_ERROR - The request encountered a service issue. Try the API request again.
\nThe status of an entity recognizer.
" + "smithy.api#documentation": "Filters on the name of the events detection job.
" } }, - "RecognizerName": { - "target": "com.amazonaws.comprehend#ComprehendArnName", + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", "traits": { - "smithy.api#documentation": "The name that you assigned the entity recognizer.
" + "smithy.api#documentation": "Filters the list of jobs based on job status. Returns only jobs with the specified\n status.
" } }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "Filters the list of entities based on the time that the list was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in descending order,\n newest to oldest.
" + "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.
" } }, "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "Filters the list of entities based on the time that the list was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in ascending order,\n oldest to newest.
" + "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.
" } } }, "traits": { - "smithy.api#documentation": "Provides information for filtering a list of entity recognizers. You can only specify one\n filtering parameter in a request. For more information, see the operation./>
" + "smithy.api#documentation": "Provides information for filtering a list of event detection jobs.
" } }, - "com.amazonaws.comprehend#EntityRecognizerInputDataConfig": { + "com.amazonaws.comprehend#EventsDetectionJobProperties": { "type": "structure", "members": { - "DataFormat": { - "target": "com.amazonaws.comprehend#EntityRecognizerDataFormat", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "The format of your training data:
\n\n COMPREHEND_CSV: A CSV file that supplements your training documents. The\n CSV file contains information about the custom entities that your trained model will\n detect. The required format of the file depends on whether you are providing annotations\n or an entity list.
If you use this value, you must provide your CSV file by using either the\n Annotations or EntityList parameters. You must provide your\n training documents by using the Documents parameter.
\n AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon\n SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON\n object that contains a training document and its labels. Each label annotates a named\n entity in the training document.
If you use this value, you must provide the AugmentedManifests parameter\n in your request.
If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the\n default.
The identifier assigned to the events detection job.
" } }, - "EntityTypes": { - "target": "com.amazonaws.comprehend#EntityTypesList", + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", "traits": { - "smithy.api#documentation": "The entity types in the labeled training data that Amazon Comprehend uses to train the\n custom entity recognizer. Any entity types that you don't specify are ignored.
\nA maximum of 25 entity types can be used at one time to train an entity recognizer. Entity\n types must not contain the following invalid characters: \\n (line break), \\\\n (escaped line\n break), \\r (carriage return), \\\\r (escaped carriage return), \\t (tab), \\\\t (escaped tab),\n space, and , (comma).
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:
\n\n arn:\n
The following is an example job ARN:
\n\n arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab\n
The S3 location of the folder that contains the training documents for your custom entity\n recognizer.
\nThis parameter is required if you set DataFormat to\n COMPREHEND_CSV.
The name you assigned the events detection job.
" } }, - "Annotations": { - "target": "com.amazonaws.comprehend#EntityRecognizerAnnotations", + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", "traits": { - "smithy.api#documentation": "The S3 location of the CSV file that annotates your training documents.
" + "smithy.api#documentation": "The current status of the events detection job.
" } }, - "EntityList": { - "target": "com.amazonaws.comprehend#EntityRecognizerEntityList", + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", "traits": { - "smithy.api#documentation": "The S3 location of the CSV file that has the entity list for your custom entity\n recognizer.
" + "smithy.api#documentation": "A description of the status of the events detection job.
" } }, - "AugmentedManifests": { - "target": "com.amazonaws.comprehend#EntityRecognizerAugmentedManifestsList", + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "A list of augmented manifest files that provide training data for your custom model. An\n augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground\n Truth.
\nThis parameter is required if you set DataFormat to\n AUGMENTED_MANIFEST.
The time that the events detection job was submitted for processing.
" } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the format and location of the input data.
" - } - }, - "com.amazonaws.comprehend#EntityRecognizerMetadata": { - "type": "structure", - "members": { - "NumberOfTrainedDocuments": { - "target": "com.amazonaws.comprehend#Integer", + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "The number of documents in the input data that were used to train the entity recognizer.\n Typically this is 80 to 90 percent of the input documents.
" + "smithy.api#documentation": "The time that the events detection job completed.
" } }, - "NumberOfTestDocuments": { - "target": "com.amazonaws.comprehend#Integer", + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "The input data configuration that you supplied when you created the events detection\n job.
" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "The output data configuration that you supplied when you created the events detection\n job.
" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "The number of documents in the input data that were used to test the entity recognizer.\n Typically this is 10 to 20 percent of the input documents.
" + "smithy.api#documentation": "The language code of the input documents.
" } }, - "EvaluationMetrics": { - "target": "com.amazonaws.comprehend#EntityRecognizerEvaluationMetrics", + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "Detailed information about the accuracy of an entity recognizer.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
" } }, - "EntityTypes": { - "target": "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesList", + "TargetEventTypes": { + "target": "com.amazonaws.comprehend#TargetEventTypes", "traits": { - "smithy.api#documentation": "Entity types from the metadata of an entity recognizer.
" + "smithy.api#documentation": "The types of events that are detected by the job.
" } } }, "traits": { - "smithy.api#documentation": "Detailed information about an entity recognizer.
", - "smithy.api#sensitive": {} + "smithy.api#documentation": "Provides information about an events detection job.
" } }, - "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesList": { + "com.amazonaws.comprehend#EventsDetectionJobPropertiesList": { "type": "list", "member": { - "target": "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesListItem" + "target": "com.amazonaws.comprehend#EventsDetectionJobProperties" } }, - "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesListItem": { + "com.amazonaws.comprehend#ExtractedCharactersListItem": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.comprehend#AnyLengthString", - "traits": { - "smithy.api#documentation": "Type of entity from the list of entity types in the metadata of an entity recognizer.\n
" - } - }, - "EvaluationMetrics": { - "target": "com.amazonaws.comprehend#EntityTypesEvaluationMetrics", + "Page": { + "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "Detailed information about the accuracy of the entity recognizer for a specific item on\n the list of entity types.
" + "smithy.api#documentation": "Page number.
" } }, - "NumberOfTrainMentions": { + "Count": { "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "Indicates the number of times the given entity type was seen in the training data.
" + "smithy.api#documentation": "Number of characters extracted from each page.
" } } }, "traits": { - "smithy.api#documentation": "Individual item from the list of entity types in the metadata of an entity\n recognizer.
" + "smithy.api#documentation": "Array of the number of characters extracted from each page.
" } }, - "com.amazonaws.comprehend#EntityRecognizerProperties": { + "com.amazonaws.comprehend#Float": { + "type": "float" + }, + "com.amazonaws.comprehend#FlywheelFilter": { "type": "structure", "members": { - "EntityRecognizerArn": { - "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "Status": { + "target": "com.amazonaws.comprehend#FlywheelStatus", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the entity recognizer.
" + "smithy.api#documentation": "Filter the flywheels based on the flywheel status.
" } }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "CreationTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "The language of the input documents. All documents must be in the same language. Only\n English (\"en\") is currently supported.
" + "smithy.api#documentation": "Filter the flywheels to include flywheels created after the specified time.
" } }, - "Status": { - "target": "com.amazonaws.comprehend#ModelStatus", + "CreationTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "Provides the status of the entity recognizer.
" + "smithy.api#documentation": "Filter the flywheels to include flywheels created before the specified time.
" } - }, - "Message": { - "target": "com.amazonaws.comprehend#AnyLengthString", + } + }, + "traits": { + "smithy.api#documentation": "Filter the flywheels based on creation time or flywheel status.
" + } + }, + "com.amazonaws.comprehend#FlywheelIterationFilter": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "A description of the status of the recognizer.
" + "smithy.api#documentation": "Filter the flywheel iterations to include iterations created after the specified time.
" } }, - "SubmitTime": { + "CreationTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "The time that the recognizer was submitted for processing.
" + "smithy.api#documentation": "Filter the flywheel iterations to include iterations created before the specified time.
" } + } + }, + "traits": { + "smithy.api#documentation": "Filter the flywheel iterations based on creation time.
" + } + }, + "com.amazonaws.comprehend#FlywheelIterationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 }, - "EndTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "smithy.api#pattern": "^[0-9]{8}T[0-9]{6}Z$" + } + }, + "com.amazonaws.comprehend#FlywheelIterationProperties": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", "traits": { - "smithy.api#documentation": "The time that the recognizer creation completed.
" + "smithy.api#documentation": "" } }, - "TrainingStartTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "FlywheelIterationId": { + "target": "com.amazonaws.comprehend#FlywheelIterationId", "traits": { - "smithy.api#documentation": "The time that training of the entity recognizer started.
" + "smithy.api#documentation": "" } }, - "TrainingEndTime": { + "CreationTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "The time that training of the entity recognizer was completed.
" + "smithy.api#documentation": "The creation start time of the flywheel iteration.
" } }, - "InputDataConfig": { - "target": "com.amazonaws.comprehend#EntityRecognizerInputDataConfig", + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "The input data properties of an entity recognizer.
" + "smithy.api#documentation": "The completion time of this flywheel iteration.
" } }, - "RecognizerMetadata": { - "target": "com.amazonaws.comprehend#EntityRecognizerMetadata", + "Status": { + "target": "com.amazonaws.comprehend#FlywheelIterationStatus", "traits": { - "smithy.api#documentation": "Provides information about an entity recognizer.
" + "smithy.api#documentation": "The status of the flywheel iteration.
" } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your input data.
" + "smithy.api#documentation": "A description of the status of the flywheel iteration.
" } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "EvaluatedModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", "traits": { - "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The ARN of the evaluated model associated with this flywheel iteration.
" } }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", - "traits": { - "smithy.api#documentation": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your custom entity recognizer. For more information, see Amazon\n VPC.
" - } + "EvaluatedModelMetrics": { + "target": "com.amazonaws.comprehend#FlywheelModelEvaluationMetrics" }, - "ModelKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "TrainedModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", "traits": { - "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The ARN of the trained model associated with this flywheel iteration.
" } }, - "VersionName": { - "target": "com.amazonaws.comprehend#VersionName", + "TrainedModelMetrics": { + "target": "com.amazonaws.comprehend#FlywheelModelEvaluationMetrics", "traits": { - "smithy.api#documentation": "The version name you assigned to the entity recognizer.
" + "smithy.api#documentation": "The metrics associated with the trained model.
" } }, - "SourceModelArn": { - "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "EvaluationManifestS3Prefix": { + "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source model. This model was imported from a\n different AWS account to create the entity recognizer model in your AWS account.
" + "smithy.api#documentation": "" } } }, "traits": { - "smithy.api#documentation": "Describes information about an entity recognizer.
" - } - }, - "com.amazonaws.comprehend#EntityRecognizerPropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.comprehend#EntityRecognizerProperties" + "smithy.api#documentation": "The configuration properties of a flywheel iteration.
" } }, - "com.amazonaws.comprehend#EntityRecognizerSummariesList": { + "com.amazonaws.comprehend#FlywheelIterationPropertiesList": { "type": "list", "member": { - "target": "com.amazonaws.comprehend#EntityRecognizerSummary" - } - }, - "com.amazonaws.comprehend#EntityRecognizerSummary": { - "type": "structure", - "members": { - "RecognizerName": { - "target": "com.amazonaws.comprehend#ComprehendArnName", - "traits": { - "smithy.api#documentation": "The name that you assigned the entity recognizer.
" - } - }, - "NumberOfVersions": { - "target": "com.amazonaws.comprehend#Integer", - "traits": { - "smithy.api#documentation": "The number of versions you created.
" - } - }, - "LatestVersionCreatedAt": { - "target": "com.amazonaws.comprehend#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the latest entity recognizer version was submitted for processing.
" - } - }, - "LatestVersionName": { - "target": "com.amazonaws.comprehend#VersionName", - "traits": { - "smithy.api#documentation": "The version name you assigned to the latest entity recognizer version.
" - } - }, - "LatestVersionStatus": { - "target": "com.amazonaws.comprehend#ModelStatus", - "traits": { - "smithy.api#documentation": "Provides the status of the latest entity recognizer version.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the information about an entity recognizer and its versions.
" + "target": "com.amazonaws.comprehend#FlywheelIterationProperties" } }, - "com.amazonaws.comprehend#EntityType": { + "com.amazonaws.comprehend#FlywheelIterationStatus": { "type": "enum", "members": { - "PERSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERSON" - } - }, - "LOCATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOCATION" - } - }, - "ORGANIZATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ORGANIZATION" - } - }, - "COMMERCIAL_ITEM": { + "TRAINING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "COMMERCIAL_ITEM" + "smithy.api#enumValue": "TRAINING" } }, - "EVENT": { + "EVALUATING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EVENT" + "smithy.api#enumValue": "EVALUATING" } }, - "DATE": { + "COMPLETED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DATE" + "smithy.api#enumValue": "COMPLETED" } }, - "QUANTITY": { + "FAILED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "QUANTITY" + "smithy.api#enumValue": "FAILED" } }, - "TITLE": { + "STOP_REQUESTED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "TITLE" + "smithy.api#enumValue": "STOP_REQUESTED" } }, - "OTHER": { + "STOPPED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "OTHER" + "smithy.api#enumValue": "STOPPED" } } } }, - "com.amazonaws.comprehend#EntityTypeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^(?![^\\n\\r\\t,]*\\\\n|\\\\r|\\\\t)[^\\n\\r\\t,]+$" - } - }, - "com.amazonaws.comprehend#EntityTypesEvaluationMetrics": { + "com.amazonaws.comprehend#FlywheelModelEvaluationMetrics": { "type": "structure", "members": { - "Precision": { + "AverageF1Score": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "A measure of the usefulness of the recognizer results for a specific entity type in the\n test data. High precision means that the recognizer returned substantially more relevant\n results than irrelevant ones.
" + "smithy.api#documentation": "The average F1 score from the evaluation metrics.
" } }, - "Recall": { + "AveragePrecision": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "A measure of how complete the recognizer results are for a specific entity type in the\n test data. High recall means that the recognizer returned most of the relevant results.
" + "smithy.api#documentation": "Average precision metric for the model.
" } }, - "F1Score": { + "AverageRecall": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "A measure of how accurate the recognizer results are for a specific entity type in the\n test data. It is derived from the Precision and Recall values. The\n F1Score is the harmonic average of the two scores. The highest score is 1, and\n the worst score is 0.
Average recall metric for the model.
" } - } - }, - "traits": { - "smithy.api#documentation": "Detailed information about the accuracy of an entity recognizer for a specific entity\n type.
" - } - }, - "com.amazonaws.comprehend#EntityTypesList": { - "type": "list", - "member": { - "target": "com.amazonaws.comprehend#EntityTypesListItem" - } - }, - "com.amazonaws.comprehend#EntityTypesListItem": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.comprehend#EntityTypeName", + }, + "AverageAccuracy": { + "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "An entity type within a labeled training dataset that Amazon Comprehend uses to train a\n custom entity recognizer.
\nEntity types must not contain the following invalid characters: \\n (line break), \\\\n\n (escaped line break, \\r (carriage return), \\\\r (escaped carriage return), \\t (tab), \\\\t\n (escaped tab), space, and , (comma).
", - "smithy.api#required": {} + "smithy.api#documentation": "Average accuracy metric for the model.
" } } }, "traits": { - "smithy.api#documentation": "An entity type within a labeled training dataset that Amazon Comprehend uses to train a\n custom entity recognizer.
" + "smithy.api#documentation": "The evaluation metrics associated with the evaluated model.
" } }, - "com.amazonaws.comprehend#ErrorsListItem": { + "com.amazonaws.comprehend#FlywheelProperties": { "type": "structure", "members": { - "Page": { - "target": "com.amazonaws.comprehend#Integer", + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", "traits": { - "smithy.api#documentation": "Page number where the error occurred.
" + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel.
" } }, - "ErrorCode": { - "target": "com.amazonaws.comprehend#PageBasedErrorCode", + "ActiveModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", "traits": { - "smithy.api#documentation": "Error code for the cause of the error.
" + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the active model version.
" } }, - "ErrorMessage": { - "target": "com.amazonaws.comprehend#String", + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "Text message explaining the reason for the error.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend permission to access the flywheel data.
" } - } - }, - "traits": { - "smithy.api#documentation": "Text extraction encountered one or more page-level errors in the input document.
\nThe ErrorCode contains one of the following values:
TEXTRACT_BAD_PAGE - Amazon Textract cannot read the page. For more information\n about page limits in Amazon Textract, see \n Page Quotas in Amazon Textract.
\nTEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED - The number of requests exceeded your throughput limit.\n For more information about throughput quotas in Amazon Textract, see \n Default quotas in Amazon Textract.
\nPAGE_CHARACTERS_EXCEEDED - Too many text characters on the page (10,000 characters maximum).
\nPAGE_SIZE_EXCEEDED - The maximum page size is 10 MB.
\nINTERNAL_SERVER_ERROR - The request encountered a service issue. Try the API request again.
\nFilters on the name of the events detection job.
" + "smithy.api#documentation": "Configuration about the custom classifier associated with the flywheel.
" } }, - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", + "DataLakeS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "Filters the list of jobs based on job status. Returns only jobs with the specified\n status.
" + "smithy.api#documentation": "Amazon S3 URI of the data lake location.
" } }, - "SubmitTimeBefore": { + "DataSecurityConfig": { + "target": "com.amazonaws.comprehend#DataSecurityConfig", + "traits": { + "smithy.api#documentation": "Data security configuration.
" + } + }, + "Status": { + "target": "com.amazonaws.comprehend#FlywheelStatus", + "traits": { + "smithy.api#documentation": "The status of the flywheel.
" + } + }, + "ModelType": { + "target": "com.amazonaws.comprehend#ModelType", + "traits": { + "smithy.api#documentation": "Model type of the flywheel's model.
" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "A description of the status of the flywheel.
" + } + }, + "CreationTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.
" + "smithy.api#documentation": "Creation time of the flywheel.
" } }, - "SubmitTimeAfter": { + "LastModifiedTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.
" + "smithy.api#documentation": "Last modified time for the flywheel.
" + } + }, + "LatestFlywheelIteration": { + "target": "com.amazonaws.comprehend#FlywheelIterationId", + "traits": { + "smithy.api#documentation": "The most recent flywheel iteration.
" } } }, "traits": { - "smithy.api#documentation": "Provides information for filtering a list of event detection jobs.
" + "smithy.api#documentation": "The flywheel properties.
" } }, - "com.amazonaws.comprehend#EventsDetectionJobProperties": { - "type": "structure", + "com.amazonaws.comprehend#FlywheelS3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" + } + }, + "com.amazonaws.comprehend#FlywheelStatus": { + "type": "enum", "members": { - "JobId": { - "target": "com.amazonaws.comprehend#JobId", + "CREATING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The identifier assigned to the events detection job.
" + "smithy.api#enumValue": "CREATING" } }, - "JobArn": { - "target": "com.amazonaws.comprehend#ComprehendArn", + "ACTIVE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:
\n\n arn:\n
The following is an example job ARN:
\n\n arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab\n
The name you assigned the events detection job.
" + "smithy.api#enumValue": "UPDATING" } }, - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", + "DELETING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The current status of the events detection job.
" + "smithy.api#enumValue": "DELETING" } }, - "Message": { - "target": "com.amazonaws.comprehend#AnyLengthString", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A description of the status of the events detection job.
" + "smithy.api#enumValue": "FAILED" } - }, - "SubmitTime": { - "target": "com.amazonaws.comprehend#Timestamp", + } + } + }, + "com.amazonaws.comprehend#FlywheelSummary": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", "traits": { - "smithy.api#documentation": "The time that the events detection job was submitted for processing.
" + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel
" } }, - "EndTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "ActiveModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", "traits": { - "smithy.api#documentation": "The time that the events detection job completed.
" + "smithy.api#documentation": "ARN of the active model version for the flywheel.
" } }, - "InputDataConfig": { - "target": "com.amazonaws.comprehend#InputDataConfig", + "DataLakeS3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "The input data configuration that you supplied when you created the events detection\n job.
" + "smithy.api#documentation": "Amazon S3 URI of the data lake location.
" } }, - "OutputDataConfig": { - "target": "com.amazonaws.comprehend#OutputDataConfig", + "Status": { + "target": "com.amazonaws.comprehend#FlywheelStatus", "traits": { - "smithy.api#documentation": "The output data configuration that you supplied when you created the events detection\n job.
" + "smithy.api#documentation": "The status of the flywheel.
" } }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "ModelType": { + "target": "com.amazonaws.comprehend#ModelType", "traits": { - "smithy.api#documentation": "The language code of the input documents.
" + "smithy.api#documentation": "Model type of the flywheel's model.
" } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identify and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
" + "smithy.api#documentation": "A description of the status of the flywheel.
" } }, - "TargetEventTypes": { - "target": "com.amazonaws.comprehend#TargetEventTypes", + "CreationTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "The types of events that are detected by the job.
" + "smithy.api#documentation": "Creation time of the flywheel.
" } - } - }, - "traits": { - "smithy.api#documentation": "Provides information about an events detection job.
" - } - }, - "com.amazonaws.comprehend#EventsDetectionJobPropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.comprehend#EventsDetectionJobProperties" - } - }, - "com.amazonaws.comprehend#ExtractedCharactersListItem": { - "type": "structure", - "members": { - "Page": { - "target": "com.amazonaws.comprehend#Integer", + }, + "LastModifiedTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "Page number.
" + "smithy.api#documentation": "Last modified time for the flywheel.
" } }, - "Count": { - "target": "com.amazonaws.comprehend#Integer", + "LatestFlywheelIteration": { + "target": "com.amazonaws.comprehend#FlywheelIterationId", "traits": { - "smithy.api#documentation": "Number of characters extracted from each page.
" + "smithy.api#documentation": "The most recent flywheel iteration.
" } } }, "traits": { - "smithy.api#documentation": "Array of the number of characters extracted from each page.
" + "smithy.api#documentation": "Flywheel summary information.
" } }, - "com.amazonaws.comprehend#Float": { - "type": "float" + "com.amazonaws.comprehend#FlywheelSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#FlywheelSummary" + } }, "com.amazonaws.comprehend#Geometry": { "type": "structure", @@ -6475,7 +7305,7 @@ "BoundingBox": { "target": "com.amazonaws.comprehend#BoundingBox", "traits": { - "smithy.api#documentation": "An axis-aligned coarse representation of the location of the recognized item on the \n document page.
" + "smithy.api#documentation": "An axis-aligned coarse representation of the location of the recognized item on the\n document page.
" } }, "Polygon": { @@ -6571,15 +7401,18 @@ "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that allows\n Amazon Comprehend to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom\n model.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom\n model.
" } }, "Tags": { "target": "com.amazonaws.comprehend#TagList", "traits": { - "smithy.api#documentation": "Tags to be associated with the custom model that is created by this import. A tag is a\n key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a\n tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales\n department.
" + "smithy.api#documentation": "Tags to associate with the custom model that is created by this import. A tag is a\n key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a\n tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales\n department.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ImportModelResponse": { @@ -6591,6 +7424,9 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom model being imported.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#InferenceUnitsInteger": { @@ -6620,12 +7456,12 @@ "DocumentReaderConfig": { "target": "com.amazonaws.comprehend#DocumentReaderConfig", "traits": { - "smithy.api#documentation": "Provides configuration parameters to override the default actions for extracting text \n from PDF documents and image files.
" + "smithy.api#documentation": "Provides configuration parameters to override the default actions for extracting text\n from PDF documents and image files.
" } } }, "traits": { - "smithy.api#documentation": "The input properties for an inference job. The document reader config field applies \n only to non-text inputs for custom analysis.
" + "smithy.api#documentation": "The input properties for an inference job. The document reader config field applies\n only to non-text inputs for custom analysis.
" } }, "com.amazonaws.comprehend#InputFormat": { @@ -6951,7 +7787,7 @@ "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
" } }, "VolumeKmsKeyId": { @@ -7010,6 +7846,28 @@ "smithy.api#pattern": "^[ ~!@#$%^*\\-_+=|\\\\:;\\t>?/]$" } }, + "com.amazonaws.comprehend#LabelListItem": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5000 + }, + "smithy.api#pattern": "^\\P{C}*$" + } + }, + "com.amazonaws.comprehend#LabelsList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#LabelListItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, "com.amazonaws.comprehend#LanguageCode": { "type": "enum", "members": { @@ -7052,39 +7910,125 @@ "AR": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ar" + "smithy.api#enumValue": "ar" + } + }, + "HI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hi" + } + }, + "JA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ja" + } + }, + "KO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ko" + } + }, + "ZH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh" + } + }, + "ZH_TW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh-TW" + } + } + } + }, + "com.amazonaws.comprehend#ListDatasets": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListDatasetsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListDatasetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "List the datasets that you have configured in this region. For more information about datasets, see \n Flywheel overview in the Amazon Comprehend Developer Guide.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListDatasetsRequest": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel.
" } }, - "HI": { - "target": "smithy.api#Unit", + "Filter": { + "target": "com.amazonaws.comprehend#DatasetFilter", "traits": { - "smithy.api#enumValue": "hi" + "smithy.api#documentation": "Filters the datasets to be returned in the response.
" } }, - "JA": { - "target": "smithy.api#Unit", + "NextToken": { + "target": "com.amazonaws.comprehend#String", "traits": { - "smithy.api#enumValue": "ja" + "smithy.api#documentation": "Identifies the next page of results to return.
" } }, - "KO": { - "target": "smithy.api#Unit", + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", "traits": { - "smithy.api#enumValue": "ko" + "smithy.api#documentation": "Maximum number of results to return in a response. The default is 100.
" } - }, - "ZH": { - "target": "smithy.api#Unit", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListDatasetsResponse": { + "type": "structure", + "members": { + "DatasetPropertiesList": { + "target": "com.amazonaws.comprehend#DatasetPropertiesList", "traits": { - "smithy.api#enumValue": "zh" + "smithy.api#documentation": "The dataset properties list.
" } }, - "ZH_TW": { - "target": "smithy.api#Unit", + "NextToken": { + "target": "com.amazonaws.comprehend#String", "traits": { - "smithy.api#enumValue": "zh-TW" + "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#ListDocumentClassificationJobs": { @@ -7139,6 +8083,9 @@ "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ListDocumentClassificationJobsResponse": { @@ -7156,6 +8103,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#ListDocumentClassifierSummaries": { @@ -7201,6 +8151,9 @@ "smithy.api#documentation": "The maximum number of results to return on each page. The default is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ListDocumentClassifierSummariesResponse": { @@ -7218,6 +8171,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#ListDocumentClassifiers": { @@ -7272,6 +8228,9 @@ "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ListDocumentClassifiersResponse": { @@ -7289,6 +8248,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#ListDominantLanguageDetectionJobs": { @@ -7343,6 +8305,9 @@ "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ListDominantLanguageDetectionJobsResponse": { @@ -7360,6 +8325,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#ListEndpoints": { @@ -7412,6 +8380,9 @@ "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ListEndpointsResponse": { @@ -7429,6 +8400,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#ListEntitiesDetectionJobs": { @@ -7483,6 +8457,9 @@ "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ListEntitiesDetectionJobsResponse": { @@ -7500,6 +8477,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#ListEntityRecognizerSummaries": { @@ -7545,6 +8525,9 @@ "smithy.api#documentation": "The maximum number of results to return on each page. The default is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ListEntityRecognizerSummariesResponse": { @@ -7559,9 +8542,12 @@ "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { - "smithy.api#documentation": "The list entity recognizer summaries.
" + "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#ListEntityRecognizers": { @@ -7616,6 +8602,9 @@ "smithy.api#documentation": "The maximum number of results to return on each page. The default is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ListEntityRecognizersResponse": { @@ -7633,6 +8622,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#ListEventsDetectionJobs": { @@ -7687,6 +8679,9 @@ "smithy.api#documentation": "The maximum number of results to return in each page.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ListEventsDetectionJobsResponse": { @@ -7704,6 +8699,173 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListFlywheelIterationHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListFlywheelIterationHistoryRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListFlywheelIterationHistoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Information about the history of a flywheel iteration.\n For more information about flywheels, see \n Flywheel overview in the Amazon Comprehend Developer Guide.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListFlywheelIterationHistoryRequest": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "The ARN of the flywheel.
", + "smithy.api#required": {} + } + }, + "Filter": { + "target": "com.amazonaws.comprehend#FlywheelIterationFilter", + "traits": { + "smithy.api#documentation": "Filter the flywheel iteration history based on creation time.
" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "Next token
" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "Maximum number of iteration history results to return
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListFlywheelIterationHistoryResponse": { + "type": "structure", + "members": { + "FlywheelIterationPropertiesList": { + "target": "com.amazonaws.comprehend#FlywheelIterationPropertiesList", + "traits": { + "smithy.api#documentation": "List of flywheel iteration properties
" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "Next token
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#ListFlywheels": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListFlywheelsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListFlywheelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a list of the flywheels that you have created.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.comprehend#ListFlywheelsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehend#FlywheelFilter", + "traits": { + "smithy.api#documentation": "Filters the flywheels that are returned. You can filter flywheels on their status,\n or the date and time that they were submitted. You can only set one filter at a time.\n
" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "Identifies the next page of results to return.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "Maximum number of results to return in a response. The default is 100.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#ListFlywheelsResponse": { + "type": "structure", + "members": { + "FlywheelSummaryList": { + "target": "com.amazonaws.comprehend#FlywheelSummaryList", + "traits": { + "smithy.api#documentation": "A list of flywheel properties retrieved by the service in response to the request.\n
" + } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "Identifies the next page of results to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobs": { @@ -7758,6 +8920,9 @@ "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobsResponse": { @@ -7775,6 +8940,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#ListOfBlockReferences": { @@ -7992,6 +9160,9 @@ "smithy.api#documentation": "The maximum number of results to return in each page.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobsResponse": { @@ -8009,6 +9180,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#ListSentimentDetectionJobs": { @@ -8063,6 +9237,9 @@ "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ListSentimentDetectionJobsResponse": { @@ -8080,6 +9257,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#ListTagsForResource": { @@ -8115,6 +9295,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ListTagsForResourceResponse": { @@ -8132,6 +9315,9 @@ "smithy.api#documentation": "Tags associated with the Amazon Comprehend resource being queried. A tag is a key-value\n pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#ListTargetedSentimentDetectionJobs": { @@ -8186,6 +9372,9 @@ "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ListTargetedSentimentDetectionJobsResponse": { @@ -8203,6 +9392,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#ListTopicsDetectionJobs": { @@ -8257,6 +9449,9 @@ "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#ListTopicsDetectionJobsResponse": { @@ -8274,6 +9469,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#MaskCharacter": { @@ -8359,6 +9557,26 @@ } } }, + "com.amazonaws.comprehend#ModelType": { + "type": "enum", + "members": { + "DOCUMENT_CLASSIFIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT_CLASSIFIER" + } + }, + "ENTITY_RECOGNIZER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENTITY_RECOGNIZER" + } + } + } + }, + "com.amazonaws.comprehend#NumberOfDocuments": { + "type": "long" + }, "com.amazonaws.comprehend#NumberOfTopicsInteger": { "type": "integer", "traits": { @@ -8661,7 +9879,7 @@ "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
" } }, "Mode": { @@ -9087,6 +10305,9 @@ "smithy.api#documentation": "The revision ID that Amazon Comprehend assigned to the policy that you are updating. If\n you are creating a new policy that has no prior version, don't use this parameter. Amazon\n Comprehend creates the revision ID for you.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#PutResourcePolicyResponse": { @@ -9098,6 +10319,9 @@ "smithy.api#documentation": "The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a\n new revision ID, and it deletes the prior version of the policy.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#RedactionConfig": { @@ -9347,7 +10571,7 @@ "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
" } }, "VolumeKmsKeyId": { @@ -9483,7 +10707,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts an asynchronous document classification job. Use the operation to track the progress of the\n job.
" + "smithy.api#documentation": "Starts an asynchronous document classification job. Use the \n DescribeDocumentClassificationJob\n operation to track the progress of the job.
The Amazon Resource Name (ARN) of the document classifier to use to process the\n job.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the document classifier to use to process the\n job.
" } }, "InputDataConfig": { @@ -9545,9 +10768,18 @@ "Tags": { "target": "com.amazonaws.comprehend#TagList", "traits": { - "smithy.api#documentation": "Tags to be associated with the document classification job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.
" + "smithy.api#documentation": "Tags to associate with the document classification job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.
" + } + }, + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#StartDocumentClassificationJobResponse": { @@ -9556,7 +10788,7 @@ "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "The identifier generated for the job. To get the status of the job, use this identifier\n with the operation.
" + "smithy.api#documentation": "The identifier generated for the job. To get the status of the job, use this identifier\n with the DescribeDocumentClassificationJob operation.
The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:
\n\n arn:\n
The following is an example job ARN:
\n\n arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab\n
The status of the job:
\nSUBMITTED - The job has been received and queued for processing.
\nIN_PROGRESS - Amazon Comprehend is processing the job.
\nCOMPLETED - The job was successfully completed and the output is available.
\nFAILED - The job did not complete. For details, use the \n DescribeDocumentClassificationJob operation.
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is\n processing the request.
\nSTOPPED - The job was successfully stopped without completing.
\nThe status of the job:
\nSUBMITTED - The job has been received and queued for processing.
\nIN_PROGRESS - Amazon Comprehend is processing the job.
\nCOMPLETED - The job was successfully completed and the output is available.
\nFAILED - The job did not complete. For details, use the operation.
\nSTOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is\n processing the request.
\nSTOPPED - The job was successfully stopped without completing.
\nThe ARN of the custom classification model.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#StartDominantLanguageDetectionJob": { @@ -9654,9 +10895,12 @@ "Tags": { "target": "com.amazonaws.comprehend#TagList", "traits": { - "smithy.api#documentation": "Tags to be associated with the dominant language detection job. A tag is a key-value pair\n that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as\n the key might be added to a resource to indicate its use by the sales department.
" + "smithy.api#documentation": "Tags to associate with the dominant language detection job. A tag is a key-value pair\n that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as\n the key might be added to a resource to indicate its use by the sales department.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#StartDominantLanguageDetectionJobResponse": { @@ -9680,6 +10924,9 @@ "smithy.api#documentation": "The status of the job.
\nSUBMITTED - The job has been received and is queued for processing.
\nIN_PROGRESS - Amazon Comprehend is processing the job.
\nCOMPLETED - The job was successfully completed and the output is available.
\nFAILED - The job did not complete. To get details, use the operation.
\nTags to be associated with the entities detection job. A tag is a key-value pair that adds\n metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key\n might be added to a resource to indicate its use by the sales department.
" + "smithy.api#documentation": "Tags to associate with the entities detection job. A tag is a key-value pair that adds\n metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key\n might be added to a resource to indicate its use by the sales department.
" + } + }, + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#StartEntitiesDetectionJobResponse": { @@ -9807,7 +11063,16 @@ "traits": { "smithy.api#documentation": "The status of the job.
\nSUBMITTED - The job has been received and is queued for processing.
\nIN_PROGRESS - Amazon Comprehend is processing the job.
\nCOMPLETED - The job was successfully completed and the output is available.
\nFAILED - The job did not complete. To get details, use the operation.
\nSTOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is\n processing the request.
\nSTOPPED - The job was successfully stopped without completing.
\nThe ARN of the custom entity recognition model.
" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#StartEventsDetectionJob": { @@ -9893,9 +11158,12 @@ "Tags": { "target": "com.amazonaws.comprehend#TagList", "traits": { - "smithy.api#documentation": "Tags to be associated with the events detection job. A tag is a key-value pair that adds\n metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key\n might be added to a resource to indicate its use by the sales department.
" + "smithy.api#documentation": "Tags to associate with the events detection job. A tag is a key-value pair that adds\n metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key\n might be added to a resource to indicate its use by the sales department.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#StartEventsDetectionJobResponse": { @@ -9919,6 +11187,79 @@ "smithy.api#documentation": "The status of the events detection job.
" } } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#StartFlywheelIteration": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StartFlywheelIterationRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StartFlywheelIterationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Start the flywheel iteration.This operation uses any new datasets to train a new model version.\n For more information about flywheels, see \n Flywheel overview in the Amazon Comprehend Developer Guide.
" + } + }, + "com.amazonaws.comprehend#StartFlywheelIterationRequest": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "The ARN of the flywheel.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#StartFlywheelIterationResponse": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "" + } + }, + "FlywheelIterationId": { + "target": "com.amazonaws.comprehend#FlywheelIterationId", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#StartKeyPhrasesDetectionJob": { @@ -10009,9 +11350,12 @@ "Tags": { "target": "com.amazonaws.comprehend#TagList", "traits": { - "smithy.api#documentation": "Tags to be associated with the key phrases detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.
" + "smithy.api#documentation": "Tags to associate with the key phrases detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#StartKeyPhrasesDetectionJobResponse": { @@ -10035,6 +11379,9 @@ "smithy.api#documentation": "The status of the job.
\nSUBMITTED - The job has been received and is queued for processing.
\nIN_PROGRESS - Amazon Comprehend is processing the job.
\nCOMPLETED - The job was successfully completed and the output is available.
\nFAILED - The job did not complete. To get details, use the operation.
\nTags to be associated with the PII entities detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.
" + "smithy.api#documentation": "Tags to associate with the PII entities detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#StartPiiEntitiesDetectionJobResponse": { @@ -10152,6 +11502,9 @@ "smithy.api#documentation": "The status of the job.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#StartSentimentDetectionJob": { @@ -10242,9 +11595,12 @@ "Tags": { "target": "com.amazonaws.comprehend#TagList", "traits": { - "smithy.api#documentation": "Tags to be associated with the sentiment detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.
" + "smithy.api#documentation": "Tags to associate with the sentiment detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#StartSentimentDetectionJobResponse": { @@ -10268,6 +11624,9 @@ "smithy.api#documentation": "The status of the job.
\nSUBMITTED - The job has been received and is queued for processing.
\nIN_PROGRESS - Amazon Comprehend is processing the job.
\nCOMPLETED - The job was successfully completed and the output is available.
\nFAILED - The job did not complete. To get details, use the operation.
\nStarts an asynchronous targeted sentiment detection job for a collection of documents. Use the\n operation to track the status of a\n job.
" + "smithy.api#documentation": "Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the\n DescribeTargetedSentimentDetectionJob operation to track the status of a\n job.
Tags to be associated with the targeted sentiment detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.
" + "smithy.api#documentation": "Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#StartTargetedSentimentDetectionJobResponse": { @@ -10365,7 +11727,7 @@ "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "The identifier generated for the job. To get the status of a job, use this identifier with\n the operation.
" + "smithy.api#documentation": "The identifier generated for the job. To get the status of a job, use this identifier with\n the DescribeTargetedSentimentDetectionJob operation.
The status of the job.
\nSUBMITTED - The job has been received and is queued for processing.
\nIN_PROGRESS - Amazon Comprehend is processing the job.
\nCOMPLETED - The job was successfully completed and the output is available.
\nFAILED - The job did not complete. To get details, use the operation.
\nThe status of the job.
\nSUBMITTED - The job has been received and is queued for processing.
\nIN_PROGRESS - Amazon Comprehend is processing the job.
\nCOMPLETED - The job was successfully completed and the output is available.
\nFAILED - The job did not complete. To get details, use the \n DescribeTargetedSentimentDetectionJob operation.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role\n 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.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n 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.
", "smithy.api#required": {} } }, @@ -10469,9 +11834,12 @@ "Tags": { "target": "com.amazonaws.comprehend#TagList", "traits": { - "smithy.api#documentation": "Tags to be associated with the topics detection job. A tag is a key-value pair that adds\n metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key\n might be added to a resource to indicate its use by the sales department.
" + "smithy.api#documentation": "Tags to associate with the topics detection job. A tag is a key-value pair that adds\n metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key\n might be added to a resource to indicate its use by the sales department.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#StartTopicsDetectionJobResponse": { @@ -10495,6 +11863,9 @@ "smithy.api#documentation": "The status of the job:
\nSUBMITTED - The job has been received and is queued for processing.
\nIN_PROGRESS - Amazon Comprehend is processing the job.
\nCOMPLETED - The job was successfully completed and the output is\n available.
\nFAILED - The job did not complete. To get details, use the\n DescribeTopicDetectionJob operation.
Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopDominantLanguageDetectionJob operation.
Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopEntitiesDetectionJob operation.
The status of the events detection job.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#StopKeyPhrasesDetectionJob": { @@ -10686,6 +12075,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#StopKeyPhrasesDetectionJobResponse": { @@ -10703,6 +12095,9 @@ "smithy.api#documentation": "Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopKeyPhrasesDetectionJob operation.
The status of the PII entities detection job.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehend#StopSentimentDetectionJob": { @@ -10790,6 +12191,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#StopSentimentDetectionJobResponse": { @@ -10807,6 +12211,9 @@ "smithy.api#documentation": "Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopSentimentDetectionJob operation.
Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopSentimentDetectionJob operation.
Provides information for filtering a list of dominant language detection jobs. For more\n information, see the operation.
" + "smithy.api#documentation": "Provides information for filtering a list of dominant language detection jobs. For more\n information, see the ListTargetedSentimentDetectionJobs operation.
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
" } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the\n targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
ID for the KMS key that Amazon Comprehend uses to encrypt the\n data on the storage volume attached to the ML compute instance(s) that process the\n targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Information about one mention of an entity. The mention information includes the location of the mention\n in the text and the sentiment of the mention.
\nFor more information about targeted sentiment, see Targeted sentiment.
" } }, + "com.amazonaws.comprehend#TaskConfig": { + "type": "structure", + "members": { + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "Language code for the language that the model supports.
", + "smithy.api#required": {} + } + }, + "DocumentClassificationConfig": { + "target": "com.amazonaws.comprehend#DocumentClassificationConfig", + "traits": { + "smithy.api#documentation": "Configuration required for a classification model.
" + } + }, + "EntityRecognitionConfig": { + "target": "com.amazonaws.comprehend#EntityRecognitionConfig", + "traits": { + "smithy.api#documentation": "Configuration required for an entity recognition model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration about the custom classifier associated with the flywheel.
" + } + }, "com.amazonaws.comprehend#TextSizeLimitExceededException": { "type": "structure", "members": { @@ -11619,7 +13077,7 @@ "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your job data.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your job data.
" } }, "VolumeKmsKeyId": { @@ -11704,11 +13162,40 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#UntagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#UpdateDataSecurityConfig": { + "type": "structure", + "members": { + "ModelKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
ID for the KMS key that Amazon Comprehend uses to encrypt the volume.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig" + } + }, + "traits": { + "smithy.api#documentation": "Data security configuration.
" + } }, "com.amazonaws.comprehend#UpdateEndpoint": { "type": "operation", @@ -11772,12 +13259,107 @@ "traits": { "smithy.api#documentation": "Data access role ARN to use in case the new model is encrypted with a customer CMK.
" } + }, + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel
" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehend#UpdateEndpointResponse": { "type": "structure", - "members": {} + "members": { + "DesiredModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the new model.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.comprehend#UpdateFlywheel": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#UpdateFlywheelRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#UpdateFlywheelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Update the configuration information for an existing flywheel.
" + } + }, + "com.amazonaws.comprehend#UpdateFlywheelRequest": { + "type": "structure", + "members": { + "FlywheelArn": { + "target": "com.amazonaws.comprehend#ComprehendFlywheelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the flywheel to update.
", + "smithy.api#required": {} + } + }, + "ActiveModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the active model version.
" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend permission to access the flywheel data.
" + } + }, + "DataSecurityConfig": { + "target": "com.amazonaws.comprehend#UpdateDataSecurityConfig", + "traits": { + "smithy.api#documentation": "Flywheel data security configuration.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.comprehend#UpdateFlywheelResponse": { + "type": "structure", + "members": { + "FlywheelProperties": { + "target": "com.amazonaws.comprehend#FlywheelProperties", + "traits": { + "smithy.api#documentation": "The flywheel properties.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.comprehend#VersionName": { "type": "string",