comprehend

package module
v0.0.0-...-68f2935 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 42 Imported by: 0

Documentation

Overview

Package comprehend provides the API client, operations, and parameter types for Amazon Comprehend.

Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.

Index

Constants

View Source 
const ServiceAPIVersion = "2017-11-27"
View Source 
const ServiceID = "Comprehend"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchDetectDominantLanguageInput 

type BatchDetectDominantLanguageInput struct {

	// A list containing the UTF-8 encoded text of the input documents. The list can
	// contain a maximum of 25 documents. Each document should contain at least 20
	// characters. The maximum size of each document is 5 KB.
	//
	// This member is required.
	TextList []string
	// contains filtered or unexported fields
}

type BatchDetectDominantLanguageOutput 

type BatchDetectDominantLanguageOutput struct {

	// A list containing one object for each document that contained an error. The
	// results are sorted in ascending order by the Index field and match the order of
	// the documents in the input list. If there are no errors in the batch, the
	// ErrorList is empty.
	//
	// This member is required.
	ErrorList []types.BatchItemError

	// A list of objects containing the results of the operation. The results are
	// sorted in ascending order by the Index field and match the order of the
	// documents in the input list. If all of the documents contain an error, the
	// ResultList is empty.
	//
	// This member is required.
	ResultList []types.BatchDetectDominantLanguageItemResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchDetectEntitiesInput 

type BatchDetectEntitiesInput struct {

	// The language of the input documents. You can specify any of the primary
	// languages supported by Amazon Comprehend. All documents must be in the same
	// language.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// A list containing the UTF-8 encoded text of the input documents. The list can
	// contain a maximum of 25 documents. The maximum size of each document is 5 KB.
	//
	// This member is required.
	TextList []string
	// contains filtered or unexported fields
}

type BatchDetectEntitiesOutput 

type BatchDetectEntitiesOutput struct {

	// A list containing one object for each document that contained an error. The
	// results are sorted in ascending order by the Index field and match the order of
	// the documents in the input list. If there are no errors in the batch, the
	// ErrorList is empty.
	//
	// This member is required.
	ErrorList []types.BatchItemError

	// A list of objects containing the results of the operation. The results are
	// sorted in ascending order by the Index field and match the order of the
	// documents in the input list. If all of the documents contain an error, the
	// ResultList is empty.
	//
	// This member is required.
	ResultList []types.BatchDetectEntitiesItemResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchDetectKeyPhrasesInput 

type BatchDetectKeyPhrasesInput struct {

	// The language of the input documents. You can specify any of the primary
	// languages supported by Amazon Comprehend. All documents must be in the same
	// language.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// A list containing the UTF-8 encoded text of the input documents. The list can
	// contain a maximum of 25 documents. The maximum size of each document is 5 KB.
	//
	// This member is required.
	TextList []string
	// contains filtered or unexported fields
}

type BatchDetectKeyPhrasesOutput 

type BatchDetectKeyPhrasesOutput struct {

	// A list containing one object for each document that contained an error. The
	// results are sorted in ascending order by the Index field and match the order of
	// the documents in the input list. If there are no errors in the batch, the
	// ErrorList is empty.
	//
	// This member is required.
	ErrorList []types.BatchItemError

	// A list of objects containing the results of the operation. The results are
	// sorted in ascending order by the Index field and match the order of the
	// documents in the input list. If all of the documents contain an error, the
	// ResultList is empty.
	//
	// This member is required.
	ResultList []types.BatchDetectKeyPhrasesItemResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchDetectSentimentInput 

type BatchDetectSentimentInput struct {

	// The language of the input documents. You can specify any of the primary
	// languages supported by Amazon Comprehend. All documents must be in the same
	// language.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// A list containing the UTF-8 encoded text of the input documents. The list can
	// contain a maximum of 25 documents. The maximum size of each document is 5 KB.
	//
	// This member is required.
	TextList []string
	// contains filtered or unexported fields
}

type BatchDetectSentimentOutput 

type BatchDetectSentimentOutput struct {

	// A list containing one object for each document that contained an error. The
	// results are sorted in ascending order by the Index field and match the order of
	// the documents in the input list. If there are no errors in the batch, the
	// ErrorList is empty.
	//
	// This member is required.
	ErrorList []types.BatchItemError

	// A list of objects containing the results of the operation. The results are
	// sorted in ascending order by the Index field and match the order of the
	// documents in the input list. If all of the documents contain an error, the
	// ResultList is empty.
	//
	// This member is required.
	ResultList []types.BatchDetectSentimentItemResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchDetectSyntaxInput 

type BatchDetectSyntaxInput struct {

	// 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.
	//
	// This member is required.
	LanguageCode types.SyntaxLanguageCode

	// A list containing the UTF-8 encoded text of the input documents. The list can
	// contain a maximum of 25 documents. The maximum size for each document is 5 KB.
	//
	// This member is required.
	TextList []string
	// contains filtered or unexported fields
}

type BatchDetectSyntaxOutput 

type BatchDetectSyntaxOutput struct {

	// A list containing one object for each document that contained an error. The
	// results are sorted in ascending order by the Index field and match the order of
	// the documents in the input list. If there are no errors in the batch, the
	// ErrorList is empty.
	//
	// This member is required.
	ErrorList []types.BatchItemError

	// A list of objects containing the results of the operation. The results are
	// sorted in ascending order by the Index field and match the order of the
	// documents in the input list. If all of the documents contain an error, the
	// ResultList is empty.
	//
	// This member is required.
	ResultList []types.BatchDetectSyntaxItemResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchDetectTargetedSentimentInput 

type BatchDetectTargetedSentimentInput struct {

	// The language of the input documents. Currently, English is the only supported
	// language.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// A list containing the UTF-8 encoded text of the input documents. The list can
	// contain a maximum of 25 documents. The maximum size of each document is 5 KB.
	//
	// This member is required.
	TextList []string
	// contains filtered or unexported fields
}

type BatchDetectTargetedSentimentOutput 

type BatchDetectTargetedSentimentOutput struct {

	// List of errors that the operation can return.
	//
	// This member is required.
	ErrorList []types.BatchItemError

	// A list of objects containing the results of the operation. The results are
	// sorted in ascending order by the Index field and match the order of the
	// documents in the input list. If all of the documents contain an error, the
	// ResultList is empty.
	//
	// This member is required.
	ResultList []types.BatchDetectTargetedSentimentItemResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ClassifyDocumentInput 

type ClassifyDocumentInput struct {

	// The Amazon Resource Number (ARN) of the endpoint.
	//
	// For prompt safety classification, Amazon Comprehend provides the endpoint ARN.
	// For more information about prompt safety classifiers, see [Prompt safety classification]in the Amazon
	// Comprehend Developer Guide
	//
	// For custom classification, you create an endpoint for your custom model. For
	// more information, see [Using Amazon Comprehend endpoints].
	//
	// [Prompt safety classification]: https://docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification
	// [Using Amazon Comprehend endpoints]: https://docs.aws.amazon.com/comprehend/latest/dg/using-endpoints.html
	//
	// This member is required.
	EndpointArn *string

	// Use the Bytes parameter to input a text, PDF, Word or image file.
	//
	// When you classify a document using a custom model, you can also use the Bytes
	// parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument
	// output file.
	//
	// To classify a document using the prompt safety classifier, use the Text
	// parameter for input.
	//
	// Provide the input document as a sequence of base64-encoded bytes. If your code
	// uses an Amazon Web Services SDK to classify documents, the SDK may encode the
	// document file bytes for you.
	//
	// The maximum length of this field depends on the input document type. For
	// details, see [Inputs for real-time custom analysis]in the Comprehend Developer Guide.
	//
	// If you use the Bytes parameter, do not use the Text parameter.
	//
	// [Inputs for real-time custom analysis]: https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html
	Bytes []byte

	// Provides configuration parameters to override the default actions for
	// extracting text from PDF documents and image files.
	DocumentReaderConfig *types.DocumentReaderConfig

	// The document text to be analyzed. If you enter text using this parameter, do
	// not use the Bytes parameter.
	Text *string
	// contains filtered or unexported fields
}

type ClassifyDocumentOutput 

type ClassifyDocumentOutput struct {

	// The classes used by the document being analyzed. These are used for models
	// trained in multi-class mode. Individual classes are mutually exclusive and each
	// document is expected to have only a single class assigned to it. For example, an
	// animal can be a dog or a cat, but not both at the same time.
	//
	// For prompt safety classification, the response includes only two classes
	// (SAFE_PROMPT and UNSAFE_PROMPT), along with a confidence score for each class.
	// The value range of the score is zero to one, where one is the highest
	// confidence.
	Classes []types.DocumentClass

	// Extraction information about the document. This field is present in the
	// response only if your request includes the Byte parameter.
	DocumentMetadata *types.DocumentMetadata

	// The document type for each page in the input document. This field is present in
	// the response only if your request includes the Byte parameter.
	DocumentType []types.DocumentTypeListItem

	// Page-level errors that the system detected while processing the input document.
	// The field is empty if the system encountered no errors.
	Errors []types.ErrorsListItem

	// The labels used in the document being analyzed. These are used for multi-label
	// trained models. Individual labels represent different categories that are
	// related in some manner and are not mutually exclusive. For example, a movie can
	// be just an action movie, or it can be an action movie, a science fiction movie,
	// and a comedy, all at the same time.
	Labels []types.DocumentLabel

	// Warnings detected while processing the input document. The response includes a
	// warning if there is a mismatch between the input document type and the model
	// type associated with the endpoint that you specified. The response can also
	// include warnings for individual pages that have a mismatch.
	//
	// The field is empty if the system generated no warnings.
	Warnings []types.WarningsListItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Comprehend.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchDetectDominantLanguage 

func (c *Client) BatchDetectDominantLanguage(ctx context.Context, params *BatchDetectDominantLanguageInput, optFns ...func(*Options)) (*BatchDetectDominantLanguageOutput, error)

Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

func (*Client) BatchDetectEntities 

func (c *Client) BatchDetectEntities(ctx context.Context, params *BatchDetectEntitiesInput, optFns ...func(*Options)) (*BatchDetectEntitiesOutput, error)

Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entitiesin the Comprehend Developer Guide.

func (*Client) BatchDetectKeyPhrases 

func (c *Client) BatchDetectKeyPhrases(ctx context.Context, params *BatchDetectKeyPhrasesInput, optFns ...func(*Options)) (*BatchDetectKeyPhrasesOutput, error)

Detects the key noun phrases found in a batch of documents.

func (*Client) BatchDetectSentiment 

func (c *Client) BatchDetectSentiment(ctx context.Context, params *BatchDetectSentimentInput, optFns ...func(*Options)) (*BatchDetectSentimentOutput, error)

Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE , NEUTRAL , MIXED , or NEGATIVE , in each one.

func (*Client) BatchDetectSyntax 

func (c *Client) BatchDetectSyntax(ctx context.Context, params *BatchDetectSyntaxInput, optFns ...func(*Options)) (*BatchDetectSyntaxOutput, error)

Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see Syntaxin the Comprehend Developer Guide.

func (*Client) BatchDetectTargetedSentiment 

func (c *Client) BatchDetectTargetedSentiment(ctx context.Context, params *BatchDetectTargetedSentimentInput, optFns ...func(*Options)) (*BatchDetectTargetedSentimentOutput, error)

Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.

For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

func (*Client) ClassifyDocument 

func (c *Client) ClassifyDocument(ctx context.Context, params *ClassifyDocumentInput, optFns ...func(*Options)) (*ClassifyDocumentOutput, error)

Creates a classification request to analyze a single document in real-time. ClassifyDocument supports the following model types:

  • Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Amazon Textract API output. For more information, see Custom classificationin the Amazon Comprehend Developer Guide.

  • Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying input prompts for generative AI applications. For input, you provide English plain text input. For prompt safety classification, the response includes only the Classes field. For more information about prompt safety classifiers, see Prompt safety classificationin the Amazon Comprehend Developer Guide.

If the system detects errors while processing a page in the input document, the API response includes an Errors field that describes the errors.

If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documentsin the Comprehend Developer Guide.

func (*Client) ContainsPiiEntities 

func (c *Client) ContainsPiiEntities(ctx context.Context, params *ContainsPiiEntitiesInput, optFns ...func(*Options)) (*ContainsPiiEntitiesOutput, error)

Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.

func (*Client) CreateDataset 

func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error)

Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overviewin the Amazon Comprehend Developer Guide.

func (*Client) CreateDocumentClassifier 

func (c *Client) CreateDocumentClassifier(ctx context.Context, params *CreateDocumentClassifierInput, optFns ...func(*Options)) (*CreateDocumentClassifierOutput, error)

Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that are labeled with the categories that you want to use. For more information, see Training classifier modelsin the Comprehend Developer Guide.

func (*Client) CreateEndpoint 

func (c *Client) CreateEndpoint(ctx context.Context, params *CreateEndpointInput, optFns ...func(*Options)) (*CreateEndpointOutput, error)

Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.

func (*Client) CreateEntityRecognizer 

func (c *Client) CreateEntityRecognizer(ctx context.Context, params *CreateEntityRecognizerInput, optFns ...func(*Options)) (*CreateEntityRecognizerOutput, error)

Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.

func (*Client) CreateFlywheel 

func (c *Client) CreateFlywheel(ctx context.Context, params *CreateFlywheelInput, optFns ...func(*Options)) (*CreateFlywheelOutput, error)

A flywheel is an Amazon Web Services 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.

func (*Client) DeleteDocumentClassifier 

func (c *Client) DeleteDocumentClassifier(ctx context.Context, params *DeleteDocumentClassifierInput, optFns ...func(*Options)) (*DeleteDocumentClassifierOutput, error)

Deletes a previously created document classifier

Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.

This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.

func (*Client) DeleteEndpoint 

func (c *Client) DeleteEndpoint(ctx context.Context, params *DeleteEndpointInput, optFns ...func(*Options)) (*DeleteEndpointOutput, error)

Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints.

func (*Client) DeleteEntityRecognizer 

func (c *Client) DeleteEntityRecognizer(ctx context.Context, params *DeleteEntityRecognizerInput, optFns ...func(*Options)) (*DeleteEntityRecognizerOutput, error)

Deletes an entity recognizer.

Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.

This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.

func (*Client) DeleteFlywheel 

func (c *Client) DeleteFlywheel(ctx context.Context, params *DeleteFlywheelInput, optFns ...func(*Options)) (*DeleteFlywheelOutput, error)

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.

func (*Client) DeleteResourcePolicy 

func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error)

Deletes a resource-based policy that is attached to a custom model.

func (*Client) DescribeDataset 

func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error)

Returns information about the dataset that you specify. For more information about datasets, see Flywheel overviewin the Amazon Comprehend Developer Guide.

func (*Client) DescribeDocumentClassificationJob 

func (c *Client) DescribeDocumentClassificationJob(ctx context.Context, params *DescribeDocumentClassificationJobInput, optFns ...func(*Options)) (*DescribeDocumentClassificationJobOutput, error)

Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.

func (*Client) DescribeDocumentClassifier 

func (c *Client) DescribeDocumentClassifier(ctx context.Context, params *DescribeDocumentClassifierInput, optFns ...func(*Options)) (*DescribeDocumentClassifierOutput, error)

Gets the properties associated with a document classifier.

func (*Client) DescribeDominantLanguageDetectionJob 

func (c *Client) DescribeDominantLanguageDetectionJob(ctx context.Context, params *DescribeDominantLanguageDetectionJobInput, optFns ...func(*Options)) (*DescribeDominantLanguageDetectionJobOutput, error)

Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.

func (*Client) DescribeEndpoint 

func (c *Client) DescribeEndpoint(ctx context.Context, params *DescribeEndpointInput, optFns ...func(*Options)) (*DescribeEndpointOutput, error)

Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.

func (*Client) DescribeEntitiesDetectionJob 

func (c *Client) DescribeEntitiesDetectionJob(ctx context.Context, params *DescribeEntitiesDetectionJobInput, optFns ...func(*Options)) (*DescribeEntitiesDetectionJobOutput, error)

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

func (*Client) DescribeEntityRecognizer 

func (c *Client) DescribeEntityRecognizer(ctx context.Context, params *DescribeEntityRecognizerInput, optFns ...func(*Options)) (*DescribeEntityRecognizerOutput, error)

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

func (*Client) DescribeEventsDetectionJob 

func (c *Client) DescribeEventsDetectionJob(ctx context.Context, params *DescribeEventsDetectionJobInput, optFns ...func(*Options)) (*DescribeEventsDetectionJobOutput, error)

Gets the status and details of an events detection job.

func (*Client) DescribeFlywheel 

func (c *Client) DescribeFlywheel(ctx context.Context, params *DescribeFlywheelInput, optFns ...func(*Options)) (*DescribeFlywheelOutput, error)

Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overviewin the Amazon Comprehend Developer Guide.

func (*Client) DescribeFlywheelIteration 

func (c *Client) DescribeFlywheelIteration(ctx context.Context, params *DescribeFlywheelIterationInput, optFns ...func(*Options)) (*DescribeFlywheelIterationOutput, error)

Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overviewin the Amazon Comprehend Developer Guide.

func (*Client) DescribeKeyPhrasesDetectionJob 

func (c *Client) DescribeKeyPhrasesDetectionJob(ctx context.Context, params *DescribeKeyPhrasesDetectionJobInput, optFns ...func(*Options)) (*DescribeKeyPhrasesDetectionJobOutput, error)

Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.

func (*Client) DescribePiiEntitiesDetectionJob 

func (c *Client) DescribePiiEntitiesDetectionJob(ctx context.Context, params *DescribePiiEntitiesDetectionJobInput, optFns ...func(*Options)) (*DescribePiiEntitiesDetectionJobOutput, error)

Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.

func (*Client) DescribeResourcePolicy 

func (c *Client) DescribeResourcePolicy(ctx context.Context, params *DescribeResourcePolicyInput, optFns ...func(*Options)) (*DescribeResourcePolicyOutput, error)

Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.

func (*Client) DescribeSentimentDetectionJob 

func (c *Client) DescribeSentimentDetectionJob(ctx context.Context, params *DescribeSentimentDetectionJobInput, optFns ...func(*Options)) (*DescribeSentimentDetectionJobOutput, error)

Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.

func (*Client) DescribeTargetedSentimentDetectionJob 

func (c *Client) DescribeTargetedSentimentDetectionJob(ctx context.Context, params *DescribeTargetedSentimentDetectionJobInput, optFns ...func(*Options)) (*DescribeTargetedSentimentDetectionJobOutput, error)

Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.

func (*Client) DescribeTopicsDetectionJob 

func (c *Client) DescribeTopicsDetectionJob(ctx context.Context, params *DescribeTopicsDetectionJobInput, optFns ...func(*Options)) (*DescribeTopicsDetectionJobOutput, error)

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.

func (*Client) DetectDominantLanguage 

func (c *Client) DetectDominantLanguage(ctx context.Context, params *DetectDominantLanguageInput, optFns ...func(*Options)) (*DetectDominantLanguageOutput, error)

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

func (*Client) DetectEntities 

func (c *Client) DetectEntities(ctx context.Context, params *DetectEntitiesInput, optFns ...func(*Options)) (*DetectEntitiesOutput, error)

Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.

When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entitiesin the Comprehend Developer Guide.

When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

If the system detects errors while processing a page in the input document, the API response includes an entry in Errors for each error.

If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documentsin the Comprehend Developer Guide.

func (*Client) DetectKeyPhrases 

func (c *Client) DetectKeyPhrases(ctx context.Context, params *DetectKeyPhrasesInput, optFns ...func(*Options)) (*DetectKeyPhrasesOutput, error)

Detects the key noun phrases found in the text.

func (*Client) DetectPiiEntities 

func (c *Client) DetectPiiEntities(ctx context.Context, params *DetectPiiEntitiesInput, optFns ...func(*Options)) (*DetectPiiEntitiesOutput, error)

Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.

func (*Client) DetectSentiment 

func (c *Client) DetectSentiment(ctx context.Context, params *DetectSentimentInput, optFns ...func(*Options)) (*DetectSentimentOutput, error)

Inspects text and returns an inference of the prevailing sentiment ( POSITIVE , NEUTRAL , MIXED , or NEGATIVE ).

func (*Client) DetectSyntax 

func (c *Client) DetectSyntax(ctx context.Context, params *DetectSyntaxInput, optFns ...func(*Options)) (*DetectSyntaxOutput, error)

Inspects text for syntax and the part of speech of words in the document. For more information, see Syntaxin the Comprehend Developer Guide.

func (*Client) DetectTargetedSentiment 

func (c *Client) DetectTargetedSentiment(ctx context.Context, params *DetectTargetedSentimentInput, optFns ...func(*Options)) (*DetectTargetedSentimentOutput, error)

Inspects the input text and returns a sentiment analysis for each entity identified in the text.

For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

func (*Client) DetectToxicContent 

func (c *Client) DetectToxicContent(ctx context.Context, params *DetectToxicContentInput, optFns ...func(*Options)) (*DetectToxicContentOutput, error)

Performs toxicity analysis on the list of text strings that you provide as input. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detectionin the Amazon Comprehend Developer Guide.

func (*Client) ImportModel 

func (c *Client) ImportModel(ctx context.Context, params *ImportModelInput, optFns ...func(*Options)) (*ImportModelOutput, error)

Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one.

If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it.

The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.

func (*Client) ListDatasets 

func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, optFns ...func(*Options)) (*ListDatasetsOutput, error)

List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overviewin the Amazon Comprehend Developer Guide.

func (*Client) ListDocumentClassificationJobs 

func (c *Client) ListDocumentClassificationJobs(ctx context.Context, params *ListDocumentClassificationJobsInput, optFns ...func(*Options)) (*ListDocumentClassificationJobsOutput, error)

Gets a list of the documentation classification jobs that you have submitted.

func (*Client) ListDocumentClassifierSummaries 

func (c *Client) ListDocumentClassifierSummaries(ctx context.Context, params *ListDocumentClassifierSummariesInput, optFns ...func(*Options)) (*ListDocumentClassifierSummariesOutput, error)

Gets a list of summaries of the document classifiers that you have created

func (*Client) ListDocumentClassifiers 

func (c *Client) ListDocumentClassifiers(ctx context.Context, params *ListDocumentClassifiersInput, optFns ...func(*Options)) (*ListDocumentClassifiersOutput, error)

Gets a list of the document classifiers that you have created.

func (*Client) ListDominantLanguageDetectionJobs 

func (c *Client) ListDominantLanguageDetectionJobs(ctx context.Context, params *ListDominantLanguageDetectionJobsInput, optFns ...func(*Options)) (*ListDominantLanguageDetectionJobsOutput, error)

Gets a list of the dominant language detection jobs that you have submitted.

func (*Client) ListEndpoints 

func (c *Client) ListEndpoints(ctx context.Context, params *ListEndpointsInput, optFns ...func(*Options)) (*ListEndpointsOutput, error)

Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.

func (*Client) ListEntitiesDetectionJobs 

func (c *Client) ListEntitiesDetectionJobs(ctx context.Context, params *ListEntitiesDetectionJobsInput, optFns ...func(*Options)) (*ListEntitiesDetectionJobsOutput, error)

Gets a list of the entity detection jobs that you have submitted.

func (*Client) ListEntityRecognizerSummaries 

func (c *Client) ListEntityRecognizerSummaries(ctx context.Context, params *ListEntityRecognizerSummariesInput, optFns ...func(*Options)) (*ListEntityRecognizerSummariesOutput, error)

Gets a list of summaries for the entity recognizers that you have created.

func (*Client) ListEntityRecognizers 

func (c *Client) ListEntityRecognizers(ctx context.Context, params *ListEntityRecognizersInput, optFns ...func(*Options)) (*ListEntityRecognizersOutput, error)

Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.

The results of this list are not in any particular order. Please get the list and sort locally if needed.

func (*Client) ListEventsDetectionJobs 

func (c *Client) ListEventsDetectionJobs(ctx context.Context, params *ListEventsDetectionJobsInput, optFns ...func(*Options)) (*ListEventsDetectionJobsOutput, error)

Gets a list of the events detection jobs that you have submitted.

func (*Client) ListFlywheelIterationHistory 

func (c *Client) ListFlywheelIterationHistory(ctx context.Context, params *ListFlywheelIterationHistoryInput, optFns ...func(*Options)) (*ListFlywheelIterationHistoryOutput, error)

Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overviewin the Amazon Comprehend Developer Guide.

func (*Client) ListFlywheels 

func (c *Client) ListFlywheels(ctx context.Context, params *ListFlywheelsInput, optFns ...func(*Options)) (*ListFlywheelsOutput, error)

Gets a list of the flywheels that you have created.

func (*Client) ListKeyPhrasesDetectionJobs 

func (c *Client) ListKeyPhrasesDetectionJobs(ctx context.Context, params *ListKeyPhrasesDetectionJobsInput, optFns ...func(*Options)) (*ListKeyPhrasesDetectionJobsOutput, error)

Get a list of key phrase detection jobs that you have submitted.

func (*Client) ListPiiEntitiesDetectionJobs 

func (c *Client) ListPiiEntitiesDetectionJobs(ctx context.Context, params *ListPiiEntitiesDetectionJobsInput, optFns ...func(*Options)) (*ListPiiEntitiesDetectionJobsOutput, error)

Gets a list of the PII entity detection jobs that you have submitted.

func (*Client) ListSentimentDetectionJobs 

func (c *Client) ListSentimentDetectionJobs(ctx context.Context, params *ListSentimentDetectionJobsInput, optFns ...func(*Options)) (*ListSentimentDetectionJobsOutput, error)

Gets a list of sentiment detection jobs that you have submitted.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists all tags associated with a given Amazon Comprehend resource.

func (*Client) ListTargetedSentimentDetectionJobs 

func (c *Client) ListTargetedSentimentDetectionJobs(ctx context.Context, params *ListTargetedSentimentDetectionJobsInput, optFns ...func(*Options)) (*ListTargetedSentimentDetectionJobsOutput, error)

Gets a list of targeted sentiment detection jobs that you have submitted.

func (*Client) ListTopicsDetectionJobs 

func (c *Client) ListTopicsDetectionJobs(ctx context.Context, params *ListTopicsDetectionJobsInput, optFns ...func(*Options)) (*ListTopicsDetectionJobsOutput, error)

Gets a list of the topic detection jobs that you have submitted.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutResourcePolicy 

func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error)

Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.

func (*Client) StartDocumentClassificationJob 

func (c *Client) StartDocumentClassificationJob(ctx context.Context, params *StartDocumentClassificationJobInput, optFns ...func(*Options)) (*StartDocumentClassificationJobOutput, error)

Starts an asynchronous document classification job using a custom classification model. Use the DescribeDocumentClassificationJob operation to track the progress of the job.

func (*Client) StartDominantLanguageDetectionJob 

func (c *Client) StartDominantLanguageDetectionJob(ctx context.Context, params *StartDominantLanguageDetectionJobInput, optFns ...func(*Options)) (*StartDominantLanguageDetectionJobOutput, error)

Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.

func (*Client) StartEntitiesDetectionJob 

func (c *Client) StartEntitiesDetectionJob(ctx context.Context, params *StartEntitiesDetectionJobInput, optFns ...func(*Options)) (*StartEntitiesDetectionJobOutput, error)

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.

func (*Client) StartEventsDetectionJob 

func (c *Client) StartEventsDetectionJob(ctx context.Context, params *StartEventsDetectionJobInput, optFns ...func(*Options)) (*StartEventsDetectionJobOutput, error)

Starts an asynchronous event detection job for a collection of documents.

func (*Client) StartFlywheelIteration 

func (c *Client) StartFlywheelIteration(ctx context.Context, params *StartFlywheelIterationInput, optFns ...func(*Options)) (*StartFlywheelIterationOutput, error)

Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overviewin the Amazon Comprehend Developer Guide.

func (*Client) StartKeyPhrasesDetectionJob 

func (c *Client) StartKeyPhrasesDetectionJob(ctx context.Context, params *StartKeyPhrasesDetectionJobInput, optFns ...func(*Options)) (*StartKeyPhrasesDetectionJobOutput, error)

Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.

func (*Client) StartPiiEntitiesDetectionJob 

func (c *Client) StartPiiEntitiesDetectionJob(ctx context.Context, params *StartPiiEntitiesDetectionJobInput, optFns ...func(*Options)) (*StartPiiEntitiesDetectionJobOutput, error)

Starts an asynchronous PII entity detection job for a collection of documents.

func (*Client) StartSentimentDetectionJob 

func (c *Client) StartSentimentDetectionJob(ctx context.Context, params *StartSentimentDetectionJobInput, optFns ...func(*Options)) (*StartSentimentDetectionJobOutput, error)

Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.

func (*Client) StartTargetedSentimentDetectionJob 

func (c *Client) StartTargetedSentimentDetectionJob(ctx context.Context, params *StartTargetedSentimentDetectionJobInput, optFns ...func(*Options)) (*StartTargetedSentimentDetectionJobOutput, error)

Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob operation to track the status of a job.

func (*Client) StartTopicsDetectionJob 

func (c *Client) StartTopicsDetectionJob(ctx context.Context, params *StartTopicsDetectionJobInput, optFns ...func(*Options)) (*StartTopicsDetectionJobOutput, error)

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

func (*Client) StopDominantLanguageDetectionJob 

func (c *Client) StopDominantLanguageDetectionJob(ctx context.Context, params *StopDominantLanguageDetectionJobInput, optFns ...func(*Options)) (*StopDominantLanguageDetectionJobOutput, error)

Stops a dominant language detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

func (*Client) StopEntitiesDetectionJob 

func (c *Client) StopEntitiesDetectionJob(ctx context.Context, params *StopEntitiesDetectionJobInput, optFns ...func(*Options)) (*StopEntitiesDetectionJobOutput, error)

Stops an entities detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

func (*Client) StopEventsDetectionJob 

func (c *Client) StopEventsDetectionJob(ctx context.Context, params *StopEventsDetectionJobInput, optFns ...func(*Options)) (*StopEventsDetectionJobOutput, error)

Stops an events detection job in progress.

func (*Client) StopKeyPhrasesDetectionJob 

func (c *Client) StopKeyPhrasesDetectionJob(ctx context.Context, params *StopKeyPhrasesDetectionJobInput, optFns ...func(*Options)) (*StopKeyPhrasesDetectionJobOutput, error)

Stops a key phrases detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

func (*Client) StopPiiEntitiesDetectionJob 

func (c *Client) StopPiiEntitiesDetectionJob(ctx context.Context, params *StopPiiEntitiesDetectionJobInput, optFns ...func(*Options)) (*StopPiiEntitiesDetectionJobOutput, error)

Stops a PII entities detection job in progress.

func (*Client) StopSentimentDetectionJob 

func (c *Client) StopSentimentDetectionJob(ctx context.Context, params *StopSentimentDetectionJobInput, optFns ...func(*Options)) (*StopSentimentDetectionJobOutput, error)

Stops a sentiment detection job in progress.

If the job state is IN_PROGRESS , the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

func (*Client) StopTargetedSentimentDetectionJob 

func (c *Client) StopTargetedSentimentDetectionJob(ctx context.Context, params *StopTargetedSentimentDetectionJobInput, optFns ...func(*Options)) (*StopTargetedSentimentDetectionJobOutput, error)

Stops a targeted sentiment detection job in progress.

If the job state is IN_PROGRESS , the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

func (*Client) StopTrainingDocumentClassifier 

func (c *Client) StopTrainingDocumentClassifier(ctx context.Context, params *StopTrainingDocumentClassifierInput, optFns ...func(*Options)) (*StopTrainingDocumentClassifierOutput, error)

Stops a document classifier training job while in progress.

If the training job state is TRAINING , the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED ; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

func (*Client) StopTrainingEntityRecognizer 

func (c *Client) StopTrainingEntityRecognizer(ctx context.Context, params *StopTrainingEntityRecognizerInput, optFns ...func(*Options)) (*StopTrainingEntityRecognizerOutput, error)

Stops an entity recognizer training job while in progress.

If the training job state is TRAINING , the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED ; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes a specific tag associated with an Amazon Comprehend resource.

func (*Client) UpdateEndpoint 

func (c *Client) UpdateEndpoint(ctx context.Context, params *UpdateEndpointInput, optFns ...func(*Options)) (*UpdateEndpointOutput, error)

Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.

func (*Client) UpdateFlywheel 

func (c *Client) UpdateFlywheel(ctx context.Context, params *UpdateFlywheelInput, optFns ...func(*Options)) (*UpdateFlywheelOutput, error)

Update the configuration information for an existing flywheel.

type ContainsPiiEntitiesInput 

type ContainsPiiEntitiesInput struct {

	// The language of the input documents.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// A UTF-8 text string. The maximum string size is 100 KB.
	//
	// This member is required.
	Text *string
	// contains filtered or unexported fields
}

type ContainsPiiEntitiesOutput 

type ContainsPiiEntitiesOutput struct {

	// The labels used in the document being analyzed. Individual labels represent
	// personally identifiable information (PII) entity types.
	Labels []types.EntityLabel

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDatasetInput 

type CreateDatasetInput struct {

	// Name of the dataset.
	//
	// This member is required.
	DatasetName *string

	// The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the
	// data.
	//
	// This member is required.
	FlywheelArn *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.
	//
	// This member is required.
	InputDataConfig *types.DatasetInputDataConfig

	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string

	// The dataset type. You can specify that the data in a dataset is for training
	// the model or for testing the model.
	DatasetType types.DatasetType

	// Description of the dataset.
	Description *string

	// Tags for the dataset.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDatasetOutput 

type CreateDatasetOutput struct {

	// The ARN of the dataset.
	DatasetArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDocumentClassifierInput 

type CreateDocumentClassifierInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	//
	// This member is required.
	DataAccessRoleArn *string

	// The name of the document classifier.
	//
	// This member is required.
	DocumentClassifierName *string

	// Specifies the format and location of the input data for the job.
	//
	// This member is required.
	InputDataConfig *types.DocumentClassifierInputDataConfig

	// 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.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string

	// Indicates the mode in which the classifier will be trained. The classifier can
	// be trained in multi-class (single-label) mode or multi-label mode. Multi-class
	// mode identifies a single class label for each document and multi-label mode
	// identifies one or more class labels for each document. Multiple labels for an
	// individual document are separated by a delimiter. The default delimiter between
	// labels is a pipe (|).
	Mode types.DocumentClassifierMode

	// ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
	// models. The ModelKmsKeyId can be either of the following formats:
	//
	//   - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//   - Amazon Resource Name (ARN) of a KMS Key:
	//   "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	ModelKmsKeyId *string

	// The resource-based policy to attach to your custom document classifier model.
	// You can use this policy to allow another Amazon Web Services account to import
	// your custom model.
	//
	// Provide your policy as a JSON body that you enter as a UTF-8 encoded string
	// without line breaks. To provide valid JSON, enclose the attribute names and
	// values in double quotes. If the JSON body is also enclosed in double quotes,
	// then you must escape the double quotes that are inside the policy:
	//
	//     "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
	//
	// To avoid escaping quotes, you can use single quotes to enclose the policy and
	// double quotes to enclose the JSON names and values:
	//
	//     '{"attribute": "value", "attribute": ["value"]}'
	ModelPolicy *string

	// Specifies the location for the output files from a custom classifier job. This
	// parameter is required for a request that creates a native document model.
	OutputDataConfig *types.DocumentClassifierOutputDataConfig

	// Tags to associate with the document classifier. A tag is a key-value pair that
	// adds as a metadata to a resource used by Amazon Comprehend. For example, a tag
	// with "Sales" as the key might be added to a resource to indicate its use by the
	// sales department.
	Tags []types.Tag

	// The version name given to the newly created classifier. Version names can have
	// a maximum of 256 characters. Alphanumeric characters, hyphens (-) and
	// underscores (_) are allowed. The version name must be unique among all models
	// with the same classifier name in the Amazon Web Services account/Amazon Web
	// Services Region.
	VersionName *string

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML compute
	// instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
	// the following formats:
	//
	//   - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//   - Amazon Resource Name (ARN) of a KMS Key:
	//   "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your custom classifier. For more
	// information, see [Amazon VPC].
	//
	// [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type CreateDocumentClassifierOutput 

type CreateDocumentClassifierOutput struct {

	// The Amazon Resource Name (ARN) that identifies the document classifier.
	DocumentClassifierArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateEndpointInput 

type CreateEndpointInput struct {

	//  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.
	//
	// This member is required.
	DesiredInferenceUnits *int32

	// This is the descriptive suffix that becomes part of the EndpointArn used for
	// all subsequent requests to this resource.
	//
	// This member is required.
	EndpointName *string

	// An idempotency token provided by the customer. If this token matches a previous
	// endpoint creation request, Amazon Comprehend will not return a
	// ResourceInUseException .
	ClientRequestToken *string

	// The Amazon Resource Name (ARN) of the 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

	// The Amazon Resource Number (ARN) of the model to which the endpoint will be
	// attached.
	ModelArn *string

	// 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 []types.Tag
	// contains filtered or unexported fields
}

type CreateEndpointOutput 

type CreateEndpointOutput struct {

	// The Amazon Resource Number (ARN) of the endpoint being created.
	EndpointArn *string

	// The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
	ModelArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateEntityRecognizerInput 

type CreateEntityRecognizerInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	//
	// This member is required.
	DataAccessRoleArn *string

	// Specifies the format and location of the input data. The S3 bucket containing
	// the input data must be located in the same Region as the entity recognizer being
	// created.
	//
	// This member is required.
	InputDataConfig *types.EntityRecognizerInputDataConfig

	//  You can specify any of the following languages: English ("en"), Spanish
	// ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If
	// you plan to use this entity recognizer with PDF, Word, or image input files, you
	// must specify English as the language. All training documents must be in the same
	// language.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// The name given to the newly created recognizer. Recognizer names can be a
	// maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores
	// (_) are allowed. The name must be unique in the account/Region.
	//
	// This member is required.
	RecognizerName *string

	//  A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string

	// ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
	// models. The ModelKmsKeyId can be either of the following formats:
	//
	//   - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//   - Amazon Resource Name (ARN) of a KMS Key:
	//   "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	ModelKmsKeyId *string

	// The JSON resource-based policy to attach to your custom entity recognizer
	// model. You can use this policy to allow another Amazon Web Services account to
	// import your custom model.
	//
	// Provide your JSON as a UTF-8 encoded string without line breaks. To provide
	// valid JSON for your policy, enclose the attribute names and values in double
	// quotes. If the JSON body is also enclosed in double quotes, then you must escape
	// the double quotes that are inside the policy:
	//
	//     "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
	//
	// To avoid escaping quotes, you can use single quotes to enclose the policy and
	// double quotes to enclose the JSON names and values:
	//
	//     '{"attribute": "value", "attribute": ["value"]}'
	ModelPolicy *string

	// Tags to associate with the entity recognizer. A tag is a key-value pair that
	// adds as a metadata to a resource used by Amazon Comprehend. For example, a tag
	// with "Sales" as the key might be added to a resource to indicate its use by the
	// sales department.
	Tags []types.Tag

	// The version name given to the newly created recognizer. Version names can be a
	// maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores
	// (_) are allowed. The version name must be unique among all models with the same
	// recognizer name in the account/Region.
	VersionName *string

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML compute
	// instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
	// the following formats:
	//
	//   - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//   - Amazon Resource Name (ARN) of a KMS Key:
	//   "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your custom entity recognizer. For
	// more information, see [Amazon VPC].
	//
	// [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type CreateEntityRecognizerOutput 

type CreateEntityRecognizerOutput struct {

	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	EntityRecognizerArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateFlywheelInput 

type CreateFlywheelInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// the permissions required to access the flywheel data in the data lake.
	//
	// This member is required.
	DataAccessRoleArn *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.
	//
	// This member is required.
	DataLakeS3Uri *string

	// Name for the flywheel.
	//
	// This member is required.
	FlywheelName *string

	// To associate an existing model with the flywheel, specify the Amazon Resource
	// Number (ARN) of the model version. Do not set TaskConfig or ModelType if you
	// specify an ActiveModelArn .
	ActiveModelArn *string

	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string

	// Data security configurations.
	DataSecurityConfig *types.DataSecurityConfig

	// The model type. You need to set ModelType if you are creating a flywheel for a
	// new model.
	ModelType types.ModelType

	// The tags to associate with this flywheel.
	Tags []types.Tag

	// Configuration about the model associated with the flywheel. You need to set
	// TaskConfig if you are creating a flywheel for a new model.
	TaskConfig *types.TaskConfig
	// contains filtered or unexported fields
}

type CreateFlywheelOutput 

type CreateFlywheelOutput struct {

	// The Amazon Resource Number (ARN) of the active model version.
	ActiveModelArn *string

	// The Amazon Resource Number (ARN) of the flywheel.
	FlywheelArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDocumentClassifierInput 

type DeleteDocumentClassifierInput struct {

	// The Amazon Resource Name (ARN) that identifies the document classifier.
	//
	// This member is required.
	DocumentClassifierArn *string
	// contains filtered or unexported fields
}

type DeleteDocumentClassifierOutput 

type DeleteDocumentClassifierOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteEndpointInput 

type DeleteEndpointInput struct {

	// The Amazon Resource Number (ARN) of the endpoint being deleted.
	//
	// This member is required.
	EndpointArn *string
	// contains filtered or unexported fields
}

type DeleteEndpointOutput 

type DeleteEndpointOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteEntityRecognizerInput 

type DeleteEntityRecognizerInput struct {

	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	//
	// This member is required.
	EntityRecognizerArn *string
	// contains filtered or unexported fields
}

type DeleteEntityRecognizerOutput 

type DeleteEntityRecognizerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteFlywheelInput 

type DeleteFlywheelInput struct {

	// The Amazon Resource Number (ARN) of the flywheel to delete.
	//
	// This member is required.
	FlywheelArn *string
	// contains filtered or unexported fields
}

type DeleteFlywheelOutput 

type DeleteFlywheelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteResourcePolicyInput 

type DeleteResourcePolicyInput struct {

	// The Amazon Resource Name (ARN) of the custom model version that has the policy
	// to delete.
	//
	// This member is required.
	ResourceArn *string

	// The revision ID of the policy to delete.
	PolicyRevisionId *string
	// contains filtered or unexported fields
}

type DeleteResourcePolicyOutput 

type DeleteResourcePolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDatasetInput 

type DescribeDatasetInput struct {

	// The ARN of the dataset.
	//
	// This member is required.
	DatasetArn *string
	// contains filtered or unexported fields
}

type DescribeDatasetOutput 

type DescribeDatasetOutput struct {

	// The dataset properties.
	DatasetProperties *types.DatasetProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDocumentClassificationJobInput 

type DescribeDocumentClassificationJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The
	// StartDocumentClassificationJob operation returns this identifier in its response.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DescribeDocumentClassificationJobOutput 

type DescribeDocumentClassificationJobOutput struct {

	// An object that describes the properties associated with the document
	// classification job.
	DocumentClassificationJobProperties *types.DocumentClassificationJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDocumentClassifierInput 

type DescribeDocumentClassifierInput struct {

	// The Amazon Resource Name (ARN) that identifies the document classifier. The
	// CreateDocumentClassifier operation returns this identifier in its response.
	//
	// This member is required.
	DocumentClassifierArn *string
	// contains filtered or unexported fields
}

type DescribeDocumentClassifierOutput 

type DescribeDocumentClassifierOutput struct {

	// An object that contains the properties associated with a document classifier.
	DocumentClassifierProperties *types.DocumentClassifierProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDominantLanguageDetectionJobInput 

type DescribeDominantLanguageDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The
	// StartDominantLanguageDetectionJob operation returns this identifier in its
	// response.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DescribeDominantLanguageDetectionJobOutput 

type DescribeDominantLanguageDetectionJobOutput struct {

	// An object that contains the properties associated with a dominant language
	// detection job.
	DominantLanguageDetectionJobProperties *types.DominantLanguageDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeEndpointInput 

type DescribeEndpointInput struct {

	// The Amazon Resource Number (ARN) of the endpoint being described.
	//
	// This member is required.
	EndpointArn *string
	// contains filtered or unexported fields
}

type DescribeEndpointOutput 

type DescribeEndpointOutput struct {

	// Describes information associated with the specific endpoint.
	EndpointProperties *types.EndpointProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeEntitiesDetectionJobInput 

type DescribeEntitiesDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The
	// StartEntitiesDetectionJob operation returns this identifier in its response.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DescribeEntitiesDetectionJobOutput 

type DescribeEntitiesDetectionJobOutput struct {

	// An object that contains the properties associated with an entities detection
	// job.
	EntitiesDetectionJobProperties *types.EntitiesDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeEntityRecognizerInput 

type DescribeEntityRecognizerInput struct {

	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	//
	// This member is required.
	EntityRecognizerArn *string
	// contains filtered or unexported fields
}

type DescribeEntityRecognizerOutput 

type DescribeEntityRecognizerOutput struct {

	// Describes information associated with an entity recognizer.
	EntityRecognizerProperties *types.EntityRecognizerProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeEventsDetectionJobInput 

type DescribeEventsDetectionJobInput struct {

	// The identifier of the events detection job.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DescribeEventsDetectionJobOutput 

type DescribeEventsDetectionJobOutput struct {

	// An object that contains the properties associated with an event detection job.
	EventsDetectionJobProperties *types.EventsDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeFlywheelInput 

type DescribeFlywheelInput struct {

	// The Amazon Resource Number (ARN) of the flywheel.
	//
	// This member is required.
	FlywheelArn *string
	// contains filtered or unexported fields
}

type DescribeFlywheelIterationInput 

type DescribeFlywheelIterationInput struct {

	//
	//
	// This member is required.
	FlywheelArn *string

	//
	//
	// This member is required.
	FlywheelIterationId *string
	// contains filtered or unexported fields
}

type DescribeFlywheelIterationOutput 

type DescribeFlywheelIterationOutput struct {

	// The configuration properties of a flywheel iteration.
	FlywheelIterationProperties *types.FlywheelIterationProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeFlywheelOutput 

type DescribeFlywheelOutput struct {

	// The flywheel properties.
	FlywheelProperties *types.FlywheelProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeKeyPhrasesDetectionJobInput 

type DescribeKeyPhrasesDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The
	// StartKeyPhrasesDetectionJob operation returns this identifier in its response.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DescribeKeyPhrasesDetectionJobOutput 

type DescribeKeyPhrasesDetectionJobOutput struct {

	// An object that contains the properties associated with a key phrases detection
	// job.
	KeyPhrasesDetectionJobProperties *types.KeyPhrasesDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribePiiEntitiesDetectionJobInput 

type DescribePiiEntitiesDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The operation
	// returns this identifier in its response.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DescribePiiEntitiesDetectionJobOutput 

type DescribePiiEntitiesDetectionJobOutput struct {

	// Provides information about a PII entities detection job.
	PiiEntitiesDetectionJobProperties *types.PiiEntitiesDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeResourcePolicyInput 

type DescribeResourcePolicyInput struct {

	// The Amazon Resource Name (ARN) of the custom model version that has the
	// resource policy.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type DescribeResourcePolicyOutput 

type DescribeResourcePolicyOutput struct {

	// The time at which the policy was created.
	CreationTime *time.Time

	// The time at which the policy was last modified.
	LastModifiedTime *time.Time

	// The revision ID of the policy. Each time you modify a policy, Amazon Comprehend
	// assigns a new revision ID, and it deletes the prior version of the policy.
	PolicyRevisionId *string

	// The JSON body of the resource-based policy.
	ResourcePolicy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeSentimentDetectionJobInput 

type DescribeSentimentDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The operation
	// returns this identifier in its response.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DescribeSentimentDetectionJobOutput 

type DescribeSentimentDetectionJobOutput struct {

	// An object that contains the properties associated with a sentiment detection
	// job.
	SentimentDetectionJobProperties *types.SentimentDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeTargetedSentimentDetectionJobInput 

type DescribeTargetedSentimentDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The
	// StartTargetedSentimentDetectionJob operation returns this identifier in its
	// response.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DescribeTargetedSentimentDetectionJobOutput 

type DescribeTargetedSentimentDetectionJobOutput struct {

	// An object that contains the properties associated with a targeted sentiment
	// detection job.
	TargetedSentimentDetectionJobProperties *types.TargetedSentimentDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeTopicsDetectionJobInput 

type DescribeTopicsDetectionJobInput struct {

	// The identifier assigned by the user to the detection job.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DescribeTopicsDetectionJobOutput 

type DescribeTopicsDetectionJobOutput struct {

	// The list of properties for the requested job.
	TopicsDetectionJobProperties *types.TopicsDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetectDominantLanguageInput 

type DetectDominantLanguageInput struct {

	// A UTF-8 text string. The string must contain at least 20 characters. The
	// maximum string size is 100 KB.
	//
	// This member is required.
	Text *string
	// contains filtered or unexported fields
}

type DetectDominantLanguageOutput 

type DetectDominantLanguageOutput struct {

	// Array of languages that Amazon Comprehend detected in the input text. The array
	// is sorted in descending order of the score (the dominant language is always the
	// first element in the array).
	//
	// For each language, the response returns the RFC 5646 language code and the
	// level of confidence that Amazon Comprehend has in the accuracy of its inference.
	// For more information about RFC 5646, see [Tags for Identifying Languages]on the IETF Tools web site.
	//
	// [Tags for Identifying Languages]: https://tools.ietf.org/html/rfc5646
	Languages []types.DominantLanguage

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetectEntitiesInput 

type DetectEntitiesInput struct {

	// This field applies only when you use a custom entity recognition model that was
	// trained with PDF annotations. For other cases, enter your text input in the Text
	// field.
	//
	// Use the Bytes parameter to input a text, PDF, Word or image file. Using a
	// plain-text file in the Bytes parameter is equivelent to using the Text
	// parameter (the Entities field in the response is identical).
	//
	// You can also use the Bytes parameter to input an Amazon Textract
	// DetectDocumentText or AnalyzeDocument output file.
	//
	// Provide the input document as a sequence of base64-encoded bytes. If your code
	// uses an Amazon Web Services SDK to detect entities, the SDK may encode the
	// document file bytes for you.
	//
	// The maximum length of this field depends on the input document type. For
	// details, see [Inputs for real-time custom analysis]in the Comprehend Developer Guide.
	//
	// If you use the Bytes parameter, do not use the Text parameter.
	//
	// [Inputs for real-time custom analysis]: https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html
	Bytes []byte

	// Provides configuration parameters to override the default actions for
	// extracting text from PDF documents and image files.
	DocumentReaderConfig *types.DocumentReaderConfig

	// The Amazon Resource Name of an endpoint that is associated with a custom entity
	// recognition model. Provide an endpoint if you want to detect entities by using
	// your own custom model instead of the default model that is used by Amazon
	// Comprehend.
	//
	// If you specify an endpoint, Amazon Comprehend uses the language of your custom
	// model, and it ignores any language code that you provide in your request.
	//
	// For information about endpoints, see [Managing endpoints].
	//
	// [Managing endpoints]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
	EndpointArn *string

	// The language of the input documents. You can specify any of the primary
	// languages supported by Amazon Comprehend. If your request includes the endpoint
	// for a custom entity recognition model, Amazon Comprehend uses the language of
	// your custom model, and it ignores any language code that you specify here.
	//
	// All input documents must be in the same language.
	LanguageCode types.LanguageCode

	// A UTF-8 text string. The maximum string size is 100 KB. If you enter text using
	// this parameter, do not use the Bytes parameter.
	Text *string
	// contains filtered or unexported fields
}

type DetectEntitiesOutput 

type DetectEntitiesOutput struct {

	// Information about each block of text in the input document. Blocks are nested.
	// A page block contains a block for each line of text, which contains a block for
	// each word.
	//
	// The Block content for a Word input document does not include a Geometry field.
	//
	// The Block field is not present in the response for plain-text inputs.
	Blocks []types.Block

	// Information about the document, discovered during text extraction. This field
	// is present in the response only if your request used the Byte parameter.
	DocumentMetadata *types.DocumentMetadata

	// The document type for each page in the input document. This field is present in
	// the response only if your request used the Byte parameter.
	DocumentType []types.DocumentTypeListItem

	// A collection of entities identified in the input text. For each entity, the
	// response provides the entity text, entity type, where the entity text begins and
	// ends, and the level of confidence that Amazon Comprehend has in the detection.
	//
	// If your request uses a custom entity recognition model, Amazon Comprehend
	// detects the entities that the model is trained to recognize. Otherwise, it
	// detects the default entity types. For a list of default entity types, see [Entities]in
	// the Comprehend Developer Guide.
	//
	// [Entities]: https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html
	Entities []types.Entity

	// Page-level errors that the system detected while processing the input document.
	// The field is empty if the system encountered no errors.
	Errors []types.ErrorsListItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetectKeyPhrasesInput 

type DetectKeyPhrasesInput struct {

	// The language of the input documents. You can specify any of the primary
	// languages supported by Amazon Comprehend. All documents must be in the same
	// language.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded
	// characters.
	//
	// This member is required.
	Text *string
	// contains filtered or unexported fields
}

type DetectKeyPhrasesOutput 

type DetectKeyPhrasesOutput struct {

	// A collection of key phrases that Amazon Comprehend identified in the input
	// text. For each key phrase, the response provides the text of the key phrase,
	// where the key phrase begins and ends, and the level of confidence that Amazon
	// Comprehend has in the accuracy of the detection.
	KeyPhrases []types.KeyPhrase

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetectPiiEntitiesInput 

type DetectPiiEntitiesInput struct {

	// The language of the input text. Enter the language code for English (en) or
	// Spanish (es).
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// A UTF-8 text string. The maximum string size is 100 KB.
	//
	// This member is required.
	Text *string
	// contains filtered or unexported fields
}

type DetectPiiEntitiesOutput 

type DetectPiiEntitiesOutput struct {

	// A collection of PII entities identified in the input text. For each entity, the
	// response provides the entity type, where the entity text begins and ends, and
	// the level of confidence that Amazon Comprehend has in the detection.
	Entities []types.PiiEntity

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetectSentimentInput 

type DetectSentimentInput struct {

	// The language of the input documents. You can specify any of the primary
	// languages supported by Amazon Comprehend. All documents must be in the same
	// language.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// A UTF-8 text string. The maximum string size is 5 KB.
	//
	// This member is required.
	Text *string
	// contains filtered or unexported fields
}

type DetectSentimentOutput 

type DetectSentimentOutput struct {

	// The inferred sentiment that Amazon Comprehend has the highest level of
	// confidence in.
	Sentiment types.SentimentType

	// An object that lists the sentiments, and their corresponding confidence levels.
	SentimentScore *types.SentimentScore

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetectSyntaxInput 

type DetectSyntaxInput struct {

	// The language code of the input documents. You can specify any of the following
	// languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish
	// ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt").
	//
	// This member is required.
	LanguageCode types.SyntaxLanguageCode

	// A UTF-8 string. The maximum string size is 5 KB.
	//
	// This member is required.
	Text *string
	// contains filtered or unexported fields
}

type DetectSyntaxOutput 

type DetectSyntaxOutput struct {

	// A collection of syntax tokens describing the text. For each token, the response
	// provides the text, the token type, where the text begins and ends, and the level
	// of confidence that Amazon Comprehend has that the token is correct. For a list
	// of token types, see [Syntax]in the Comprehend Developer Guide.
	//
	// [Syntax]: https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html
	SyntaxTokens []types.SyntaxToken

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetectTargetedSentimentInput 

type DetectTargetedSentimentInput struct {

	// The language of the input documents. Currently, English is the only supported
	// language.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// A UTF-8 text string. The maximum string length is 5 KB.
	//
	// This member is required.
	Text *string
	// contains filtered or unexported fields
}

type DetectTargetedSentimentOutput 

type DetectTargetedSentimentOutput struct {

	// Targeted sentiment analysis for each of the entities identified in the input
	// text.
	Entities []types.TargetedSentimentEntity

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetectToxicContentInput 

type DetectToxicContentInput struct {

	// The language of the input text. Currently, English is the only supported
	// language.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// A list of up to 10 text strings. Each string has a maximum size of 1 KB, and
	// the maximum size of the list is 10 KB.
	//
	// This member is required.
	TextSegments []types.TextSegment
	// contains filtered or unexported fields
}

type DetectToxicContentOutput 

type DetectToxicContentOutput struct {

	// Results of the content moderation analysis. Each entry in the results list
	// contains a list of toxic content types identified in the text, along with a
	// confidence score for each content type. The results list also includes a
	// toxicity score for each entry in the results list.
	ResultList []types.ToxicLabels

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ImportModelInput 

type ImportModelInput struct {

	// The Amazon Resource Name (ARN) of the custom model to import.
	//
	// This member is required.
	SourceModelArn *string

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the
	// custom model.
	DataAccessRoleArn *string

	// ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
	// models. The ModelKmsKeyId can be either of the following formats:
	//
	//   - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//   - Amazon Resource Name (ARN) of a KMS Key:
	//   "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	ModelKmsKeyId *string

	// The name to assign to the custom model that is created in Amazon Comprehend by
	// this import.
	ModelName *string

	// 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.
	Tags []types.Tag

	// The version name given to the custom model that is created by this import.
	// Version names can have a maximum of 256 characters. Alphanumeric characters,
	// hyphens (-) and underscores (_) are allowed. The version name must be unique
	// among all models with the same classifier name in the account/Region.
	VersionName *string
	// contains filtered or unexported fields
}

type ImportModelOutput 

type ImportModelOutput struct {

	// The Amazon Resource Name (ARN) of the custom model being imported.
	ModelArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDatasetsAPIClient 

type ListDatasetsAPIClient interface {
	ListDatasets(context.Context, *ListDatasetsInput, ...func(*Options)) (*ListDatasetsOutput, error)
}

ListDatasetsAPIClient is a client that implements the ListDatasets operation.

type ListDatasetsInput 

type ListDatasetsInput struct {

	// Filters the datasets to be returned in the response.
	Filter *types.DatasetFilter

	// The Amazon Resource Number (ARN) of the flywheel.
	FlywheelArn *string

	// Maximum number of results to return in a response. The default is 100.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDatasetsOutput 

type ListDatasetsOutput struct {

	// The dataset properties list.
	DatasetPropertiesList []types.DatasetProperties

	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDatasetsPaginator 

type ListDatasetsPaginator struct {
	// contains filtered or unexported fields
}

ListDatasetsPaginator is a paginator for ListDatasets

func NewListDatasetsPaginator 

func NewListDatasetsPaginator(client ListDatasetsAPIClient, params *ListDatasetsInput, optFns ...func(*ListDatasetsPaginatorOptions)) *ListDatasetsPaginator

NewListDatasetsPaginator returns a new ListDatasetsPaginator

func (*ListDatasetsPaginator) HasMorePages 

func (p *ListDatasetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDatasetsPaginator) NextPage 

func (p *ListDatasetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatasetsOutput, error)

NextPage retrieves the next ListDatasets page.

type ListDatasetsPaginatorOptions 

type ListDatasetsPaginatorOptions struct {
	// Maximum number of results to return in a response. The default is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDatasetsPaginatorOptions is the paginator options for ListDatasets

type ListDocumentClassificationJobsAPIClient 

type ListDocumentClassificationJobsAPIClient interface {
	ListDocumentClassificationJobs(context.Context, *ListDocumentClassificationJobsInput, ...func(*Options)) (*ListDocumentClassificationJobsOutput, error)
}

ListDocumentClassificationJobsAPIClient is a client that implements the ListDocumentClassificationJobs operation.

type ListDocumentClassificationJobsInput 

type ListDocumentClassificationJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their names, status,
	// or the date and time that they were submitted. You can only set one filter at a
	// time.
	Filter *types.DocumentClassificationJobFilter

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDocumentClassificationJobsOutput 

type ListDocumentClassificationJobsOutput struct {

	// A list containing the properties of each job returned.
	DocumentClassificationJobPropertiesList []types.DocumentClassificationJobProperties

	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDocumentClassificationJobsPaginator 

type ListDocumentClassificationJobsPaginator struct {
	// contains filtered or unexported fields
}

ListDocumentClassificationJobsPaginator is a paginator for ListDocumentClassificationJobs

func NewListDocumentClassificationJobsPaginator 

func NewListDocumentClassificationJobsPaginator(client ListDocumentClassificationJobsAPIClient, params *ListDocumentClassificationJobsInput, optFns ...func(*ListDocumentClassificationJobsPaginatorOptions)) *ListDocumentClassificationJobsPaginator

NewListDocumentClassificationJobsPaginator returns a new ListDocumentClassificationJobsPaginator

func (*ListDocumentClassificationJobsPaginator) HasMorePages 

func (p *ListDocumentClassificationJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDocumentClassificationJobsPaginator) NextPage 

func (p *ListDocumentClassificationJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDocumentClassificationJobsOutput, error)

NextPage retrieves the next ListDocumentClassificationJobs page.

type ListDocumentClassificationJobsPaginatorOptions 

type ListDocumentClassificationJobsPaginatorOptions struct {
	// The maximum number of results to return in each page. The default is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDocumentClassificationJobsPaginatorOptions is the paginator options for ListDocumentClassificationJobs

type ListDocumentClassifierSummariesAPIClient 

type ListDocumentClassifierSummariesAPIClient interface {
	ListDocumentClassifierSummaries(context.Context, *ListDocumentClassifierSummariesInput, ...func(*Options)) (*ListDocumentClassifierSummariesOutput, error)
}

ListDocumentClassifierSummariesAPIClient is a client that implements the ListDocumentClassifierSummaries operation.

type ListDocumentClassifierSummariesInput 

type ListDocumentClassifierSummariesInput struct {

	// The maximum number of results to return on each page. The default is 100.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDocumentClassifierSummariesOutput 

type ListDocumentClassifierSummariesOutput struct {

	// The list of summaries of document classifiers.
	DocumentClassifierSummariesList []types.DocumentClassifierSummary

	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDocumentClassifierSummariesPaginator 

type ListDocumentClassifierSummariesPaginator struct {
	// contains filtered or unexported fields
}

ListDocumentClassifierSummariesPaginator is a paginator for ListDocumentClassifierSummaries

func NewListDocumentClassifierSummariesPaginator 

func NewListDocumentClassifierSummariesPaginator(client ListDocumentClassifierSummariesAPIClient, params *ListDocumentClassifierSummariesInput, optFns ...func(*ListDocumentClassifierSummariesPaginatorOptions)) *ListDocumentClassifierSummariesPaginator

NewListDocumentClassifierSummariesPaginator returns a new ListDocumentClassifierSummariesPaginator

func (*ListDocumentClassifierSummariesPaginator) HasMorePages 

func (p *ListDocumentClassifierSummariesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDocumentClassifierSummariesPaginator) NextPage 

func (p *ListDocumentClassifierSummariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDocumentClassifierSummariesOutput, error)

NextPage retrieves the next ListDocumentClassifierSummaries page.

type ListDocumentClassifierSummariesPaginatorOptions 

type ListDocumentClassifierSummariesPaginatorOptions struct {
	// The maximum number of results to return on each page. The default is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDocumentClassifierSummariesPaginatorOptions is the paginator options for ListDocumentClassifierSummaries

type ListDocumentClassifiersAPIClient 

type ListDocumentClassifiersAPIClient interface {
	ListDocumentClassifiers(context.Context, *ListDocumentClassifiersInput, ...func(*Options)) (*ListDocumentClassifiersOutput, error)
}

ListDocumentClassifiersAPIClient is a client that implements the ListDocumentClassifiers operation.

type ListDocumentClassifiersInput 

type ListDocumentClassifiersInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter at a
	// time.
	Filter *types.DocumentClassifierFilter

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDocumentClassifiersOutput 

type ListDocumentClassifiersOutput struct {

	// A list containing the properties of each job returned.
	DocumentClassifierPropertiesList []types.DocumentClassifierProperties

	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDocumentClassifiersPaginator 

type ListDocumentClassifiersPaginator struct {
	// contains filtered or unexported fields
}

ListDocumentClassifiersPaginator is a paginator for ListDocumentClassifiers

func NewListDocumentClassifiersPaginator 

func NewListDocumentClassifiersPaginator(client ListDocumentClassifiersAPIClient, params *ListDocumentClassifiersInput, optFns ...func(*ListDocumentClassifiersPaginatorOptions)) *ListDocumentClassifiersPaginator

NewListDocumentClassifiersPaginator returns a new ListDocumentClassifiersPaginator

func (*ListDocumentClassifiersPaginator) HasMorePages 

func (p *ListDocumentClassifiersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDocumentClassifiersPaginator) NextPage 

func (p *ListDocumentClassifiersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDocumentClassifiersOutput, error)

NextPage retrieves the next ListDocumentClassifiers page.

type ListDocumentClassifiersPaginatorOptions 

type ListDocumentClassifiersPaginatorOptions struct {
	// The maximum number of results to return in each page. The default is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDocumentClassifiersPaginatorOptions is the paginator options for ListDocumentClassifiers

type ListDominantLanguageDetectionJobsAPIClient 

type ListDominantLanguageDetectionJobsAPIClient interface {
	ListDominantLanguageDetectionJobs(context.Context, *ListDominantLanguageDetectionJobsInput, ...func(*Options)) (*ListDominantLanguageDetectionJobsOutput, error)
}

ListDominantLanguageDetectionJobsAPIClient is a client that implements the ListDominantLanguageDetectionJobs operation.

type ListDominantLanguageDetectionJobsInput 

type ListDominantLanguageDetectionJobsInput struct {

	// Filters that jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter at a
	// time.
	Filter *types.DominantLanguageDetectionJobFilter

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDominantLanguageDetectionJobsOutput 

type ListDominantLanguageDetectionJobsOutput struct {

	// A list containing the properties of each job that is returned.
	DominantLanguageDetectionJobPropertiesList []types.DominantLanguageDetectionJobProperties

	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDominantLanguageDetectionJobsPaginator 

type ListDominantLanguageDetectionJobsPaginator struct {
	// contains filtered or unexported fields
}

ListDominantLanguageDetectionJobsPaginator is a paginator for ListDominantLanguageDetectionJobs

func NewListDominantLanguageDetectionJobsPaginator 

func NewListDominantLanguageDetectionJobsPaginator(client ListDominantLanguageDetectionJobsAPIClient, params *ListDominantLanguageDetectionJobsInput, optFns ...func(*ListDominantLanguageDetectionJobsPaginatorOptions)) *ListDominantLanguageDetectionJobsPaginator

NewListDominantLanguageDetectionJobsPaginator returns a new ListDominantLanguageDetectionJobsPaginator

func (*ListDominantLanguageDetectionJobsPaginator) HasMorePages 

func (p *ListDominantLanguageDetectionJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDominantLanguageDetectionJobsPaginator) NextPage 

func (p *ListDominantLanguageDetectionJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDominantLanguageDetectionJobsOutput, error)

NextPage retrieves the next ListDominantLanguageDetectionJobs page.

type ListDominantLanguageDetectionJobsPaginatorOptions 

type ListDominantLanguageDetectionJobsPaginatorOptions struct {
	// The maximum number of results to return in each page. The default is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDominantLanguageDetectionJobsPaginatorOptions is the paginator options for ListDominantLanguageDetectionJobs

type ListEndpointsAPIClient 

type ListEndpointsAPIClient interface {
	ListEndpoints(context.Context, *ListEndpointsInput, ...func(*Options)) (*ListEndpointsOutput, error)
}

ListEndpointsAPIClient is a client that implements the ListEndpoints operation.

type ListEndpointsInput 

type ListEndpointsInput struct {

	// Filters the endpoints that are returned. You can filter endpoints on their
	// name, model, status, or the date and time that they were created. You can only
	// set one filter at a time.
	Filter *types.EndpointFilter

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEndpointsOutput 

type ListEndpointsOutput struct {

	// Displays a list of endpoint properties being retrieved by the service in
	// response to the request.
	EndpointPropertiesList []types.EndpointProperties

	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListEndpointsPaginator 

type ListEndpointsPaginator struct {
	// contains filtered or unexported fields
}

ListEndpointsPaginator is a paginator for ListEndpoints

func NewListEndpointsPaginator 

func NewListEndpointsPaginator(client ListEndpointsAPIClient, params *ListEndpointsInput, optFns ...func(*ListEndpointsPaginatorOptions)) *ListEndpointsPaginator

NewListEndpointsPaginator returns a new ListEndpointsPaginator

func (*ListEndpointsPaginator) HasMorePages 

func (p *ListEndpointsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEndpointsPaginator) NextPage 

func (p *ListEndpointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEndpointsOutput, error)

NextPage retrieves the next ListEndpoints page.

type ListEndpointsPaginatorOptions 

type ListEndpointsPaginatorOptions struct {
	// The maximum number of results to return in each page. The default is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListEndpointsPaginatorOptions is the paginator options for ListEndpoints

type ListEntitiesDetectionJobsAPIClient 

type ListEntitiesDetectionJobsAPIClient interface {
	ListEntitiesDetectionJobs(context.Context, *ListEntitiesDetectionJobsInput, ...func(*Options)) (*ListEntitiesDetectionJobsOutput, error)
}

ListEntitiesDetectionJobsAPIClient is a client that implements the ListEntitiesDetectionJobs operation.

type ListEntitiesDetectionJobsInput 

type ListEntitiesDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter at a
	// time.
	Filter *types.EntitiesDetectionJobFilter

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEntitiesDetectionJobsOutput 

type ListEntitiesDetectionJobsOutput struct {

	// A list containing the properties of each job that is returned.
	EntitiesDetectionJobPropertiesList []types.EntitiesDetectionJobProperties

	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListEntitiesDetectionJobsPaginator 

type ListEntitiesDetectionJobsPaginator struct {
	// contains filtered or unexported fields
}

ListEntitiesDetectionJobsPaginator is a paginator for ListEntitiesDetectionJobs

func NewListEntitiesDetectionJobsPaginator 

func NewListEntitiesDetectionJobsPaginator(client ListEntitiesDetectionJobsAPIClient, params *ListEntitiesDetectionJobsInput, optFns ...func(*ListEntitiesDetectionJobsPaginatorOptions)) *ListEntitiesDetectionJobsPaginator

NewListEntitiesDetectionJobsPaginator returns a new ListEntitiesDetectionJobsPaginator

func (*ListEntitiesDetectionJobsPaginator) HasMorePages 

func (p *ListEntitiesDetectionJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEntitiesDetectionJobsPaginator) NextPage 

func (p *ListEntitiesDetectionJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEntitiesDetectionJobsOutput, error)

NextPage retrieves the next ListEntitiesDetectionJobs page.

type ListEntitiesDetectionJobsPaginatorOptions 

type ListEntitiesDetectionJobsPaginatorOptions struct {
	// The maximum number of results to return in each page. The default is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListEntitiesDetectionJobsPaginatorOptions is the paginator options for ListEntitiesDetectionJobs

type ListEntityRecognizerSummariesAPIClient 

type ListEntityRecognizerSummariesAPIClient interface {
	ListEntityRecognizerSummaries(context.Context, *ListEntityRecognizerSummariesInput, ...func(*Options)) (*ListEntityRecognizerSummariesOutput, error)
}

ListEntityRecognizerSummariesAPIClient is a client that implements the ListEntityRecognizerSummaries operation.

type ListEntityRecognizerSummariesInput 

type ListEntityRecognizerSummariesInput struct {

	// The maximum number of results to return on each page. The default is 100.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEntityRecognizerSummariesOutput 

type ListEntityRecognizerSummariesOutput struct {

	// The list entity recognizer summaries.
	EntityRecognizerSummariesList []types.EntityRecognizerSummary

	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListEntityRecognizerSummariesPaginator 

type ListEntityRecognizerSummariesPaginator struct {
	// contains filtered or unexported fields
}

ListEntityRecognizerSummariesPaginator is a paginator for ListEntityRecognizerSummaries

func NewListEntityRecognizerSummariesPaginator 

func NewListEntityRecognizerSummariesPaginator(client ListEntityRecognizerSummariesAPIClient, params *ListEntityRecognizerSummariesInput, optFns ...func(*ListEntityRecognizerSummariesPaginatorOptions)) *ListEntityRecognizerSummariesPaginator

NewListEntityRecognizerSummariesPaginator returns a new ListEntityRecognizerSummariesPaginator

func (*ListEntityRecognizerSummariesPaginator) HasMorePages 

func (p *ListEntityRecognizerSummariesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEntityRecognizerSummariesPaginator) NextPage 

func (p *ListEntityRecognizerSummariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEntityRecognizerSummariesOutput, error)

NextPage retrieves the next ListEntityRecognizerSummaries page.

type ListEntityRecognizerSummariesPaginatorOptions 

type ListEntityRecognizerSummariesPaginatorOptions struct {
	// The maximum number of results to return on each page. The default is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListEntityRecognizerSummariesPaginatorOptions is the paginator options for ListEntityRecognizerSummaries

type ListEntityRecognizersAPIClient 

type ListEntityRecognizersAPIClient interface {
	ListEntityRecognizers(context.Context, *ListEntityRecognizersInput, ...func(*Options)) (*ListEntityRecognizersOutput, error)
}

ListEntityRecognizersAPIClient is a client that implements the ListEntityRecognizers operation.

type ListEntityRecognizersInput 

type ListEntityRecognizersInput struct {

	// Filters the list of entities returned. You can filter on Status ,
	// SubmitTimeBefore , or SubmitTimeAfter . You can only set one filter at a time.
	Filter *types.EntityRecognizerFilter

	//  The maximum number of results to return on each page. The default is 100.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEntityRecognizersOutput 

type ListEntityRecognizersOutput struct {

	// The list of properties of an entity recognizer.
	EntityRecognizerPropertiesList []types.EntityRecognizerProperties

	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListEntityRecognizersPaginator 

type ListEntityRecognizersPaginator struct {
	// contains filtered or unexported fields
}

ListEntityRecognizersPaginator is a paginator for ListEntityRecognizers

func NewListEntityRecognizersPaginator 

func NewListEntityRecognizersPaginator(client ListEntityRecognizersAPIClient, params *ListEntityRecognizersInput, optFns ...func(*ListEntityRecognizersPaginatorOptions)) *ListEntityRecognizersPaginator

NewListEntityRecognizersPaginator returns a new ListEntityRecognizersPaginator

func (*ListEntityRecognizersPaginator) HasMorePages 

func (p *ListEntityRecognizersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEntityRecognizersPaginator) NextPage 

func (p *ListEntityRecognizersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEntityRecognizersOutput, error)

NextPage retrieves the next ListEntityRecognizers page.

type ListEntityRecognizersPaginatorOptions 

type ListEntityRecognizersPaginatorOptions struct {
	//  The maximum number of results to return on each page. The default is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListEntityRecognizersPaginatorOptions is the paginator options for ListEntityRecognizers

type ListEventsDetectionJobsAPIClient 

type ListEventsDetectionJobsAPIClient interface {
	ListEventsDetectionJobs(context.Context, *ListEventsDetectionJobsInput, ...func(*Options)) (*ListEventsDetectionJobsOutput, error)
}

ListEventsDetectionJobsAPIClient is a client that implements the ListEventsDetectionJobs operation.

type ListEventsDetectionJobsInput 

type ListEventsDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter at a
	// time.
	Filter *types.EventsDetectionJobFilter

	// The maximum number of results to return in each page.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEventsDetectionJobsOutput 

type ListEventsDetectionJobsOutput struct {

	// A list containing the properties of each job that is returned.
	EventsDetectionJobPropertiesList []types.EventsDetectionJobProperties

	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListEventsDetectionJobsPaginator 

type ListEventsDetectionJobsPaginator struct {
	// contains filtered or unexported fields
}

ListEventsDetectionJobsPaginator is a paginator for ListEventsDetectionJobs

func NewListEventsDetectionJobsPaginator 

func NewListEventsDetectionJobsPaginator(client ListEventsDetectionJobsAPIClient, params *ListEventsDetectionJobsInput, optFns ...func(*ListEventsDetectionJobsPaginatorOptions)) *ListEventsDetectionJobsPaginator

NewListEventsDetectionJobsPaginator returns a new ListEventsDetectionJobsPaginator

func (*ListEventsDetectionJobsPaginator) HasMorePages 

func (p *ListEventsDetectionJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEventsDetectionJobsPaginator) NextPage 

func (p *ListEventsDetectionJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEventsDetectionJobsOutput, error)

NextPage retrieves the next ListEventsDetectionJobs page.

type ListEventsDetectionJobsPaginatorOptions 

type ListEventsDetectionJobsPaginatorOptions struct {
	// The maximum number of results to return in each page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListEventsDetectionJobsPaginatorOptions is the paginator options for ListEventsDetectionJobs

type ListFlywheelIterationHistoryAPIClient 

type ListFlywheelIterationHistoryAPIClient interface {
	ListFlywheelIterationHistory(context.Context, *ListFlywheelIterationHistoryInput, ...func(*Options)) (*ListFlywheelIterationHistoryOutput, error)
}

ListFlywheelIterationHistoryAPIClient is a client that implements the ListFlywheelIterationHistory operation.

type ListFlywheelIterationHistoryInput 

type ListFlywheelIterationHistoryInput struct {

	// The ARN of the flywheel.
	//
	// This member is required.
	FlywheelArn *string

	// Filter the flywheel iteration history based on creation time.
	Filter *types.FlywheelIterationFilter

	// Maximum number of iteration history results to return
	MaxResults *int32

	// Next token
	NextToken *string
	// contains filtered or unexported fields
}

type ListFlywheelIterationHistoryOutput 

type ListFlywheelIterationHistoryOutput struct {

	// List of flywheel iteration properties
	FlywheelIterationPropertiesList []types.FlywheelIterationProperties

	// Next token
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFlywheelIterationHistoryPaginator 

type ListFlywheelIterationHistoryPaginator struct {
	// contains filtered or unexported fields
}

ListFlywheelIterationHistoryPaginator is a paginator for ListFlywheelIterationHistory

func NewListFlywheelIterationHistoryPaginator 

func NewListFlywheelIterationHistoryPaginator(client ListFlywheelIterationHistoryAPIClient, params *ListFlywheelIterationHistoryInput, optFns ...func(*ListFlywheelIterationHistoryPaginatorOptions)) *ListFlywheelIterationHistoryPaginator

NewListFlywheelIterationHistoryPaginator returns a new ListFlywheelIterationHistoryPaginator

func (*ListFlywheelIterationHistoryPaginator) HasMorePages 

func (p *ListFlywheelIterationHistoryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFlywheelIterationHistoryPaginator) NextPage 

func (p *ListFlywheelIterationHistoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFlywheelIterationHistoryOutput, error)

NextPage retrieves the next ListFlywheelIterationHistory page.

type ListFlywheelIterationHistoryPaginatorOptions 

type ListFlywheelIterationHistoryPaginatorOptions struct {
	// Maximum number of iteration history results to return
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFlywheelIterationHistoryPaginatorOptions is the paginator options for ListFlywheelIterationHistory

type ListFlywheelsAPIClient 

type ListFlywheelsAPIClient interface {
	ListFlywheels(context.Context, *ListFlywheelsInput, ...func(*Options)) (*ListFlywheelsOutput, error)
}

ListFlywheelsAPIClient is a client that implements the ListFlywheels operation.

type ListFlywheelsInput 

type ListFlywheelsInput struct {

	// 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 *types.FlywheelFilter

	// Maximum number of results to return in a response. The default is 100.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFlywheelsOutput 

type ListFlywheelsOutput struct {

	// A list of flywheel properties retrieved by the service in response to the
	// request.
	FlywheelSummaryList []types.FlywheelSummary

	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFlywheelsPaginator 

type ListFlywheelsPaginator struct {
	// contains filtered or unexported fields
}

ListFlywheelsPaginator is a paginator for ListFlywheels

func NewListFlywheelsPaginator 

func NewListFlywheelsPaginator(client ListFlywheelsAPIClient, params *ListFlywheelsInput, optFns ...func(*ListFlywheelsPaginatorOptions)) *ListFlywheelsPaginator

NewListFlywheelsPaginator returns a new ListFlywheelsPaginator

func (*ListFlywheelsPaginator) HasMorePages 

func (p *ListFlywheelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFlywheelsPaginator) NextPage 

func (p *ListFlywheelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFlywheelsOutput, error)

NextPage retrieves the next ListFlywheels page.

type ListFlywheelsPaginatorOptions 

type ListFlywheelsPaginatorOptions struct {
	// Maximum number of results to return in a response. The default is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFlywheelsPaginatorOptions is the paginator options for ListFlywheels

type ListKeyPhrasesDetectionJobsAPIClient 

type ListKeyPhrasesDetectionJobsAPIClient interface {
	ListKeyPhrasesDetectionJobs(context.Context, *ListKeyPhrasesDetectionJobsInput, ...func(*Options)) (*ListKeyPhrasesDetectionJobsOutput, error)
}

ListKeyPhrasesDetectionJobsAPIClient is a client that implements the ListKeyPhrasesDetectionJobs operation.

type ListKeyPhrasesDetectionJobsInput 

type ListKeyPhrasesDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter at a
	// time.
	Filter *types.KeyPhrasesDetectionJobFilter

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListKeyPhrasesDetectionJobsOutput 

type ListKeyPhrasesDetectionJobsOutput struct {

	// A list containing the properties of each job that is returned.
	KeyPhrasesDetectionJobPropertiesList []types.KeyPhrasesDetectionJobProperties

	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListKeyPhrasesDetectionJobsPaginator 

type ListKeyPhrasesDetectionJobsPaginator struct {
	// contains filtered or unexported fields
}

ListKeyPhrasesDetectionJobsPaginator is a paginator for ListKeyPhrasesDetectionJobs

func NewListKeyPhrasesDetectionJobsPaginator 

func NewListKeyPhrasesDetectionJobsPaginator(client ListKeyPhrasesDetectionJobsAPIClient, params *ListKeyPhrasesDetectionJobsInput, optFns ...func(*ListKeyPhrasesDetectionJobsPaginatorOptions)) *ListKeyPhrasesDetectionJobsPaginator

NewListKeyPhrasesDetectionJobsPaginator returns a new ListKeyPhrasesDetectionJobsPaginator

func (*ListKeyPhrasesDetectionJobsPaginator) HasMorePages 

func (p *ListKeyPhrasesDetectionJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListKeyPhrasesDetectionJobsPaginator) NextPage 

func (p *ListKeyPhrasesDetectionJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListKeyPhrasesDetectionJobsOutput, error)

NextPage retrieves the next ListKeyPhrasesDetectionJobs page.

type ListKeyPhrasesDetectionJobsPaginatorOptions 

type ListKeyPhrasesDetectionJobsPaginatorOptions struct {
	// The maximum number of results to return in each page. The default is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListKeyPhrasesDetectionJobsPaginatorOptions is the paginator options for ListKeyPhrasesDetectionJobs

type ListPiiEntitiesDetectionJobsAPIClient 

type ListPiiEntitiesDetectionJobsAPIClient interface {
	ListPiiEntitiesDetectionJobs(context.Context, *ListPiiEntitiesDetectionJobsInput, ...func(*Options)) (*ListPiiEntitiesDetectionJobsOutput, error)
}

ListPiiEntitiesDetectionJobsAPIClient is a client that implements the ListPiiEntitiesDetectionJobs operation.

type ListPiiEntitiesDetectionJobsInput 

type ListPiiEntitiesDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter at a
	// time.
	Filter *types.PiiEntitiesDetectionJobFilter

	// The maximum number of results to return in each page.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPiiEntitiesDetectionJobsOutput 

type ListPiiEntitiesDetectionJobsOutput struct {

	// Identifies the next page of results to return.
	NextToken *string

	// A list containing the properties of each job that is returned.
	PiiEntitiesDetectionJobPropertiesList []types.PiiEntitiesDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPiiEntitiesDetectionJobsPaginator 

type ListPiiEntitiesDetectionJobsPaginator struct {
	// contains filtered or unexported fields
}

ListPiiEntitiesDetectionJobsPaginator is a paginator for ListPiiEntitiesDetectionJobs

func NewListPiiEntitiesDetectionJobsPaginator 

func NewListPiiEntitiesDetectionJobsPaginator(client ListPiiEntitiesDetectionJobsAPIClient, params *ListPiiEntitiesDetectionJobsInput, optFns ...func(*ListPiiEntitiesDetectionJobsPaginatorOptions)) *ListPiiEntitiesDetectionJobsPaginator

NewListPiiEntitiesDetectionJobsPaginator returns a new ListPiiEntitiesDetectionJobsPaginator

func (*ListPiiEntitiesDetectionJobsPaginator) HasMorePages 

func (p *ListPiiEntitiesDetectionJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPiiEntitiesDetectionJobsPaginator) NextPage 

func (p *ListPiiEntitiesDetectionJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPiiEntitiesDetectionJobsOutput, error)

NextPage retrieves the next ListPiiEntitiesDetectionJobs page.

type ListPiiEntitiesDetectionJobsPaginatorOptions 

type ListPiiEntitiesDetectionJobsPaginatorOptions struct {
	// The maximum number of results to return in each page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPiiEntitiesDetectionJobsPaginatorOptions is the paginator options for ListPiiEntitiesDetectionJobs

type ListSentimentDetectionJobsAPIClient 

type ListSentimentDetectionJobsAPIClient interface {
	ListSentimentDetectionJobs(context.Context, *ListSentimentDetectionJobsInput, ...func(*Options)) (*ListSentimentDetectionJobsOutput, error)
}

ListSentimentDetectionJobsAPIClient is a client that implements the ListSentimentDetectionJobs operation.

type ListSentimentDetectionJobsInput 

type ListSentimentDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter at a
	// time.
	Filter *types.SentimentDetectionJobFilter

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSentimentDetectionJobsOutput 

type ListSentimentDetectionJobsOutput struct {

	// Identifies the next page of results to return.
	NextToken *string

	// A list containing the properties of each job that is returned.
	SentimentDetectionJobPropertiesList []types.SentimentDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSentimentDetectionJobsPaginator 

type ListSentimentDetectionJobsPaginator struct {
	// contains filtered or unexported fields
}

ListSentimentDetectionJobsPaginator is a paginator for ListSentimentDetectionJobs

func NewListSentimentDetectionJobsPaginator 

func NewListSentimentDetectionJobsPaginator(client ListSentimentDetectionJobsAPIClient, params *ListSentimentDetectionJobsInput, optFns ...func(*ListSentimentDetectionJobsPaginatorOptions)) *ListSentimentDetectionJobsPaginator

NewListSentimentDetectionJobsPaginator returns a new ListSentimentDetectionJobsPaginator

func (*ListSentimentDetectionJobsPaginator) HasMorePages 

func (p *ListSentimentDetectionJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSentimentDetectionJobsPaginator) NextPage 

func (p *ListSentimentDetectionJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSentimentDetectionJobsOutput, error)

NextPage retrieves the next ListSentimentDetectionJobs page.

type ListSentimentDetectionJobsPaginatorOptions 

type ListSentimentDetectionJobsPaginatorOptions struct {
	// The maximum number of results to return in each page. The default is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSentimentDetectionJobsPaginatorOptions is the paginator options for ListSentimentDetectionJobs

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are
	// querying.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are
	// querying.
	ResourceArn *string

	// Tags associated with the Amazon Comprehend resource being queried. A tag is a
	// key-value pair that adds as a metadata to a resource used by Amazon Comprehend.
	// For example, a tag with "Sales" as the key might be added to a resource to
	// indicate its use by the sales department.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTargetedSentimentDetectionJobsAPIClient 

type ListTargetedSentimentDetectionJobsAPIClient interface {
	ListTargetedSentimentDetectionJobs(context.Context, *ListTargetedSentimentDetectionJobsInput, ...func(*Options)) (*ListTargetedSentimentDetectionJobsOutput, error)
}

ListTargetedSentimentDetectionJobsAPIClient is a client that implements the ListTargetedSentimentDetectionJobs operation.

type ListTargetedSentimentDetectionJobsInput 

type ListTargetedSentimentDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter at a
	// time.
	Filter *types.TargetedSentimentDetectionJobFilter

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTargetedSentimentDetectionJobsOutput 

type ListTargetedSentimentDetectionJobsOutput struct {

	// Identifies the next page of results to return.
	NextToken *string

	// A list containing the properties of each job that is returned.
	TargetedSentimentDetectionJobPropertiesList []types.TargetedSentimentDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTargetedSentimentDetectionJobsPaginator 

type ListTargetedSentimentDetectionJobsPaginator struct {
	// contains filtered or unexported fields
}

ListTargetedSentimentDetectionJobsPaginator is a paginator for ListTargetedSentimentDetectionJobs

func NewListTargetedSentimentDetectionJobsPaginator 

func NewListTargetedSentimentDetectionJobsPaginator(client ListTargetedSentimentDetectionJobsAPIClient, params *ListTargetedSentimentDetectionJobsInput, optFns ...func(*ListTargetedSentimentDetectionJobsPaginatorOptions)) *ListTargetedSentimentDetectionJobsPaginator

NewListTargetedSentimentDetectionJobsPaginator returns a new ListTargetedSentimentDetectionJobsPaginator

func (*ListTargetedSentimentDetectionJobsPaginator) HasMorePages 

func (p *ListTargetedSentimentDetectionJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTargetedSentimentDetectionJobsPaginator) NextPage 

func (p *ListTargetedSentimentDetectionJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTargetedSentimentDetectionJobsOutput, error)

NextPage retrieves the next ListTargetedSentimentDetectionJobs page.

type ListTargetedSentimentDetectionJobsPaginatorOptions 

type ListTargetedSentimentDetectionJobsPaginatorOptions struct {
	// The maximum number of results to return in each page. The default is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTargetedSentimentDetectionJobsPaginatorOptions is the paginator options for ListTargetedSentimentDetectionJobs

type ListTopicsDetectionJobsAPIClient 

type ListTopicsDetectionJobsAPIClient interface {
	ListTopicsDetectionJobs(context.Context, *ListTopicsDetectionJobsInput, ...func(*Options)) (*ListTopicsDetectionJobsOutput, error)
}

ListTopicsDetectionJobsAPIClient is a client that implements the ListTopicsDetectionJobs operation.

type ListTopicsDetectionJobsInput 

type ListTopicsDetectionJobsInput struct {

	// Filters the jobs that are returned. Jobs can be filtered on their name, status,
	// or the date and time that they were submitted. You can set only one filter at a
	// time.
	Filter *types.TopicsDetectionJobFilter

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32

	// Identifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTopicsDetectionJobsOutput 

type ListTopicsDetectionJobsOutput struct {

	// Identifies the next page of results to return.
	NextToken *string

	// A list containing the properties of each job that is returned.
	TopicsDetectionJobPropertiesList []types.TopicsDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTopicsDetectionJobsPaginator 

type ListTopicsDetectionJobsPaginator struct {
	// contains filtered or unexported fields
}

ListTopicsDetectionJobsPaginator is a paginator for ListTopicsDetectionJobs

func NewListTopicsDetectionJobsPaginator 

func NewListTopicsDetectionJobsPaginator(client ListTopicsDetectionJobsAPIClient, params *ListTopicsDetectionJobsInput, optFns ...func(*ListTopicsDetectionJobsPaginatorOptions)) *ListTopicsDetectionJobsPaginator

NewListTopicsDetectionJobsPaginator returns a new ListTopicsDetectionJobsPaginator

func (*ListTopicsDetectionJobsPaginator) HasMorePages 

func (p *ListTopicsDetectionJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTopicsDetectionJobsPaginator) NextPage 

func (p *ListTopicsDetectionJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTopicsDetectionJobsOutput, error)

NextPage retrieves the next ListTopicsDetectionJobs page.

type ListTopicsDetectionJobsPaginatorOptions 

type ListTopicsDetectionJobsPaginatorOptions struct {
	// The maximum number of results to return in each page. The default is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTopicsDetectionJobsPaginatorOptions is the paginator options for ListTopicsDetectionJobs

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutResourcePolicyInput 

type PutResourcePolicyInput struct {

	// The Amazon Resource Name (ARN) of the custom model to attach the policy to.
	//
	// This member is required.
	ResourceArn *string

	// The JSON resource-based policy to attach to your custom model. Provide your
	// JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for
	// your policy, enclose the attribute names and values in double quotes. If the
	// JSON body is also enclosed in double quotes, then you must escape the double
	// quotes that are inside the policy:
	//
	//     "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
	//
	// To avoid escaping quotes, you can use single quotes to enclose the policy and
	// double quotes to enclose the JSON names and values:
	//
	//     '{"attribute": "value", "attribute": ["value"]}'
	//
	// This member is required.
	ResourcePolicy *string

	// The revision ID that Amazon Comprehend assigned to the policy that you are
	// updating. If you are creating a new policy that has no prior version, don't use
	// this parameter. Amazon Comprehend creates the revision ID for you.
	PolicyRevisionId *string
	// contains filtered or unexported fields
}

type PutResourcePolicyOutput 

type PutResourcePolicyOutput struct {

	// The revision ID of the policy. Each time you modify a policy, Amazon Comprehend
	// assigns a new revision ID, and it deletes the prior version of the policy.
	PolicyRevisionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartDocumentClassificationJobInput 

type StartDocumentClassificationJobInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	//
	// This member is required.
	DataAccessRoleArn *string

	// Specifies the format and location of the input data for the job.
	//
	// This member is required.
	InputDataConfig *types.InputDataConfig

	// Specifies where to send the output files.
	//
	// This member is required.
	OutputDataConfig *types.OutputDataConfig

	// A unique identifier for the request. If you do not set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string

	// The Amazon Resource Name (ARN) of the document classifier to use to process the
	// job.
	DocumentClassifierArn *string

	// The Amazon Resource Number (ARN) of the flywheel associated with the model to
	// use.
	FlywheelArn *string

	// The identifier of the job.
	JobName *string

	// 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 []types.Tag

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML compute
	// instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
	// the following formats:
	//
	//   - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//   - Amazon Resource Name (ARN) of a KMS Key:
	//   "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your document classification job. For
	// more information, see [Amazon VPC].
	//
	// [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type StartDocumentClassificationJobOutput 

type StartDocumentClassificationJobOutput struct {

	// The ARN of the custom classification model.
	DocumentClassifierArn *string

	// The Amazon Resource Name (ARN) of the document classification job. It is a
	// unique, fully qualified identifier for the job. It includes the Amazon Web
	// Services account, Amazon Web Services Region, and the job ID. The format of the
	// ARN is as follows:
	//
	//     arn::comprehend:::document-classification-job/
	//
	// The following is an example job ARN:
	//
	//     arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier generated for the job. To get the status of the job, use this
	// identifier with the DescribeDocumentClassificationJob operation.
	JobId *string

	// The status of the job:
	//
	//   - SUBMITTED - The job has been received and queued for processing.
	//
	//   - IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//   - COMPLETED - The job was successfully completed and the output is available.
	//
	//   - FAILED - The job did not complete. For details, use the
	//   DescribeDocumentClassificationJob operation.
	//
	//   - STOP_REQUESTED - Amazon Comprehend has received a stop request for the job
	//   and is processing the request.
	//
	//   - STOPPED - The job was successfully stopped without completing.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartDominantLanguageDetectionJobInput 

type StartDominantLanguageDetectionJobInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data. For more information, see [Role-based permissions].
	//
	// [Role-based permissions]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
	//
	// This member is required.
	DataAccessRoleArn *string

	// Specifies the format and location of the input data for the job.
	//
	// This member is required.
	InputDataConfig *types.InputDataConfig

	// Specifies where to send the output files.
	//
	// This member is required.
	OutputDataConfig *types.OutputDataConfig

	// A unique identifier for the request. If you do not set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string

	// An identifier for the job.
	JobName *string

	// 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.
	Tags []types.Tag

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML compute
	// instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
	// the following formats:
	//
	//   - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//   - Amazon Resource Name (ARN) of a KMS Key:
	//   "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your dominant language detection job.
	// For more information, see [Amazon VPC].
	//
	// [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type StartDominantLanguageDetectionJobOutput 

type StartDominantLanguageDetectionJobOutput struct {

	// The Amazon Resource Name (ARN) of the dominant language detection job. It is a
	// unique, fully qualified identifier for the job. It includes the Amazon Web
	// Services account, Amazon Web Services Region, and the job ID. The format of the
	// ARN is as follows:
	//
	//     arn::comprehend:::dominant-language-detection-job/
	//
	// The following is an example job ARN:
	//
	//     arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the operation.
	JobId *string

	// The status of the job.
	//
	//   - SUBMITTED - The job has been received and is queued for processing.
	//
	//   - IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//   - COMPLETED - The job was successfully completed and the output is available.
	//
	//   - FAILED - The job did not complete. To get details, use the operation.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartEntitiesDetectionJobInput 

type StartEntitiesDetectionJobInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data. For more information, see [Role-based permissions].
	//
	// [Role-based permissions]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
	//
	// This member is required.
	DataAccessRoleArn *string

	// Specifies the format and location of the input data for the job.
	//
	// This member is required.
	InputDataConfig *types.InputDataConfig

	// The language of the input documents. All documents must be in the same
	// language. You can specify any of the languages supported by Amazon Comprehend.
	// If custom entities recognition is used, this parameter is ignored and the
	// language used for training the model is used instead.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// Specifies where to send the output files.
	//
	// This member is required.
	OutputDataConfig *types.OutputDataConfig

	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string

	// The Amazon Resource Name (ARN) that identifies the specific entity recognizer
	// to be used by the StartEntitiesDetectionJob . This ARN is optional and is only
	// used for a custom entity recognition job.
	EntityRecognizerArn *string

	// The Amazon Resource Number (ARN) of the flywheel associated with the model to
	// use.
	FlywheelArn *string

	// The identifier of the job.
	JobName *string

	// 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 []types.Tag

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML compute
	// instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
	// the following formats:
	//
	//   - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//   - Amazon Resource Name (ARN) of a KMS Key:
	//   "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your entity detection job. For more
	// information, see [Amazon VPC].
	//
	// [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type StartEntitiesDetectionJobOutput 

type StartEntitiesDetectionJobOutput struct {

	// The ARN of the custom entity recognition model.
	EntityRecognizerArn *string

	// The Amazon Resource Name (ARN) of the entities detection job. It is a unique,
	// fully qualified identifier for the job. It includes the Amazon Web Services
	// account, Amazon Web Services Region, and the job ID. The format of the ARN is as
	// follows:
	//
	//     arn::comprehend:::entities-detection-job/
	//
	// The following is an example job ARN:
	//
	//     arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier generated for the job. To get the status of job, use this
	// identifier with the operation.
	JobId *string

	// The status of the job.
	//
	//   - SUBMITTED - The job has been received and is queued for processing.
	//
	//   - IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//   - COMPLETED - The job was successfully completed and the output is available.
	//
	//   - FAILED - The job did not complete. To get details, use the operation.
	//
	//   - STOP_REQUESTED - Amazon Comprehend has received a stop request for the job
	//   and is processing the request.
	//
	//   - STOPPED - The job was successfully stopped without completing.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartEventsDetectionJobInput 

type StartEventsDetectionJobInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	//
	// This member is required.
	DataAccessRoleArn *string

	// Specifies the format and location of the input data for the job.
	//
	// This member is required.
	InputDataConfig *types.InputDataConfig

	// The language code of the input documents.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// Specifies where to send the output files.
	//
	// This member is required.
	OutputDataConfig *types.OutputDataConfig

	// The types of events to detect in the input documents.
	//
	// This member is required.
	TargetEventTypes []string

	// An unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string

	// The identifier of the events detection job.
	JobName *string

	// 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.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type StartEventsDetectionJobOutput 

type StartEventsDetectionJobOutput struct {

	// The Amazon Resource Name (ARN) of the events detection job. It is a unique,
	// fully qualified identifier for the job. It includes the Amazon Web Services
	// account, Amazon Web Services Region, and the job ID. The format of the ARN is as
	// follows:
	//
	//     arn::comprehend:::events-detection-job/
	//
	// The following is an example job ARN:
	//
	//     arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// An unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	JobId *string

	// The status of the events detection job.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartFlywheelIterationInput 

type StartFlywheelIterationInput struct {

	// The ARN of the flywheel.
	//
	// This member is required.
	FlywheelArn *string

	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string
	// contains filtered or unexported fields
}

type StartFlywheelIterationOutput 

type StartFlywheelIterationOutput struct {

	//
	FlywheelArn *string

	//
	FlywheelIterationId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartKeyPhrasesDetectionJobInput 

type StartKeyPhrasesDetectionJobInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data. For more information, see [Role-based permissions].
	//
	// [Role-based permissions]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
	//
	// This member is required.
	DataAccessRoleArn *string

	// Specifies the format and location of the input data for the job.
	//
	// This member is required.
	InputDataConfig *types.InputDataConfig

	// The language of the input documents. You can specify any of the primary
	// languages supported by Amazon Comprehend. All documents must be in the same
	// language.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// Specifies where to send the output files.
	//
	// This member is required.
	OutputDataConfig *types.OutputDataConfig

	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string

	// The identifier of the job.
	JobName *string

	// 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.
	Tags []types.Tag

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML compute
	// instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
	// the following formats:
	//
	//   - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//   - Amazon Resource Name (ARN) of a KMS Key:
	//   "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	//  Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your key phrases detection job. For
	// more information, see [Amazon VPC].
	//
	// [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type StartKeyPhrasesDetectionJobOutput 

type StartKeyPhrasesDetectionJobOutput struct {

	// The Amazon Resource Name (ARN) of the key phrase detection job. It is a unique,
	// fully qualified identifier for the job. It includes the Amazon Web Services
	// account, Amazon Web Services Region, and the job ID. The format of the ARN is as
	// follows:
	//
	//     arn::comprehend:::key-phrases-detection-job/
	//
	// The following is an example job ARN:
	//
	//     arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the operation.
	JobId *string

	// The status of the job.
	//
	//   - SUBMITTED - The job has been received and is queued for processing.
	//
	//   - IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//   - COMPLETED - The job was successfully completed and the output is available.
	//
	//   - FAILED - The job did not complete. To get details, use the operation.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartPiiEntitiesDetectionJobInput 

type StartPiiEntitiesDetectionJobInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	//
	// This member is required.
	DataAccessRoleArn *string

	// The input properties for a PII entities detection job.
	//
	// This member is required.
	InputDataConfig *types.InputDataConfig

	// The language of the input documents. Enter the language code for English (en)
	// or Spanish (es).
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// Specifies whether the output provides the locations (offsets) of PII entities
	// or a file in which PII entities are redacted.
	//
	// This member is required.
	Mode types.PiiEntitiesDetectionMode

	// Provides configuration parameters for the output of PII entity detection jobs.
	//
	// This member is required.
	OutputDataConfig *types.OutputDataConfig

	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string

	// The identifier of the job.
	JobName *string

	// Provides configuration parameters for PII entity redaction.
	//
	// This parameter is required if you set the Mode parameter to ONLY_REDACTION . In
	// that case, you must provide a RedactionConfig definition that includes the
	// PiiEntityTypes parameter.
	RedactionConfig *types.RedactionConfig

	// 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.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type StartPiiEntitiesDetectionJobOutput 

type StartPiiEntitiesDetectionJobOutput struct {

	// The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique,
	// fully qualified identifier for the job. It includes the Amazon Web Services
	// account, Amazon Web Services Region, and the job ID. The format of the ARN is as
	// follows:
	//
	//     arn::comprehend:::pii-entities-detection-job/
	//
	// The following is an example job ARN:
	//
	//     arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier generated for the job.
	JobId *string

	// The status of the job.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartSentimentDetectionJobInput 

type StartSentimentDetectionJobInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data. For more information, see [Role-based permissions].
	//
	// [Role-based permissions]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
	//
	// This member is required.
	DataAccessRoleArn *string

	// Specifies the format and location of the input data for the job.
	//
	// This member is required.
	InputDataConfig *types.InputDataConfig

	// The language of the input documents. You can specify any of the primary
	// languages supported by Amazon Comprehend. All documents must be in the same
	// language.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// Specifies where to send the output files.
	//
	// This member is required.
	OutputDataConfig *types.OutputDataConfig

	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string

	// The identifier of the job.
	JobName *string

	// 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.
	Tags []types.Tag

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML compute
	// instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
	// the following formats:
	//
	//   - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//   - Amazon Resource Name (ARN) of a KMS Key:
	//   "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your sentiment detection job. For
	// more information, see [Amazon VPC].
	//
	// [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type StartSentimentDetectionJobOutput 

type StartSentimentDetectionJobOutput struct {

	// The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique,
	// fully qualified identifier for the job. It includes the Amazon Web Services
	// account, Amazon Web Services Region, and the job ID. The format of the ARN is as
	// follows:
	//
	//     arn::comprehend:::sentiment-detection-job/
	//
	// The following is an example job ARN:
	//
	//     arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the operation.
	JobId *string

	// The status of the job.
	//
	//   - SUBMITTED - The job has been received and is queued for processing.
	//
	//   - IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//   - COMPLETED - The job was successfully completed and the output is available.
	//
	//   - FAILED - The job did not complete. To get details, use the operation.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartTargetedSentimentDetectionJobInput 

type StartTargetedSentimentDetectionJobInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data. For more information, see [Role-based permissions].
	//
	// [Role-based permissions]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
	//
	// This member is required.
	DataAccessRoleArn *string

	// The input properties for an inference job. The document reader config field
	// applies only to non-text inputs for custom analysis.
	//
	// This member is required.
	InputDataConfig *types.InputDataConfig

	// The language of the input documents. Currently, English is the only supported
	// language.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// Specifies where to send the output files.
	//
	// This member is required.
	OutputDataConfig *types.OutputDataConfig

	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string

	// The identifier of the job.
	JobName *string

	// 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.
	Tags []types.Tag

	// ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage
	// volume attached to the ML compute instance(s) that process the analysis job. The
	// VolumeKmsKeyId can be either of the following formats:
	//
	//   - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//   - Amazon Resource Name (ARN) of a KMS Key:
	//   "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	//  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].
	//
	// [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type StartTargetedSentimentDetectionJobOutput 

type StartTargetedSentimentDetectionJobOutput struct {

	// The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a
	// unique, fully qualified identifier for the job. It includes the Amazon Web
	// Services account, Amazon Web Services Region, and the job ID. The format of the
	// ARN is as follows:
	//
	//     arn::comprehend:::targeted-sentiment-detection-job/
	//
	// The following is an example job ARN:
	//
	//     arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the DescribeTargetedSentimentDetectionJob operation.
	JobId *string

	// The status of the job.
	//
	//   - SUBMITTED - The job has been received and is queued for processing.
	//
	//   - IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//   - COMPLETED - The job was successfully completed and the output is available.
	//
	//   - FAILED - The job did not complete. To get details, use the
	//   DescribeTargetedSentimentDetectionJob operation.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartTopicsDetectionJobInput 

type StartTopicsDetectionJobInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data. For more information, see [Role-based permissions].
	//
	// [Role-based permissions]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
	//
	// This member is required.
	DataAccessRoleArn *string

	// Specifies the format and location of the input data for the job.
	//
	// This member is required.
	InputDataConfig *types.InputDataConfig

	// Specifies where to send the output files. The output is a compressed archive
	// with two files, topic-terms.csv that lists the terms associated with each
	// topic, and doc-topics.csv that lists the documents associated with each topic
	//
	// This member is required.
	OutputDataConfig *types.OutputDataConfig

	// A unique identifier for the request. If you do not set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string

	// The identifier of the job.
	JobName *string

	// The number of topics to detect.
	NumberOfTopics *int32

	// 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.
	Tags []types.Tag

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML compute
	// instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
	// the following formats:
	//
	//   - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//   - Amazon Resource Name (ARN) of a KMS Key:
	//   "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your topic detection job. For more
	// information, see [Amazon VPC].
	//
	// [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type StartTopicsDetectionJobOutput 

type StartTopicsDetectionJobOutput struct {

	// The Amazon Resource Name (ARN) of the topics detection job. It is a unique,
	// fully qualified identifier for the job. It includes the Amazon Web Services
	// account, Amazon Web Services Region, and the job ID. The format of the ARN is as
	// follows:
	//
	//     arn::comprehend:::topics-detection-job/
	//
	// The following is an example job ARN:
	//
	//     arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier generated for the job. To get the status of the job, use this
	// identifier with the DescribeTopicDetectionJob operation.
	JobId *string

	// The status of the job:
	//
	//   - SUBMITTED - The job has been received and is queued for processing.
	//
	//   - IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//   - COMPLETED - The job was successfully completed and the output is available.
	//
	//   - FAILED - The job did not complete. To get details, use the
	//   DescribeTopicDetectionJob operation.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopDominantLanguageDetectionJobInput 

type StopDominantLanguageDetectionJobInput struct {

	// The identifier of the dominant language detection job to stop.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type StopDominantLanguageDetectionJobOutput 

type StopDominantLanguageDetectionJobOutput struct {

	// The identifier of the dominant language 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 StopDominantLanguageDetectionJob operation.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopEntitiesDetectionJobInput 

type StopEntitiesDetectionJobInput struct {

	// The identifier of the entities detection job to stop.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type StopEntitiesDetectionJobOutput 

type StopEntitiesDetectionJobOutput struct {

	// The identifier of the entities 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 StopEntitiesDetectionJob operation.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopEventsDetectionJobInput 

type StopEventsDetectionJobInput struct {

	// The identifier of the events detection job to stop.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type StopEventsDetectionJobOutput 

type StopEventsDetectionJobOutput struct {

	// The identifier of the events detection job to stop.
	JobId *string

	// The status of the events detection job.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopKeyPhrasesDetectionJobInput 

type StopKeyPhrasesDetectionJobInput struct {

	// The identifier of the key phrases detection job to stop.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type StopKeyPhrasesDetectionJobOutput 

type StopKeyPhrasesDetectionJobOutput struct {

	// The identifier of the key phrases 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 StopKeyPhrasesDetectionJob operation.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopPiiEntitiesDetectionJobInput 

type StopPiiEntitiesDetectionJobInput struct {

	// The identifier of the PII entities detection job to stop.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type StopPiiEntitiesDetectionJobOutput 

type StopPiiEntitiesDetectionJobOutput struct {

	// The identifier of the PII entities detection job to stop.
	JobId *string

	// The status of the PII entities detection job.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopSentimentDetectionJobInput 

type StopSentimentDetectionJobInput struct {

	// The identifier of the sentiment detection job to stop.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type StopSentimentDetectionJobOutput 

type StopSentimentDetectionJobOutput struct {

	// The identifier of the 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.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopTargetedSentimentDetectionJobInput 

type StopTargetedSentimentDetectionJobInput struct {

	// The identifier of the targeted sentiment detection job to stop.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type StopTargetedSentimentDetectionJobOutput 

type StopTargetedSentimentDetectionJobOutput struct {

	// 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.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopTrainingDocumentClassifierInput 

type StopTrainingDocumentClassifierInput struct {

	// The Amazon Resource Name (ARN) that identifies the document classifier
	// currently being trained.
	//
	// This member is required.
	DocumentClassifierArn *string
	// contains filtered or unexported fields
}

type StopTrainingDocumentClassifierOutput 

type StopTrainingDocumentClassifierOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopTrainingEntityRecognizerInput 

type StopTrainingEntityRecognizerInput struct {

	// The Amazon Resource Name (ARN) that identifies the entity recognizer currently
	// being trained.
	//
	// This member is required.
	EntityRecognizerArn *string
	// contains filtered or unexported fields
}

type StopTrainingEntityRecognizerOutput 

type StopTrainingEntityRecognizerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which
	// you want to associate the tags.
	//
	// This member is required.
	ResourceArn *string

	// 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.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	//  The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from
	// which you want to remove the tags.
	//
	// This member is required.
	ResourceArn *string

	// 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.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateEndpointInput 

type UpdateEndpointInput struct {

	// The Amazon Resource Number (ARN) of the endpoint being updated.
	//
	// This member is required.
	EndpointArn *string

	// Data access role ARN to use in case the new model is encrypted with a customer
	// CMK.
	DesiredDataAccessRoleArn *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 *int32

	// The ARN of the new model to use when updating an existing endpoint.
	DesiredModelArn *string

	// The Amazon Resource Number (ARN) of the flywheel
	FlywheelArn *string
	// contains filtered or unexported fields
}

type UpdateEndpointOutput 

type UpdateEndpointOutput struct {

	// The Amazon Resource Number (ARN) of the new model.
	DesiredModelArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateFlywheelInput 

type UpdateFlywheelInput struct {

	// The Amazon Resource Number (ARN) of the flywheel to update.
	//
	// This member is required.
	FlywheelArn *string

	// The Amazon Resource Number (ARN) of the active model version.
	ActiveModelArn *string

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// permission to access the flywheel data.
	DataAccessRoleArn *string

	// Flywheel data security configuration.
	DataSecurityConfig *types.UpdateDataSecurityConfig
	// contains filtered or unexported fields
}

type UpdateFlywheelOutput 

type UpdateFlywheelOutput struct {

	// The flywheel properties.
	FlywheelProperties *types.FlywheelProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.